Banner Image

Module Core.Velocity

Core - Models a velocity or speed, which can be expressed in various formats according the settings.


Features:

  • Convert velocity in various metric systems.
  • Set the velocity.
  • Create a text in a specific format of a velocity.

Author: FlightControl

Contributions:


Global(s)

Global VELOCITY

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

#VELOCITY VELOCITY

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

VELOCITY constructor

Global VELOCITY_POSITIONABLE

VELOCITY_POSITIONABLE class, extends Core.Base#BASE

#VELOCITY_POSITIONABLE monitors the speed of a Wrapper.Positionable#POSITIONABLE in the simulation, which can be expressed in various formats according the Settings.

#VELOCITY_POSITIONABLE VELOCITY_POSITIONABLE

VELOCITY_POSITIONABLE class, extends Core.Base#BASE

#VELOCITY_POSITIONABLE monitors the speed of a Wrapper.Positionable#POSITIONABLE in the simulation, which can be expressed in various formats according the Settings.

1. VELOCITY_POSITIONABLE constructor

Type(s)

Fields and Methods inherited from VELOCITY Description

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 Core.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 Core.Settings.

VELOCITY.Velocity

Fields and Methods inherited from VELOCITY_POSITIONABLE Description

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 Core.Settings.

VELOCITY_POSITIONABLE.Velocity

Field(s)

Function(s)

Get the velocity in Mps (meters per second).

Defined in:

VELOCITY

Return value:

#number:

The velocity in meters per second.

Get the velocity in Kmph (kilometers per hour).

Defined in:

VELOCITY

Return value:

#number:

The velocity in kilometers per hour.

Get the velocity in Miph (miles per hour).

Defined in:

VELOCITY

Return value:

#number:

The velocity in miles per hour.

Get the velocity in text, according the player Core.Settings.

Defined in:

VELOCITY

Parameter:

Return value:

#string:

The velocity in text.

VELOCITY Constructor.

Defined in:

VELOCITY

Parameter:

#number VelocityMps

The velocity in meters per second.

Return value:

Set the velocity in Mps (meters per second).

Defined in:

VELOCITY

Parameter:

#number VelocityMps

The velocity in meters per second.

Return value:

Set the velocity in Kmph (kilometers per hour).

Defined in:

VELOCITY

Parameter:

#number VelocityKmph

The velocity in kilometers per hour.

Return value:

Set the velocity in Miph (miles per hour).

Defined in:

VELOCITY

Parameter:

#number VelocityMiph

The velocity in miles per hour.

Return value:

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

Defined in:

VELOCITY

Parameters:

VelocityGroup

Return value:

#string:

The velocity in text according the player or default Core.Settings

Field(s)

Function(s)

Get the velocity in Mps (meters per second).

Defined in:

VELOCITY_POSITIONABLE

Return value:

#number:

The velocity in meters per second.

Get the velocity in Kmph (kilometers per hour).

Defined in:

VELOCITY_POSITIONABLE

Return value:

#number:

The velocity in kilometers per hour.

Get the velocity in Miph (miles per hour).

Defined in:

VELOCITY_POSITIONABLE

Return value:

#number:

The velocity in miles per hour.

VELOCITY_POSITIONABLE Constructor.

Defined in:

VELOCITY_POSITIONABLE

Parameter:

The Positionable to monitor the speed.

Return value:

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

Defined in:

VELOCITY_POSITIONABLE

Return value:

#string:

The velocity in text according the player or default Core.Settings