setFSMVariable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma2 |Game name=
| arma2


|1.00|Game version=
|1.00


|gr1= System |GROUP1=
|gr1= System


| Set variable to given value in the variable space of given FSM.
| Set variable to given value in the variable space of given FSM.
<br>The FSM handle is the number returned by the [[execFSM]] command. |DESCRIPTION=
<br>The FSM handle is the number returned by the [[execFSM]] command.


| handle '''setFSMVariable''' [name, value] |SYNTAX=
| handle '''setFSMVariable''' [name, value]


|p1= handle: [[Number]] - FSM handle |PARAMETER1=
|p1= handle: [[Number]] - FSM handle


|p2= [name,value]: [[Array]] |PARAMETER2=
|p2= [name,value]: [[Array]]


|p3= name: [[String]] - name of the FSM variable |PARAMETER3=
|p3= name: [[String]] - name of the FSM variable


|p4= value: [[Any Value]] - new value of the FSM variable|PARAMETER4=
|p4= value: [[Any Value]] - new value of the FSM variable


| [[Nothing]] |RETURNVALUE=
| [[Nothing]]




Line 26: Line 26:
_handle [[setFSMVariable]] ["_foo", 23];
_handle [[setFSMVariable]] ["_foo", 23];
</code>
</code>
sets variable <tt>_foo</tt> in the FSM to 23|EXAMPLE1=
sets variable <tt>_foo</tt> in the FSM to 23




| [[FSM]], [[commandFSM]], [[completedFSM]], [[doFSM]], [[execFSM]], [[getFSMVariable]] |SEEALSO=
| [[FSM]], [[commandFSM]], [[completedFSM]], [[doFSM]], [[execFSM]], [[getFSMVariable]]


| |MPBEHAVIOUR=
|
}}
}}



Revision as of 11:10, 18 January 2021

Hover & click on the images for description

Description

Description:
Set variable to given value in the variable space of given FSM.
The FSM handle is the number returned by the execFSM command.
Groups:
System

Syntax

Syntax:
handle setFSMVariable [name, value]
Parameters:
handle: Number - FSM handle
[name,value]: Array
name: String - name of the FSM variable
value: Any Value - new value of the FSM variable
Return Value:
Nothing

Examples

Example 1:
_handle = execFSM "test.fsm"; _handle setFSMVariable ["_foo", 23]; sets variable _foo in the FSM to 23

Additional Information

See also:
FSMcommandFSMcompletedFSMdoFSMexecFSMgetFSMVariable

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Notes

Posted on March 23, 2014 - 00:53
Master85 (talk)
If the variable is not yet defined within the FSM it will be created.

Bottom Section