Template:EffArg

From Bohemia Interactive Community
Jump to navigation Jump to search

Template EffArg short for Effects and Arguments.

Usage

Placing {{EffArg|com|eff|loc}} in a page will result in Effects of this scripting command are not broadcasted over the network and remain local to the client the command is executed on being rendered in it's place.

Parameters

The template accepts 4 params, the 4th of which is optional.

Call type

The first param must be the type of call; either function or command.

The text is parsed by the template so is capable of understanding many alternative inputs, hinted at in the examples below.

Data type

The second param must be the type of data; either effects or arguments.

The text is parsed by the template so is capable of understanding many alternative inputs, hinted at in the examples below.

Locality

The third param must be the locality; either local or global.

The text is parsed by the template so is capable of understanding many alternative inputs, hinted at in the examples below.

Categorize

The fourth param is optional and if included (e.g. {{EffArg|fnc|args|global|categorize}}), will place the page on which the this Template is used into the appropriate Category for the Call+Data; in this case Category:Functions utilizing global arguments.

Any value may be added as the third param, but for clarity and continuity, use something like cat, category or categorize so that future editors understand its purpose.

Examples

Any of the examples below can also include the third parameter, to place the page they're used on into the Category they link to.

{{EffArg|com|eff|loc}} makes Effects of this scripting command are not broadcasted over the network and remain local to the client the command is executed on


{{EffArg|cmd|effects|global}} makes Effects of this scripting command are broadcasted over the network and happen on every computer in the network


{{EffArg|command|arg|local}} makes Arguments of this scripting command have to be local to the client the command is executed on


{{EffArg|cmd|argument|glob}} makes Arguments of this scripting command don't have to be local to the client the command is executed on

{{EffArg|fnc|eff|loc}} makes Effects of this scripting function are not broadcasted over the network and remain local to the client the function is executed on


{{EffArg|func|eff|global}} makes Effects of this scripting function are broadcasted over the network and happen on every computer in the network


{{EffArg|function|arg|local}} makes Arguments of this scripting function have to be local to the client the function is executed on


{{EffArg|fnc|arguments|glob}} makes Arguments of this scripting function don't have to be local to the client the function is executed on