Libraries.Game.Physics.TimeStep Documentation

This class contains settings that will change what is the time between physics updates and how many interations the position and velocity constraints will need to be solved for.

Inherits from: Libraries.Language.Object

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetInverseTimeStep()

This action gets the 1/(time step).

Return

number:

GetPositionIterations()

This action returns the current position iterations setting.

Return

integer:

GetTimeStep()

This action gets the time step between physics updates.

Return

number:

GetTimeStepRatio()

This action gets the time step ratio.

Return

number:

GetVelocityIterations()

This action returns the current velocity iterations setting.

Return

integer:

IsWarmStarting()

This action returns whether the solver will warm start.

Return

boolean:

SetInverseTimeStep(number inverseTimeStep)

This action sets the 1/(time step).

Parameters

  • number inverseTimeStep

SetPositionIterations(integer positionIterations)

This action change the position iterations from default to a positionIterations passed in.

Parameters

  • integer positionIterations

SetTimeStep(number timeStep)

This action sets the time step between physics updates.

Parameters

  • number timeStep

SetTimeStepRatio(number timeStepRatio)

This action sets the time step ratio.

Parameters

  • number timeStepRatio

SetVelocityIterations(integer velocityIterations)

This action change the velocity iterations from default to a velocityIterations passed in.

Parameters

  • integer velocityIterations

SetWarmStarting(boolean warmStarting)

This action sets whether warm starting is desired.

Parameters

  • boolean warmStarting