Identifier: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Some wiki formatting) |
Lou Montana (talk | contribs) m (Text replacement - "[[OFPEC tags" to "[[Scripting Tags") |
||
| (One intermediate revision by the same user not shown) | |||
| Line 29: | Line 29: | ||
== Recommendations == | == Recommendations == | ||
It is recommended to write '''local variable identifiers''' in {{ | It is recommended to write '''local variable identifiers''' in {{Link|https://en.wikipedia.org/wiki/Camel_case|camel case}} syntax. This makes identifiers more readable: | ||
<sqf>private _myVariableName = 5;</sqf> | <sqf>private _myVariableName = 5;</sqf> | ||
{{Feature|important| | {{Feature|important| | ||
{{ | {{Link|https://en.wikipedia.org/wiki/Snake_case}} is sometimes encountered but is not recommended and should be avoided: | ||
<sqf>_my_variable_name = 5;</sqf> | <sqf>_my_variable_name = 5;</sqf> | ||
}} | }} | ||
It is also recommended to prefix '''global variable identifiers''' with '''your''' [[ | It is also recommended to prefix '''global variable identifiers''' with '''your''' [[Scripting Tags|tag]] in order to avoid any potential conflict between addons, scripts and missions: | ||
{{cc|'''{{Color|purple|Tag}}'''_identifier}} | {{cc|'''{{Color|purple|Tag}}'''_identifier}} | ||
<span style="color: purple; font-weight: bold">UNIQUETAG</span>_player = [[player]]; | <span style="color: purple; font-weight: bold">UNIQUETAG</span>_player = [[player]]; | ||
Latest revision as of 12:01, 2 October 2024
An Identifier is the name given to a variable that the scripter can choose: It is the name that identifies the variable.
Rules
| Valid | Invalid |
|---|---|
|
|
Binding rules for identifiers:
- Identifiers may consist of any ASCII text characters (a-z, A-Z), numbers (0-9) and underscores (_).
- Identifiers must not start with a number (e.g "9myVariable" is invalid).
- Identifiers of local variables must start with an underscore.
- Identifiers are case-insensitive.
- Identifiers cannot be the same as reserved words (e.g commands and functions).
Recommendations
It is recommended to write local variable identifiers in camel case syntax. This makes identifiers more readable:
It is also recommended to prefix global variable identifiers with your tag in order to avoid any potential conflict between addons, scripts and missions:
// Tag_identifier UNIQUETAG_player = player;