setUnitPosWeak: Difference between revisions

Latest revision as of 11:34, 3 September 2024

1.04

Hover & click on the images for description

Description

Description:

Set unit position rules. This command is the lowest level of priority for setting unit position and to be used in scripted FSM's. Priorities are:

Unit pos commanded (from the commanding menu, higher priority).
Unit pos scripted (from setUnitPos scripting command, medium priority).
Unit pos FSM / setUnitPosWeak (used in the formation FSM, lowest priority).

Groups:

Unit Control

Syntax

Syntax:

unit setUnitPosWeak mode

Parameters:

unit: Object

mode: String - can be:

"DOWN" - Unit goes prone and stays prone.
"UP" - Unit stands and stays standing.
"MIDDLE" - Kneel Position. 1.04 - Unit will not kneel if it is unarmed
"AUTO" - Unit chooses mode according to circumstances.

Return Value:

Nothing

Examples

Example 1:: _soldier disableAI "FSM"; _soldier setUnitPosWeak "DOWN";

Additional Information

See also:: FSM doFSM setUnitPos unitPos

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

@@ Line 1: / Line 1: @@
-{{Command|Comments=
+{{RV|type=command
-____________________________________________________________________________________________
-| arma1 |Game name=
+|game1= arma1
+|version1= 1.04
-|1.04|Game version=
+|game2= arma2
+|version2= 1.00
-|eff= global|Multiplayer Effects=
+|game3= arma2oa
-|arg= local|Multiplayer Arguments=
+|version3= 1.50
-|gr1= Unit Control |GROUP1=
+|game4= tkoh
-____________________________________________________________________________________________
+|version4= 1.00
-| Set unit position rules. Mode may be one of:
+|game5= arma3
-* '''"DOWN"''' - person goes prone and stays prone.
+|version5= 0.50
-* '''"UP"''' - person stands and stays standing.
-* '''"Middle"''' - Kneel Position. ArmA version 1.04
-* '''"AUTO"''' - person chooses mode according to circumstances.
-|DESCRIPTION=
+|eff= global
-____________________________________________________________________________________________
-| unit '''setUnitPosWeak''' mode |SYNTAX=
+|arg= local
-|p1= unit: [[Object]] |PARAMETER1=
+|gr1= Unit Control
-|p2= mode: [[String]] - as above |PARAMETER2=
+|descr= Set unit position rules. This command is the lowest level of priority for setting unit position and to be used in scripted
+FSM's. Priorities are:
+# Unit pos commanded (from the commanding menu, higher priority).
+# Unit pos scripted (from [[setUnitPos]] scripting command, medium priority).
+# Unit pos FSM / '''setUnitPosWeak''' (used in the formation FSM, lowest priority).
-| [[Nothing]] |RETURNVALUE=
+|s1= unit [[setUnitPosWeak]] mode
-____________________________________________________________________________________________
-|x1= <code>_soldier [[disableAI]] "FSM";
-_soldier [[setUnitPosWeak]] "DOWN";</code>|EXAMPLE1=
-____________________________________________________________________________________________
-| [[FSM]], [[doFSM]], [[setUnitPos]], [[unitPos]] |SEEALSO=
+|p1= unit: [[Object]]
-}}
+|p2= mode: [[String]] - can be:
+* "DOWN" - Unit goes prone and stays prone.
+* "UP" - Unit stands and stays standing.
+* "MIDDLE" - Kneel Position. {{GVI|arma1|1.04}} - Unit will not kneel if it is unarmed
+* "AUTO" - Unit chooses mode according to circumstances.
-<h3 style="display:none">Notes</h3>
+|r1= [[Nothing]]
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<dt class="note">Unknown
+|x1= <sqf>
-<dd class="note">This command is the lowest level of priority for setting unit position and to be used in scripted
+_soldier disableAI "FSM";
-FSM's.<br>
+_soldier setUnitPosWeak "DOWN";
-The current priorities are:
+</sqf>
-* 1. Unit pos commanded (from the commanding menu, higher priority).
-* 2. Unit pos scripted (from [[setUnitPos]] scripting command, medium priority).
-* 3. Unit pos FSM / '''setUnitPosWeak''' (used in the formation FSM, lowest priority).
-<!-- Note Section END -->
+|seealso= [[FSM]] [[doFSM]] [[setUnitPos]] [[unitPos]]
-</dl>
+}}
-Command most likely only works if run before [[join]] into group after [[createUnit array]].
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Scripting Commands|SETUNITPOSWEAK]]
-{{GameCategory|arma1|Scripting Commands}}
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}