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

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
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 setting.
GetTimeStep()This action gets the time step between physics updates.
GetTimeStepRatio()This action gets the time step ratio.
GetVelocityIterations()This action returns the current velocity iterations setting.
IsWarmStarting()This action returns whether the solver will warm start.
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 in.
SetTimeStep(number timeStep)This action sets the time step between physics updates.
SetTimeStepRatio(number timeStepRatio)This action sets the time step ratio.
SetVelocityIterations(integer velocityIterations)This action change the velocity iterations from default to a velocityIterations passed in.
SetWarmStarting(boolean warmStarting)This action sets whether warm starting is desired.

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns a CompareResult. The compare result is either larger if this hash code is larger than the object passed as a parameter, smaller, or equal.

Example Code

use Libraries.Language.Support.CompareResult
        Object o
        Object t
        CompareResult result = o:Compare(t)

Parameters

Return

Libraries.Language.Support.CompareResult: 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(t)

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 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

SetPositionIterations(integer positionIterations)

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

Parameters

SetTimeStep(number timeStep)

This action sets the time step between physics updates.

Parameters

SetTimeStepRatio(number timeStepRatio)

This action sets the time step ratio.

Parameters

SetVelocityIterations(integer velocityIterations)

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

Parameters

SetWarmStarting(boolean warmStarting)

This action sets whether warm starting is desired.

Parameters