Class: ray_pick

Reusable ray query object.

Source

src/xrGame/level_script.cpp, ray_pick binding.

Custom Constructor

ray_pick

Extends

• EngineBinding

Constructors

Constructor

new ray_pick(): ray_pick;

Create an empty ray query with no target flags and zero range.

Returns

ray_pick

Overrides

EngineBinding.constructor

Constructor

new ray_pick(
   position: vector, 
   direction: vector, 
   range: number, 
   target: TXR_rq_target, 
   ignore_object: Nillable<game_object>): ray_pick;

Create a configured ray query.

Parameters

Parameter	Type	Description
position	vector	Ray origin.
direction	vector	Ray direction.
range	number	Ray range.
target	TXR_rq_target	Ray query target flags.
ignore_object	Nillable<game_object>	Object ignored by the query, or null / undefined.

Returns

ray_pick

Overrides

EngineBinding.constructor

Methods

get_distance()

get_distance(): number;

Get hit distance from the last ray query.

Returns

number

Hit distance.

---

get_element()

get_element(): number;

Get hit model element id from the last ray query.

Returns

number

Hit model element id, or 0.

---

get_object()

get_object(): Nullable<game_object>;

Get hit object from the last ray query.

Returns

Nullable<game_object>

Hit object, or null.

---

get_result()

get_result(): rq_result;

Get last ray query result.

Returns

rq_result

Last ray query result.

---

query()

query(): boolean;

Execute the ray query and update this query's result on hit.

Returns

boolean

Whether the ray hit anything.

---

set_direction()

set_direction(direction: vector): void;

Set ray direction.

Parameters

Parameter	Type	Description
direction	vector	Ray direction.

Returns

void

---

set_flags()

set_flags(target: TXR_rq_target): void;

Set ray target flags.

Parameters

Parameter	Type	Description
target	TXR_rq_target	Ray query target flags.

Returns

void

---

set_ignore_object()

set_ignore_object(ignore_object: Nillable<game_object>): void;

Set object ignored by the query.

Parameters

Parameter	Type	Description
ignore_object	Nillable<game_object>	Object ignored by the query, or null / undefined.

Returns

void

---

set_position()

set_position(position: vector): void;

Set ray origin.

Parameters

Parameter	Type	Description
position	vector	Ray origin.

Returns

void

---

set_range()

set_range(range: number): void;

Set ray range.

Parameters

Parameter	Type	Description
range	number	Ray range.

Returns

void

Properties

__name

readonly __name: string;

LuaBind instance constructor name.

Inherited from

EngineBinding.__name

---

__name

readonly static __name: string;

LuaBind class constructor name.

Inherited from

EngineBinding.__name