crpl:docs:define
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| crpl:docs:define [2013/01/14 18:46] – external edit 127.0.0.1 | crpl:docs:define [2025/02/14 14:57] (current) – external edit 127.0.0.1 | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | <- [[crpl: | ||
| ===== $VARNAME: | ===== $VARNAME: | ||
| - | ^Arguments^Result^Notation^ | + | ===== Syntax ===== |
| - | | | |'' | + | |
| + | $VAR:VAL | ||
| + | |||
| + | ===== Description ===== | ||
| + | |||
| + | Input variables must start with a $ sign and be placed before any of the actual code in a script. They define a variable named **VAR **with a default value of **VAL** which may be of type int, float or string. | ||
| + | |||
| + | Input variables will show up in a unit's Script Settings when selected in the editor, this allows the editor to place the unit with a different value than the default specified in the script itself, but also allows the the value to be changed at any moment in time. | ||
| + | |||
| + | Input variables are created at the same time as the unit itself (even if the game is paused and the script hasn't executed once) and assigned either the default value **VAL** (which may be overwritten if the initParams of a CreateUnit call specify it), or a value specified in the editor through the Script Settings. | ||
| - | === Description === | ||
| - | Defines an input variable. Input variables are created at script start | ||
| - | and assigned either the default value, or a value specified in the editor. | ||
| === Examples === | === Examples === | ||
| - | < | + | |
| + | Commands used in example: | ||
| + | * [[crpl: | ||
| + | * [[crpl: | ||
| + | * [[crpl: | ||
| + | < | ||
| $amtToEmit: | $amtToEmit: | ||
| $interval: | $interval: | ||
| - | CurrentCoords < | + | CurrentCoords < |
| - | SetCreeper < | + | < |
| - | Delay | + | |
| </ | </ | ||
| - | |||
| - | |||
crpl/docs/define.1358189211.txt.gz · Last modified: 2025/02/14 14:56 (external edit)
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
