Class: holder

Holder object that the actor can engage with.

Source

src/xrGame/holder_custom_script.cpp, holder binding.

Custom Constructor

holder

Remarks

Returned only for objects that implement holder controls, such as mounted weapons or vehicles.

Methods

Action()

Action(id: number, flags: number): void;

Send holder action flags.

Parameters

Parameter	Type	Description
id	number	Action id.
flags	number	Action flags.

Returns

void

---

engaged()

engaged(): boolean;

Returns

boolean

Whether the actor is currently attached to the holder.

---

SetEnterLocked()

SetEnterLocked(is_enabled: boolean): void;

Set holder object enter state.

Parameters

Parameter	Type	Description
is_enabled	boolean	Whether entering the holder is locked.

Returns

void

---

SetExitLocked()

SetExitLocked(is_enabled: boolean): void;

Set holder object exit state.

Parameters

Parameter	Type	Description
is_enabled	boolean	Whether exiting the holder is locked.

Returns

void

---

SetParam()

SetParam(id: number, value: vector): void;

Set holder vector parameter.

Parameters

Parameter	Type	Description
id	number	Parameter id.
value	vector	Parameter value.

Returns

void