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 fo

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetHashCode()This action gets the hash code for an object.
GetInverseTimeStep()This action gets the 1/(time step
GetPositionIterations()This action returns the current position iterations settin
GetTimeStep()This action gets the time step between physics update
GetTimeStepRatio()This action gets the time step rati
GetVelocityIterations()This action returns the current velocity iterations settin
IsWarmStarting()This action returns whether the solver will warm star
SetInverseTimeStep(number inverseTimeStep)This action sets the 1/(time step
SetPositionIterations(integer positionIterations)This action change the position iterations from default to a positionIterations passed i
SetTimeStep(number timeStep)This action sets the time step between physics update
SetTimeStepRatio(number timeStepRatio)This action sets the time step rati
SetVelocityIterations(integer velocityIterations)This action change the velocity iterations from default to a velocityIterations passed i
SetWarmStarting(boolean warmStarting)This action sets whether warm starting is desire

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.

Example Code

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

Parameters

Return

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

Equals(Libraries.Language.Object object)

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

Example Code

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

Parameters

Return

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

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode

Return

integer: The integer hash code of the object.

GetInverseTimeStep()

This action gets the 1/(time step

Return

number:

GetPositionIterations()

This action returns the current position iterations settin

Return

integer:

GetTimeStep()

This action gets the time step between physics update

Return

number:

GetTimeStepRatio()

This action gets the time step rati

Return

number:

GetVelocityIterations()

This action returns the current velocity iterations settin

Return

integer:

IsWarmStarting()

This action returns whether the solver will warm star

Return

boolean:

SetInverseTimeStep(number inverseTimeStep)

This action sets the 1/(time step

Parameters

SetPositionIterations(integer positionIterations)

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

Parameters

SetTimeStep(number timeStep)

This action sets the time step between physics update

Parameters

SetTimeStepRatio(number timeStepRatio)

This action sets the time step rati

Parameters

SetVelocityIterations(integer velocityIterations)

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

Parameters

SetWarmStarting(boolean warmStarting)

This action sets whether warm starting is desire

Parameters