Difference between revisions of "Papyrus Naming Conventions"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Domius
imported>Google0011
(Updated URL)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
*Generally:
*Generally:
* a --> function argument
* a --> function argument
Line 9: Line 8:
* p --> pointer (carryover from internal code, inconsistency, should not be used)
* p --> pointer (carryover from internal code, inconsistency, should not be used)
* r --> reference (carryover from internal code, inconsistency, should not be used)
* r --> reference (carryover from internal code, inconsistency, should not be used)
Example:
Function MyFunction(int myNum, akActionRef)
ak = Function Argument Object.


SmkViper helped flesh out this list.
SmkViper helped flesh out this list.
Line 19: Line 22:
* ReferenceAlias properties always have the "Alias_" prefix.
* ReferenceAlias properties always have the "Alias_" prefix.


  ''source: http://afkmods.iguanadons.net/index.php?/topic/4417-papyrus-naming-conventions/''
  ''source: https://www.afkmods.com/index.php?/topic/4417-papyrus-naming-conventions/''
  ''There might be more in Fallout 4, these are from Skyrim''
  ''There might be more in Fallout 4, these are from Skyrim''


----
----
[[Category: Scripting]]
[[Category: Papyrus]]
[[Category: Papyrus_Language_Reference]]

Latest revision as of 13:51, 22 May 2019

  • Generally:
  • a --> function argument
  • k --> object
  • b --> boolean
  • i --> integer
  • f --> float
  • s --> string
  • p --> pointer (carryover from internal code, inconsistency, should not be used)
  • r --> reference (carryover from internal code, inconsistency, should not be used)

Example:

Function MyFunction(int myNum, akActionRef)
ak = Function Argument Object.

SmkViper helped flesh out this list. There doesn't appear to be any conformity to conventions with regard to local and script variables.

However:

  • Properties tend to be upper CamelCase.
  • Script variables tend to be upper CamelCase.
  • Local variables tend to be lower camelCase.
  • ReferenceAlias properties always have the "Alias_" prefix.
source: https://www.afkmods.com/index.php?/topic/4417-papyrus-naming-conventions/
There might be more in Fallout 4, these are from Skyrim