Identifier: Difference between revisions
Jump to navigation
Jump to search
m (replaced BIS tag with UNIQUETAG so ppl don't even think about using BIS_player) |
Lou Montana (talk | contribs) m (Text replacement - "[[OFPEC tags" to "[[Scripting Tags") |
||
| (11 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
An | __NOTOC__ | ||
An [[Identifier]] is the name given to a [[Variables|variable]] that the scripter can choose: It is the name that ''identifies'' the variable. | |||
== Rules == | == Rules == | ||
{| class=" | {| class="wikitable float-right" | ||
! Valid | |+ Regex: {{hl|[a-zA-Z_][a-zA-Z0-9_]*}} | ||
! Valid | |||
! Invalid | |||
|- | |- | ||
| | | | ||
| Line 10: | Line 12: | ||
* _my_local_variable | * _my_local_variable | ||
* _1variable | * _1variable | ||
* _player | |||
| | | | ||
* | * {{Color|red|1}}variable | ||
* _my | * _my{{Color|red|#}}localVar | ||
* _guy1 | * _guy1{{Color|red|&}}2var | ||
* {{Color|red|player}} | |||
|} | |} | ||
Binding rules for identifiers: | Binding rules for identifiers: | ||
* Identifiers may consist of any ASCII text characters (a-z, A-Z), numbers (0-9) and underscores (_) | * 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") | * Identifiers '''must not''' start with a number (e.g "9myVariable" is invalid). | ||
* Identifiers of [[Variables|local variables]] '''must''' start with an underscore | * Identifiers of [[Variables|local variables]] '''must''' start with an underscore. | ||
* Identifiers are '''case-insensitive'''. | |||
* Identifiers '''cannot be the same as reserved words''' (e.g [[:Category:Scripting Commands|commands]] and [[:Category:Functions|functions]]). | |||
== Recommendations == | == Recommendations == | ||
It is recommended to write ''' | 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> | ||
{{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> | |||
}} | |||
It is also recommended to prefix ''' | 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}} | |||
<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;