setFSMVariable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game version" to "|Game version=")
m (Some wiki formatting)
 
(42 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


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


| handle '''setFSMVariable''' [name, value] |SYNTAX=
|game4= arma3
|version4= 0.50


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


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


|p3= name: [[String]] - name of the FSM variable |PARAMETER3=
|s1= handle [[setFSMVariable]] [name, value]


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


| [[Nothing]] |RETURNVALUE=
|p2= name: [[String]] - name of the FSM variable


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


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


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


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


| |MPBEHAVIOUR=  
{{Note
____________________________________________________________________________________________
|user= Master85
|timestamp= 20140323005300
|text= If the variable is not yet defined within the FSM it will be created.
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- 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 -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 18:49, 15 August 2022

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.