setFSMVariable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|seealso= *\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2")
m (Some wiki formatting)
 
(5 intermediate revisions by the same user not shown)
Line 15: Line 15:
|gr1= System
|gr1= System


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


|s1= handle [[setFSMVariable]] [name, value]
|s1= handle [[setFSMVariable]] [name, value]
Line 22: Line 22:
|p1= handle: [[Number]] - FSM handle
|p1= handle: [[Number]] - FSM handle


|p2= [name,value]: [[Array]]
|p2= name: [[String]] - name of the FSM variable


|p3= name: [[String]] - name of the FSM variable
|p3= value: [[Anything]] - new value of the FSM variable
 
|p4= value: [[Anything]] - new value of the FSM variable


|r1= [[Nothing]]
|r1= [[Nothing]]


|x1= <code>_handle = [[execFSM]] "test.fsm";
|x1= <sqf>
_handle [[setFSMVariable]] ["_foo", 23];
_handle = execFSM "test.fsm";
</code>
_handle setFSMVariable ["_foo", 23]; // sets variable _foo in the FSM to 23
sets variable {{hl|_foo}} in the FSM to 23
</sqf>


|seealso= [[FSM]] [[commandFSM]] [[completedFSM]] [[doFSM]], [[execFSM]], [[getFSMVariable]]
|seealso= [[FSM]] [[commandFSM]] [[completedFSM]] [[doFSM]] [[execFSM]] [[getFSMVariable]]
}}
}}


<dl class="command_description">
{{Note
 
|user= Master85
<dt></dt>
|timestamp= 20140323005300
<dd class="notedate">Posted on March 23, 2014 - 00:53</dd>
|text= If the variable is not yet defined within the FSM it will be created.
<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.
}}
</dl>

Latest revision as of 17:49, 15 August 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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: String - name of the FSM variable
value: Anything - 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:
FSM commandFSM completedFSM doFSM execFSM getFSMVariable

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
Master85 - c
Posted on Mar 23, 2014 - 00:53 (UTC)
If the variable is not yet defined within the FSM it will be created.
Retrieved from "https://community.bistudio.com/wiki?title=setFSMVariable&oldid=330070"