Class Locomotive

Revision as of 06:16, 8 August 2008 (view source) Andi06 (Talk) (→‎Related Methods)

Revision as of 23:58, 3 February 2010 (view source) Windwalkr (Talk | contribs) m (1 revision) Newer edit →

---

Revision as of 23:58, 3 February 2010

• API Hierarchy
  • GSObject *
    • GameObject
      • TrainzGameObject
      • PropertyObject *
        • MeshObject
          • MapObject
            • Trackside
              • Vehicle
                • Locomotive

• A Locomotive is a specialised instance of a vehicle.
• In practice many of the methods in Class Vehicle apply to powered vehicles.
• A locomotive is always part of a train, if a locomotive is decoupled and left alone TRS will create a new consist to include it.

Contents 1 Methods 1.1 GetCabinData 1.2 GetEngineSetting 1.3 SetBrokenReverser 1.4 SetBrokenThrottle 1.5 SetCabinData 1.6 SetCompressorEfficiency 1.7 SetEngineSetting 1.8 SetHasDriver 2 Code Examples 3 Related Methods 4 Categories

Methods

GetCabinData

Parameters

• None

Returned Value

• A reference to a data object which stores the state of the locomotive's cabin.

Syntax

MyCabinData = loco.GetCabinData();

Notes

• See Class CabinData
• The data object refers to an internal private CabinData object in this class that represents the state of the cabin's controls.
• This is usually maintained by the Cabin.Attach() and Cabin.Update() methods of the Cabin script.

GetEngineSetting

Parameters

• setting = The name of the setting to retrieve.

Returned Value

• The value of the named setting.

Syntax

float throttle = GetEngineSetting("throttle");

Notes

• See SetEngineSetting() for details of the values which can be used for the setting parameter.

SetBrokenReverser

Parameters

• broken = If true the reverser will not function, a value of false will reactivate it.

Returned Value

• None

Syntax

SetBrokenReverser(ture); 

Notes

• When broken the reverser lever can still be used by the player but it will have no effect on the locomotive.

SetBrokenThrottle

Parameters

• broken = If true the throttle will not function, a value of false will reactivate it.

Returned Value

• None

Syntax

SetBrokenThrottle(true);

Notes

• When broken the throttle lever can still be used by the player but it will have no effect on the locomotive.

SetCabinData

Parameters

• data = A reference to the data object used to store details of the locomotive's cabin controls.

Returned Value

• None

Syntax

SetCabinData(MyCabinData);

Notes

• See Class CabinData
• The data object refers to an internal private CabinData object in this class that represents the state of the cabin's controls.
• This is usually maintained by the Cabin.Attach() and Cabin.Update() methods of the Cabin script.

SetCompressorEfficiency

Parameters

• efficiency = Efficiency of the compressor in the range 0.0 .. 1.0

Returned Value

• None

Syntax

SetCompressorEfficiency(0.5);

Notes

SetEngineSetting

Parameters

• setting = The name of the setting to save.
• value = The value of the named setting.

Returned Value

• None

Syntax

SetEngineSetting("regulator",0.5);

Notes

• Settings you can write to with this method are:
  • "dynamic-brake"
  • "headlight"
  • "injector"
  • "loco-auto-brake"
  • "pantograph"
  • "regulator"
  • "reverser"
  • "steam-blower"
  • "throttle"
  • "train-auto-brake"
  • "train-lap-brake"
• These strings correspond to engine properties as described in the Content Creation Guide.
• Some apply to steam locomotives only.

SetHasDriver

Parameters

• hasDriver = If true the locomotive has an assigned driver, if false it does not.

Returned Value

• None

Syntax

SetHasDriver(true);

Notes

• Only one locomotive in a train may have a driver.
• If you attempt to place a driver in this loco, any other driver on the train will be removed.
• The consist name and id will always stay with the driver.

Code Examples

Related Methods

Train.GetFrontmostLocomotive()
Train.GetVehicles()
World.GetVehicleList()

Categories