setFSMVariable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(syntax, added example, added note)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Set variable to given value in the variable space of given FSM. The FSM handle is the number returned by the execFSM command. |= Description
| 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
____________________________________________________________________________________________
____________________________________________________________________________________________


| FSM handle '''setFSMVariable''' [name,value] |= Syntax
| handle '''setFSMVariable''' [name, value] |= Syntax


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


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


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


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


| [[Nothing]] |= RETURNVALUE


|x1= <code>(example)</code>|= EXAMPLE1  
 
|x1= <code>_handle = [[execFSM]] "test.fsm";
_handle [[setFSMVariable]] ["_foo", 23];
</code>
sets variable <tt>_foo</tt> in the FSM to 23|= EXAMPLE1  


____________________________________________________________________________________________
____________________________________________________________________________________________
Line 34: Line 40:
<dl class='command_description'>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
 
<dd class="notedate">Posted on March 23, 2014 - 00:53
<dt class="note">'''[[User:Master85|Master85]] ([[User talk:Master85|talk]])'''<dd class="note">If the variable is not yet defined within the FSM it will be created.
<!-- Note Section END -->
<!-- Note Section END -->
</dl>
</dl>

Revision as of 01:53, 23 March 2014

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