Skip to content

Class: phcondition_expireonstep ​

Physics condition that expires on the selected step.

Source ​

src/xrPhysics/PHSimpleCallsScript.cpp, phcondition_expireonstep binding.

Custom Constructor ​

phcondition_expireonstep

Remarks ​

Subclass of phcondition_callonstep used by the physics commander for calls that should be considered true while expiring on the configured step.

Extends ​

Constructors ​

Constructor ​

ts
new phcondition_expireonstep(): phcondition_expireonstep;

Create an expiring physics step condition.

Returns ​

phcondition_expireonstep

Overrides ​

phcondition_callonstep.constructor

Methods ​

set_global_time_ms() ​

ts
set_global_time_ms(time: number): void;

Set the absolute game time in milliseconds that must be reached.

Parameters ​

ParameterTypeDescription
timenumberAbsolute global time in milliseconds.

Returns ​

void

Inherited from ​

phcondition_callonstep.set_global_time_ms


set_global_time_s() ​

ts
set_global_time_s(time: number): void;

Set the absolute game time in seconds that must be reached.

Parameters ​

ParameterTypeDescription
timenumberAbsolute global time in seconds.

Returns ​

void

Inherited from ​

phcondition_callonstep.set_global_time_s


set_step() ​

ts
set_step(step: number): void;

Set the absolute physics step that must be reached.

Parameters ​

ParameterTypeDescription
stepnumberAbsolute physics step number.

Returns ​

void

Inherited from ​

phcondition_callonstep.set_step


set_steps_interval() ​

ts
set_steps_interval(steps: number): void;

Set the condition to become true after a number of physics steps.

Parameters ​

ParameterTypeDescription
stepsnumberStep count from the current physics world step.

Returns ​

void

Inherited from ​

phcondition_callonstep.set_steps_interval


set_time_interval_ms() ​

ts
set_time_interval_ms(time: number): void;

Set the condition to become true after a millisecond interval.

Parameters ​

ParameterTypeDescription
timenumberInterval in milliseconds.

Returns ​

void

Inherited from ​

phcondition_callonstep.set_time_interval_ms


set_time_interval_s() ​

ts
set_time_interval_s(time: number): void;

Set the condition to become true after a second interval.

Parameters ​

ParameterTypeDescription
timenumberInterval in seconds.

Returns ​

void

Inherited from ​

phcondition_callonstep.set_time_interval_s