Railroad Vehicle Movement

Parent

ActorComponent

This actor component contains all the infomation about the movement of a railroad vehicle.

Properties

airBrakingForce : Float

The air braking force currently acting on the vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Air Braking Force

airResistance : Float

The current air resistance of this vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Air Resistance

brakingForce : Float

The braking force currently acting on the vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Braking Force

curvatureResistance : Float

The current curvature resistance of this vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Curvature Resistance

dynamicBrakingForce : Float

The dynamic braking force currently acting on the vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Dynamic Braking Force

gradientForce : Float

The gradient force currently acting on the vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Gradient Force

gradientResistance : Float

The current gardient resistance of this vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Gradient Resistance

gravitationalForce : Float

The current gravitational force acting on the vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Gravitationl Force

isMoving : Bool

True if this vehicle is currently moving.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Is Moving

mass : Float

The current mass of the vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Mass

maxAirBrakingEffort : Float

The maximum air braking effort of this vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Max Air Braking Effort

maxDynamicBrakingEffort : Float

The maximum dynamic braking effort of this vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Max Dynamic Braking Effort

maxSpeed : Float

The maximum forward speed the vehicle can reach.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Max Speed

maxTractiveEffort : Float

The maximum tractive effort of this vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Max Tractive Effort

numWheelsets : Int

The number of wheelsets this vehicle has.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Num Wheelsets

orientation : Float

The orientation of the vehicle

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Orientation

payloadMass : Float

The mass of the payload of the vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Payload Mass

relativeSpeed : Float

The current relative forward speed to the ground.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Relative Speed

resistiveForce : Float

The resistive force currently acting on the vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Resistive Froce

rollingResistance : Float

The current rolling resistance of this vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Rolling Resistance

speed : Float

The current forward speed of the vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Speed

tareMass : Float

The tare mass of the vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Tare Mass

trackCurvature : Float

The current track curvature of this vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Track Curvature

trackGrade : Float

The current track grade of this vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Track Grade

tractiveForce : Float

The current tractive force acting on the vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Tractive Force

wheelRotation : Float

The current wheel rotation of this vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Wheel Rotation

wheelsetAngle : Float

The wheelset angle of this vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Wheelset Angle

Functions

getCouplerRotationAndExtention (coupler : Int) → (x : Float, y : Float, z : Float, extention : Float)

Returns the normal vector and the extention of the coupler with the given index.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Coupler Rotation And Extention
Parameters
Name Type Description

Coupler coupler

Int

The index of which you want to get the normal and extention of.
Return Values
Name Type Description

X x

Float

The X component of the coupler normal.

Y y

Float

The Y component of the coupler normal.

Z z

Float

The Z component of the coupler normal.

Extention extention

Float

The extention of the coupler.

getVehicle () → vehicle : Trace<RailroadVehicle>

Returns the vehicle this movement component holds the movement information of.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Vehicle
Return Values
Name Type Description

Vehicle vehicle

Trace<RailroadVehicle>

The vehicle this movement component holds the movement information of.

getWheelsetOffset (wheelset : Int) → offset : Float

Returns the offset of the wheelset with the given index from the start of the vehicle.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Wheelset Offset
Parameters
Name Type Description

Wheelset wheelset

Int

The index of the wheelset you want to get the offset of.
Return Values
Name Type Description

Offset offset

Float

The offset of the wheelset.

getWheelsetRotation (wheelset : Int) → (x : Float, y : Float, z : Float)

Returns the current rotation of the given wheelset.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Wheelset Rotation
Parameters
Name Type Description

Wheelset wheelset

Int

The index of the wheelset you want to get the rotation of.
Return Values
Name Type Description

X x

Float

The wheelset’s rotation X component.

Y y

Float

The wheelset’s rotation Y component.

Z z

Float

The wheelset’s rotation Z component.