setFSMVariable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(syntax, added example, added note)
m (template:command argument fix)
Line 13: Line 13:
| handle '''setFSMVariable''' [name, value] |= Syntax
| handle '''setFSMVariable''' [name, value] |= Syntax


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


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


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


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


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




Line 27: Line 27:
_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|EXAMPLE1=  


____________________________________________________________________________________________
____________________________________________________________________________________________


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


|  |= MPBEHAVIOUR
|  |MPBEHAVIOUR=  
____________________________________________________________________________________________
____________________________________________________________________________________________
}}
}}

Revision as of 10:37, 7 April 2019

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:
Uncategorised

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