objectParent: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\|= * " to " ")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma3|Game name=
| arma3


|1.50|Game version=
|1.50


|gr1= Object Manipulation |GROUP1=
|gr1= Object Manipulation


| Returns parent of an object if the object is proxy, otherwise [[objNull]]. In case of backpack, the parent is a weaponholder or a cargo space of a vehicle or the unit carrying it. Unit in a vehicle will return the vehicle as parent.<br><br>
| Returns parent of an object if the object is proxy, otherwise [[objNull]]. In case of backpack, the parent is a weaponholder or a cargo space of a vehicle or the unit carrying it. Unit in a vehicle will return the vehicle as parent.<br><br>
Line 13: Line 13:
{{Informative | When used on a soldier, if the soldier is in a vehicle, this command will return soldier's vehicle. Apart from being faster than [[vehicle]] command, it is also more reliable, as when used on dead [[crew]] inside a vehicle, it returns the vehicle object, where as [[vehicle]] command may surprisingly return unit object instead. For example, to delete a unit which is in a vehicle, execute:
{{Informative | When used on a soldier, if the soldier is in a vehicle, this command will return soldier's vehicle. Apart from being faster than [[vehicle]] command, it is also more reliable, as when used on dead [[crew]] inside a vehicle, it returns the vehicle object, where as [[vehicle]] command may surprisingly return unit object instead. For example, to delete a unit which is in a vehicle, execute:
<code>[[objectParent]] _unit [[deleteVehicleCrew]] _unit;</code>}}
<code>[[objectParent]] _unit [[deleteVehicleCrew]] _unit;</code>}}
|DESCRIPTION=


| '''objectParent''' object |SYNTAX=


|p1= object: [[Object]]  |PARAMETER1=
| '''objectParent''' object


| [[Object]] |RETURNVALUE=
|p1= object: [[Object]]
 
| [[Object]]




|x1= <code>_weaponholder = [[objectParent]] _mybackpack;
|x1= <code>_weaponholder = [[objectParent]] _mybackpack;
</code>|EXAMPLE1=
</code>


|x2= Create and place created backpack in front of player:<code>_backpackContainer = "B_TacticalPack_rgr" [[createVehicle]] [0,0,0];
|x2= Create and place created backpack in front of player:<code>_backpackContainer = "B_TacticalPack_rgr" [[createVehicle]] [0,0,0];
_weaponHolder = [[objectParent]] _backpackContainer;
_weaponHolder = [[objectParent]] _backpackContainer;
_weaponHolder [[setPos]] ([[player]] [[modelToWorld]] [0,5,0]);</code>|EXAMPLE2=
_weaponHolder [[setPos]] ([[player]] [[modelToWorld]] [0,5,0]);</code>


|x3= Check if player is on foot:<code>_isOnFoot = [[isNull]] [[objectParent]] [[player]];</code>|EXAMPLE3=
|x3= Check if player is on foot:<code>_isOnFoot = [[isNull]] [[objectParent]] [[player]];</code>


|x4= Detect if player is in commander turret of a vehicle:<code>_isVehicleCommander = [[player]] [[isEqualTo]] [[commander]] [[objectParent]] [[player]];</code>
|x4= Detect if player is in commander turret of a vehicle:<code>_isVehicleCommander = [[player]] [[isEqualTo]] [[commander]] [[objectParent]] [[player]];</code>


| [[backpackContainer]], [[unitBackpack]], [[backpack]], [[backpackCargo]], [[getBackpackCargo]], [[backpackItems]], [[addBackpack]], [[addBackpackCargo]], [[addBackpackCargoGlobal]], [[removeBackpack]], [[clearBackpackCargo]], [[clearBackpackCargoGlobal]], [[clearAllItemsFromBackpack]], [[loadBackpack]], [[backpackSpaceFor]], [[canAddItemToBackpack]], [[addItemToBackpack]], [[removeItemFromBackpack]], [[everyBackpack]], [[vehicle]] |SEEALSO=
| [[backpackContainer]], [[unitBackpack]], [[backpack]], [[backpackCargo]], [[getBackpackCargo]], [[backpackItems]], [[addBackpack]], [[addBackpackCargo]], [[addBackpackCargoGlobal]], [[removeBackpack]], [[clearBackpackCargo]], [[clearBackpackCargoGlobal]], [[clearAllItemsFromBackpack]], [[loadBackpack]], [[backpackSpaceFor]], [[canAddItemToBackpack]], [[addItemToBackpack]], [[removeItemFromBackpack]], [[everyBackpack]], [[vehicle]]


|  |MPBEHAVIOUR=  
|  |MPBEHAVIOUR=  

Revision as of 01:12, 18 January 2021

Hover & click on the images for description

Description

Description:
Returns parent of an object if the object is proxy, otherwise objNull. In case of backpack, the parent is a weaponholder or a cargo space of a vehicle or the unit carrying it. Unit in a vehicle will return the vehicle as parent.

Another good use of objectParent is when a static weapon is known and one needs to check if it is assembled or not. objectParent _staticWeapon will return objNull if weapon is unpacked, or backpack object if packed.

objectParent.jpg

When used on a soldier, if the soldier is in a vehicle, this command will return soldier's vehicle. Apart from being faster than vehicle command, it is also more reliable, as when used on dead crew inside a vehicle, it returns the vehicle object, where as vehicle command may surprisingly return unit object instead. For example, to delete a unit which is in a vehicle, execute: objectParent _unit deleteVehicleCrew _unit;
Groups:
Object Manipulation

Syntax

Syntax:
objectParent object
Parameters:
object: Object
Return Value:
Object

Examples

Example 1:
_weaponholder = objectParent _mybackpack;
Example 2:
Create and place created backpack in front of player:_backpackContainer = "B_TacticalPack_rgr" createVehicle [0,0,0]; _weaponHolder = objectParent _backpackContainer; _weaponHolder setPos (player modelToWorld [0,5,0]);
Example 3:
Check if player is on foot:_isOnFoot = isNull objectParent player;
Example 4:
Detect if player is in commander turret of a vehicle:_isVehicleCommander = player isEqualTo commander objectParent player;

Additional Information

See also:
backpackContainerunitBackpackbackpackbackpackCargogetBackpackCargobackpackItemsaddBackpackaddBackpackCargoaddBackpackCargoGlobalremoveBackpackclearBackpackCargoclearBackpackCargoGlobalclearAllItemsFromBackpackloadBackpackbackpackSpaceForcanAddItemToBackpackaddItemToBackpackremoveItemFromBackpackeveryBackpackvehicle

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

Bottom Section