unitReady: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "|= Game version" to "|Game version=")
(26 intermediate revisions by 14 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|UNITREADY]]
{{Command|Comments=
[[Category:Scripting Commands OFP 1.96|UNITREADY]]
____________________________________________________________________________________________
[[Category:Scripting Commands OFP 1.46|UNITREADY]]
 
[[Category:Scripting Commands ArmA|UNITREADY]]
| ofp |Game name=
 
|1.00|Game version=
____________________________________________________________________________________________
 
| Check if the unit is ready. Unit is busy when it is given some command like [[move]], until the command is finished. |DESCRIPTION=
____________________________________________________________________________________________
 
| [[Boolean]] <nowiki>=</nowiki> '''unitReady''' unitName|SYNTAX=
 
|p1= unitName: [[Object]] |PARAMETER1=
 
| [[Boolean]] |RETURNVALUE=
____________________________________________________________________________________________
 
|x1= <code>_it = [[unitReady]] _soldierOne;</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[move]] |SEEALSO=


<h2 style="color:#000066">'''unitReady'''</h2>
}}


<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->


'''Operand types:'''
<dd class="notedate">Posted on August 26, 2010
<dt class="note">'''[[User:Rübe|Rübe]]'''
<dd class="note">
Keep in mind that a) dead units are [[unitReady]] and b) that it takes a while until it get's known to group members that a unit is not [[alive]] anymore, which leads to c) the current [[leader]] of a group might be actually dead (until another group member takes command).<br>
Why this is important? I'll give you an example: if you're using [[unitReady]] as a condition inside one of your fsm to advance whatever the fsm/group is doing, you really might wanna check that this unit is actually still alive. Otherwise you might end up with really fast and nasty loops in your fsm, eventually accompanied by a stream of radio commands that will last until finally a living leader is in command again.. and that could take a while... nasty, I tell you :)


None


'''Type of returned value:'''
<dt class="note">'''[[User:Rübe|Rübe]]'''
<dd class="note">
Regarding vehicles, there is only one single unit (from the vehicle crew) whose unitReady-status is affected by giving that vehicle (or that unit) commands. While it's the driver unit for a truck, it is the gunner unit for a mg-jeep or the commander for a tank. Generally it's always the unit "in control" of the vehicle. (because it's only that unit, that is seen as "full unit" to the "outside world". Only he can be adressed with commands.)<br>
In consequence you can't just send vehicles around and check if they've arrived with something like:


[[Boolean]]
  waitUntil{(unitReady (driver _vehicle))}; // don't do this!


'''Description:'''
Because it's ''not guaranteed, that the driver is in command of the vehicle'' and only that unit will have it's unitReady status affected.<br>
So in conclusion, '''if you need to check if a vehicle is ready''', try something like this:<pre>_vehicleReady = {
    private ["_veh", "_ready"];
    _veh = _this;
    _ready = true;
    {
        if (!(isNull _x)) then
        {
            _ready = _ready && (unitReady _x);
        };
    } forEach [
        (commander _veh),
        (gunner _veh),
        (driver _veh)
    ];
    _ready
};</pre>


Check if unit is ready.


Unit is busy when it is given some command like [[move]], until the command is finished.
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>


'''Example:'''
[[Category:Scripting Commands|UNITREADY]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|UNITREADY]]
[[Category:Scripting Commands OFP 1.46|UNITREADY]]
[[Category:Scripting Commands ArmA|UNITREADY]]
[[Category:Scripting Commands ArmA2|UNITREADY]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]


_it = '''unitReady''' soldierOne
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on November 21, 2015 - 22:40 (UTC)</dd>
<dt class="note">[[User:Kastenbier|Kastenbier]]</dt>
<dd class="note">
To check readiness of a vehicle, don't check it's crew, driver, gunner, commander, etc., but the vehicle itself, e.g.:
<code>unitReady (vehicle driver _YourVehicle);</code><br>
Only tested 11/21/2015 by me with A2 1.63.131129 and A3 1.52.132676 but possibly true since 1964. :P
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 14:03, 2 September 2019

Hover & click on the images for description

Description

Description:
Check if the unit is ready. Unit is busy when it is given some command like move, until the command is finished.
Groups:
Uncategorised

Syntax

Syntax:
Boolean = unitReady unitName
Parameters:
unitName: Object
Return Value:
Boolean

Examples

Example 1:
_it = unitReady _soldierOne;

Additional Information

See also:
move

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

Notes

Posted on August 26, 2010
Rübe
Keep in mind that a) dead units are unitReady and b) that it takes a while until it get's known to group members that a unit is not alive anymore, which leads to c) the current leader of a group might be actually dead (until another group member takes command).
Why this is important? I'll give you an example: if you're using unitReady as a condition inside one of your fsm to advance whatever the fsm/group is doing, you really might wanna check that this unit is actually still alive. Otherwise you might end up with really fast and nasty loops in your fsm, eventually accompanied by a stream of radio commands that will last until finally a living leader is in command again.. and that could take a while... nasty, I tell you :)
Rübe
Regarding vehicles, there is only one single unit (from the vehicle crew) whose unitReady-status is affected by giving that vehicle (or that unit) commands. While it's the driver unit for a truck, it is the gunner unit for a mg-jeep or the commander for a tank. Generally it's always the unit "in control" of the vehicle. (because it's only that unit, that is seen as "full unit" to the "outside world". Only he can be adressed with commands.)
In consequence you can't just send vehicles around and check if they've arrived with something like: waitUntil{(unitReady (driver _vehicle))}; // don't do this! Because it's not guaranteed, that the driver is in command of the vehicle and only that unit will have it's unitReady status affected.
So in conclusion, if you need to check if a vehicle is ready, try something like this:
_vehicleReady = {
    private ["_veh", "_ready"];
    _veh = _this;
    _ready = true;
    {
        if (!(isNull _x)) then
        {
            _ready = _ready && (unitReady _x);
        };
    } forEach [
        (commander _veh),
        (gunner _veh),
        (driver _veh)
    ];
    _ready
};


Bottom Section

Posted on November 21, 2015 - 22:40 (UTC)
Kastenbier
To check readiness of a vehicle, don't check it's crew, driver, gunner, commander, etc., but the vehicle itself, e.g.: unitReady (vehicle driver _YourVehicle);
Only tested 11/21/2015 by me with A2 1.63.131129 and A3 1.52.132676 but possibly true since 1964. :P