Module `Velocity`

Core -- VELOCITY models a speed, which can be expressed in various formats according the Settings.

Author: FlightControl

Contributions:

Global(s)

VELOCITY class, extends Base#BASE

VELOCITY models a speed, which can be expressed in various formats according the Settings.

VELOCITY_POSITIONABLE

VELOCITY_POSITIONABLE class, extends Base#BASE

VELOCITY_POSITIONABLE monitors the speed of an Positionable in the simulation, which can be expressed in various formats according the Settings.

Type `VELOCITY`

VELOCITY:Get()	Get the velocity in Mps (meters per second).
VELOCITY:GetKmph()	Get the velocity in Kmph (kilometers per hour).
VELOCITY:GetMiph()	Get the velocity in Miph (miles per hour).
VELOCITY:GetText(Settings)	Get the velocity in text, according the player Settings.
VELOCITY:New(VelocityMps)	VELOCITY Constructor.
VELOCITY:Set(VelocityMps)	Set the velocity in Mps (meters per second).
VELOCITY:SetKmph(VelocityKmph)	Set the velocity in Kmph (kilometers per hour).
VELOCITY:SetMiph(VelocityMiph)	Set the velocity in Miph (miles per hour).
VELOCITY:ToString(Controllable, Settings, VelocityGroup)	Get the velocity in text, according the player or default Settings.
VELOCITY.Velocity

Type `VELOCITY_POSITIONABLE`

VELOCITY_POSITIONABLE:Get()	Get the velocity in Mps (meters per second).
VELOCITY_POSITIONABLE:GetKmph()	Get the velocity in Kmph (kilometers per hour).
VELOCITY_POSITIONABLE:GetMiph()	Get the velocity in Miph (miles per hour).
VELOCITY_POSITIONABLE:New(Positionable)	VELOCITY_POSITIONABLE Constructor.
VELOCITY_POSITIONABLE.Positionable
VELOCITY_POSITIONABLE:ToString()	Get the velocity in text, according the player or default Settings.
VELOCITY_POSITIONABLE.Velocity

Global(s)

#VELOCITY VELOCITY

VELOCITY class, extends Base#BASE

VELOCITY models a speed, which can be expressed in various formats according the Settings.

1. VELOCITY constructor

VELOCITY.New(): Creates a new VELOCITY object.

#VELOCITY_POSITIONABLE VELOCITY_POSITIONABLE

VELOCITY_POSITIONABLE class, extends Base#BASE

VELOCITY_POSITIONABLE monitors the speed of an Positionable in the simulation, which can be expressed in various formats according the Settings.

1. VELOCITY_POSITIONABLE constructor

VELOCITY_POSITIONABLE.New(): Creates a new VELOCITY_POSITIONABLE object.

Type `Velocity`

Type `VELOCITY`

Field(s)

VELOCITY:Get()

Get the velocity in Mps (meters per second).

Return value

#number: The velocity in meters per second.

VELOCITY:GetKmph()

Get the velocity in Kmph (kilometers per hour).

Return value

#number: The velocity in kilometers per hour.

VELOCITY:GetMiph()

Get the velocity in Miph (miles per hour).

Return value

#number: The velocity in miles per hour.

VELOCITY:GetText(Settings)

Get the velocity in text, according the player Settings.

Parameter

Core.Settings#SETTINGS Settings :

Return value

#string: The velocity in text.

VELOCITY:New(VelocityMps)

VELOCITY Constructor.

Parameter

#number VelocityMps : The velocity in meters per second.

Return value

VELOCITY:Set(VelocityMps)

Set the velocity in Mps (meters per second).

Parameter

#number VelocityMps : The velocity in meters per second.

Return value

VELOCITY:SetKmph(VelocityKmph)

Set the velocity in Kmph (kilometers per hour).

Parameter

#number VelocityKmph : The velocity in kilometers per hour.

Return value

VELOCITY:SetMiph(VelocityMiph)

Set the velocity in Miph (miles per hour).

Parameter

#number VelocityMiph : The velocity in miles per hour.

Return value

VELOCITY:ToString(Controllable, Settings, VelocityGroup)

Get the velocity in text, according the player or default Settings.

Parameters

Wrapper.Controllable#CONTROLLABLE Controllable :
Core.Settings#SETTINGS Settings :
VelocityGroup :

Return value

#string: The velocity in text according the player or default Settings

VELOCITY.Velocity

Type `VELOCITY_POSITIONABLE`

Field(s)

VELOCITY_POSITIONABLE:Get()

Get the velocity in Mps (meters per second).

Return value

#number: The velocity in meters per second.

VELOCITY_POSITIONABLE:GetKmph()

Get the velocity in Kmph (kilometers per hour).

Return value

#number: The velocity in kilometers per hour.

VELOCITY_POSITIONABLE:GetMiph()

Get the velocity in Miph (miles per hour).

Return value

#number: The velocity in miles per hour.

VELOCITY_POSITIONABLE:New(Positionable)

VELOCITY_POSITIONABLE Constructor.

Parameter

Wrapper.Positionable#POSITIONABLE Positionable : The Positionable to monitor the speed.

Return value

#VELOCITY_POSITIONABLE:

VELOCITY_POSITIONABLE.Positionable

VELOCITY_POSITIONABLE:ToString()

Get the velocity in text, according the player or default Settings.

Return value

#string: The velocity in text according the player or default Settings

VELOCITY_POSITIONABLE.Velocity