doFSM: Difference between revisions
Jump to navigation
Jump to search
Groups:
Unit Control
m (format) |
m (Fixed formatting) |
||
(53 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| | |game1= arma1 | ||
|version1= 1.00 | |||
|1.00 | |game2= arma2 | ||
|version2= 1.00 | |||
| Orders a unit to process command defined by [[FSM]] file (silently). | |game3= arma2oa | ||
|version3= 1.50 | |||
|game4= tkoh | |||
|version4= 1.00 | |||
|game5= arma3 | |||
|version5= 0.50 | |||
|gr1= Unit Control | |||
|descr= Orders a unit to process command defined by [[FSM]] file (silently). | |||
Unlike with execFSM where ''_this'' is passed to the FSM, the following parameters are passed when using doFSM/commandFSM: | Unlike with execFSM where ''_this'' is passed to the FSM, the following parameters are passed when using doFSM/commandFSM: | ||
: _leader: leader of subgroup with this command | |||
: _destination: command destination/position | |||
: _target: command target | |||
: _units: list of all persons in subgroup | |||
|s1= unit [[doFSM]] [fsmName, position, target] | |||
|p1= unit: [[Object]] or [[Array]] of [[Object|objects]] | |||
|= | |p3= fsmName: [[String]] | ||
| | |p4= position: [[Array]] | ||
| | |p5= target: [[Object]] | ||
| | |r1= [[Nothing]] | ||
|x1= <sqf>_soldierOne doFSM ["move.fsm", position player, player];</sqf> | |||
|x1= < | |||
| [ | |x2= <sqf>units player doFSM ["move.fsm", position player, player];</sqf> | ||
|seealso= [[FSM]] [[FSM_Editor_Manual]] [[commandFSM]] [[completedFSM]] [[execFSM]] [[getFSMVariable]] [[setFSMVariable]] [[unitReady]] | |||
}} | }} | ||
<dl class="command_description"> | <dl class="command_description"> | ||
< | |||
<dd class="notedate">Posted on | <dt></dt> | ||
<dt class="note"> | <dd class="notedate">Posted on 2010-08-04 - 16:09</dd> | ||
<dt class="note">[[User:Rübe|Rübe]]</dt> | |||
<dd class="note">Do not ''doStop'' a unit in a FSM called with ''doFSM'' or ''commandFSM''. Doing so nevertheless will halt your FSM, since no links are followed anymore (doing so in an end state should be fine though). Also this may crash your game in certain mysterious circumstances.<br><br> | |||
You may design your FSM so that they may be called with doFSM/commandFSM and execFSM likewise by checking if ''_units'' or ''_this'' is nil and then init the variables accordingly. Just remember that you should use the low level ''moveTo'' (together with ''moveToCompleted'', ''moveToFailed'') if do-/commandFSM'd, and ''doMove'' or ''commandMove'' (together with ''unitReady'') if execFSM'd. A ''moveTo'' in an FSM started with ''execFSM'' won't do anything, likewise ''doMove'' in a FSM started with ''doFSM'' or ''commandFSM'' wont work either. Think about it for a minute and you will see why. (hint: a unit running a FSM called with ''doFSM'' or ''commandFSM'' will _never_ return true for ''(unitReady _unit)'')<br><br> | You may design your FSM so that they may be called with doFSM/commandFSM and execFSM likewise by checking if ''_units'' or ''_this'' is nil and then init the variables accordingly. Just remember that you should use the low level ''moveTo'' (together with ''moveToCompleted'', ''moveToFailed'') if do-/commandFSM'd, and ''doMove'' or ''commandMove'' (together with ''unitReady'') if execFSM'd. A ''moveTo'' in an FSM started with ''execFSM'' won't do anything, likewise ''doMove'' in a FSM started with ''doFSM'' or ''commandFSM'' wont work either. Think about it for a minute and you will see why. (hint: a unit running a FSM called with ''doFSM'' or ''commandFSM'' will _never_ return true for ''(unitReady _unit)'')<br><br> | ||
Anyway, if you want to be able to call your FSM either way, a "ready" condition might look light this: ''(moveToCompleted _unit) || (moveToFailed _unit) || (unitReady _unit)'', assuming you have a ''moveTo'' or a ''doMove'' (depending on how the fsm is called) in the prior state. | Anyway, if you want to be able to call your FSM either way, a "ready" condition might look light this: ''(moveToCompleted _unit) || (moveToFailed _unit) || (unitReady _unit)'', assuming you have a ''moveTo'' or a ''doMove'' (depending on how the fsm is called) in the prior state. | ||
< | <dt></dt> | ||
< | <dd class="notedate">Posted on 2015-02-14 - 13:36 (UTC)</dd> | ||
<dd class="notedate">Posted on | |||
<dt class="note">[[User:Katulobotomia|Katulobotomia]]</dt> | <dt class="note">[[User:Katulobotomia|Katulobotomia]]</dt> | ||
<dd class="note"> | <dd class="note"> | ||
Adding to Rübe's note, doFSM can be checked if it has finished by ''unitReady'' as of 2015 and it will return ''true'' when your FSM has completed. | Adding to Rübe's note, doFSM can be checked if it has finished by ''unitReady'' as of 2015 and it will return ''true'' when your FSM has completed. | ||
</dd> | </dd> | ||
</dl> | </dl> | ||
Latest revision as of 14:04, 12 August 2024
Description
- Description:
- Orders a unit to process command defined by FSM file (silently).
Unlike with execFSM where _this is passed to the FSM, the following parameters are passed when using doFSM/commandFSM:
- _leader: leader of subgroup with this command
- _destination: command destination/position
- _target: command target
- _units: list of all persons in subgroup
Syntax
- Syntax:
- unit doFSM [fsmName, position, target]
- Parameters:
- unit: Object or Array of objects
- fsmName: String
- position: Array
- target: Object
- Return Value:
- Nothing
Examples
- Example 1:
- Example 2:
Additional Information
- See also:
- FSM FSM_Editor_Manual commandFSM completedFSM execFSM getFSMVariable setFSMVariable unitReady
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
- Posted on 2010-08-04 - 16:09
- Rübe
- Do not doStop a unit in a FSM called with doFSM or commandFSM. Doing so nevertheless will halt your FSM, since no links are followed anymore (doing so in an end state should be fine though). Also this may crash your game in certain mysterious circumstances.
You may design your FSM so that they may be called with doFSM/commandFSM and execFSM likewise by checking if _units or _this is nil and then init the variables accordingly. Just remember that you should use the low level moveTo (together with moveToCompleted, moveToFailed) if do-/commandFSM'd, and doMove or commandMove (together with unitReady) if execFSM'd. A moveTo in an FSM started with execFSM won't do anything, likewise doMove in a FSM started with doFSM or commandFSM wont work either. Think about it for a minute and you will see why. (hint: a unit running a FSM called with doFSM or commandFSM will _never_ return true for (unitReady _unit))
Anyway, if you want to be able to call your FSM either way, a "ready" condition might look light this: (moveToCompleted _unit) || (moveToFailed _unit) || (unitReady _unit), assuming you have a moveTo or a doMove (depending on how the fsm is called) in the prior state. - Posted on 2015-02-14 - 13:36 (UTC)
- Katulobotomia
- Adding to Rübe's note, doFSM can be checked if it has finished by unitReady as of 2015 and it will return true when your FSM has completed.
Categories:
- Scripting Commands
- Introduced with Armed Assault version 1.00
- ArmA: Armed Assault: New Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: Unit Control