RigsofRods  2023.09
Soft-body Physics Simulation
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions
Script2Game::AircraftEngineClass Class Reference

Binding of RoR::AeroEngine. More...

#include <AircraftEngineClass.h>

Public Member Functions

void setThrottle (float throttle)
 Sets the throttle. More...
 
float getThrottle ()
 
void toggleReverse ()
 Toggles the thrust reversers. More...
 
void setReverse (bool reverse)
 Sets the thrust reverser status. More...
 
bool getReverse ()
 
void flipStart ()
 Toggles the engine ignition. More...
 
float getRPMPercent ()
 Gets the current RPM value, as a percentage. More...
 
bool isFailed ()
 
AircraftEngineTypes getType ()
 Gets the engine type. More...
 
bool getIgnition ()
 
int getFrontNode ()
 
int getBackNode ()
 
bool getWarmup ()
 

Detailed Description

Binding of RoR::AeroEngine.

Contains information and control functions for an aircraft engine (turbojet, propeller).

Note
Obtain the object using BeamClass.getAircraftEngine(int index).

Definition at line 15 of file AircraftEngineClass.h.

Member Function Documentation

◆ flipStart()

void Script2Game::AircraftEngineClass::flipStart ( )

Toggles the engine ignition.

◆ getBackNode()

int Script2Game::AircraftEngineClass::getBackNode ( )
Returns
The node number for the back of the engine, or 65535 (invalid node) if no node is set.

◆ getFrontNode()

int Script2Game::AircraftEngineClass::getFrontNode ( )
Returns
The node number for the front of the engine, or 65535 (invalid node) if no node is set.

◆ getIgnition()

bool Script2Game::AircraftEngineClass::getIgnition ( )
Returns
The ignition status.

◆ getReverse()

bool Script2Game::AircraftEngineClass::getReverse ( )
Returns
the thrust reverser status.

◆ getRPMPercent()

float Script2Game::AircraftEngineClass::getRPMPercent ( )

Gets the current RPM value, as a percentage.

◆ getThrottle()

float Script2Game::AircraftEngineClass::getThrottle ( )
Returns
The current throttle value, from 0 to 1.

◆ getType()

AircraftEngineTypes Script2Game::AircraftEngineClass::getType ( )

Gets the engine type.

◆ getWarmup()

bool Script2Game::AircraftEngineClass::getWarmup ( )
Returns
Whether the engine is warming up.

◆ isFailed()

bool Script2Game::AircraftEngineClass::isFailed ( )
Returns
Whether the engine has failed.

◆ setReverse()

void Script2Game::AircraftEngineClass::setReverse ( bool  reverse)

Sets the thrust reverser status.

◆ setThrottle()

void Script2Game::AircraftEngineClass::setThrottle ( float  throttle)

Sets the throttle.

Parameters
throttleRanges from 0 (idle thrust) to 1 (full thrust).

◆ toggleReverse()

void Script2Game::AircraftEngineClass::toggleReverse ( )

Toggles the thrust reversers.


The documentation for this class was generated from the following file: