setFSMVariable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(populated with empty template)
m (Some wiki formatting)
 
(54 intermediate revisions by 7 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


| (description) |= Description
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| '''(command)''' |= Syntax
|game4= arma3
|version4= 0.50


|p1= |= PARAMETER1
|gr1= System


|p2= |= 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= |= PARAMETER3
|s1= handle [[setFSMVariable]] [name, value]


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


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


|x1= <code>(example)</code>|= EXAMPLE1
|p3= value: [[Anything]] - new value of the FSM variable


____________________________________________________________________________________________
|r1= [[Nothing]]


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


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


<h3 style='display:none'>Notes</h3>
{{Note
<dl class='command_description'>
|user= Master85
<!-- Note Section BEGIN -->
|timestamp= 20140323005300
 
|text= 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}}}}]]

Latest revision as of 17: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.