Identifier: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
Lou Montana (talk | contribs) (Page refresh) |
||
| Line 1: | Line 1: | ||
An '''identifier''' is a name given to a [[Variables|variable]] that the scripter can choose: It is the name that ''identifies'' the variable. | An '''identifier''' is a name given to a [[Variables|variable]] that the scripter can choose: It is the name that ''identifies'' the variable. | ||
== Rules == | == Rules == | ||
{| class="bikitable" style="float: right; margin-left: 1em" | |||
! Valid !! Invalid | |||
|- | |||
| | |||
* variable1 | |||
* _my_local_variable | |||
* _1variable | |||
| | |||
* <span style="color: red">1</span>variable | |||
* _my<span style="color: red">#</span>localVar | |||
* _guy1<span style="color: red">&</span>2var | |||
|} | |||
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 ( | * Identifiers '''must not''' start with a number (e.g "9myVariable") | ||
* Identifiers of [[Variables|local variables]] '''must''' start with an underscore | * Identifiers of [[Variables|local variables]] '''must''' start with an underscore | ||
== Recommendations == | == Recommendations == | ||
It is recommended to write identifiers in camel | It is recommended to write '''private variable identifiers''' in {{Wikipedia|Camel_case|camel case}} syntax. This makes identifiers more readable: | ||
<code>[[private]] _myVariableName = 5;</code> | |||
It is also recommended to prefix '''public variable identifiers''' with your [[OFPEC tags|tag]] in order to avoid any potential conflict between addons, scripts and missions: | |||
<code>{{cc|<span style{{=}}"color: purple; font-weight: bold">Tag</span>_identifier}} | |||
<span style="color: purple; font-weight: bold">BIS</span>_player = [[player]];</code> | |||
A less encountered naming format is separating all sub-words with underscores: | |||
<code>_my_variable_name = 5;</code> | |||
== See also == | == See also == | ||
* [[Variables]] | * [[Variables]] | ||
[[Category: Syntax]] | [[Category: Syntax]] | ||
Revision as of 00:31, 4 November 2019
An identifier is a 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")
- Identifiers of local variables must start with an underscore
Recommendations
It is recommended to write private variable identifiers in camel case syntax. This makes identifiers more readable:
private _myVariableName = 5;
It is also recommended to prefix public variable identifiers with your tag in order to avoid any potential conflict between addons, scripts and missions:
// Tag_identifier
BIS_player = player;
A less encountered naming format is separating all sub-words with underscores:
_my_variable_name = 5;