Binding of RoR::Screwprop. More...

#include <ScrewpropClass.h>

Public Member Functions
void	setThrottle (float throttle)
	Sets the throttle.

void	setRudder (float rudderDeflection)
	Sets the rudder deflection.

float	getThrottle ()

float	getRudder ()

float	getMaxPower ()

bool	getReverse ()

void	toggleReverse ()

int	getRefNode ()

int	getBackNode ()

int	getUpNode ()

Detailed Description

Binding of RoR::Screwprop.

Contains information and control functions for a boat engine (screwprop).

Note: Obtain the object using BeamClass.getScrewprop(int index).

Definition at line 15 of file ScrewpropClass.h.

Member Function Documentation

◆ getBackNode()

int Script2Game::ScrewpropClass::getBackNode ( )

Returns: The node number for the back of the screwprop.

◆ getMaxPower()

float Script2Game::ScrewpropClass::getMaxPower ( )

Returns: The maximum force the screwprop can apply, in newtons.

◆ getRefNode()

int Script2Game::ScrewpropClass::getRefNode ( )

Returns: The reference node number.

◆ getReverse()

bool Script2Game::ScrewpropClass::getReverse ( )

Returns: Whether the screwprop is in reverse.

◆ getRudder()

float Script2Game::ScrewpropClass::getRudder ( )

Returns: The current rudder deflection. See setRudder(float rudderDeflection) for details.

◆ getThrottle()

float Script2Game::ScrewpropClass::getThrottle ( )

Returns: The current throttle value, from 0 to 1.

◆ getUpNode()

int Script2Game::ScrewpropClass::getUpNode ( )

Returns: The node number for the top of the screwprop.

◆ setRudder()

void Script2Game::ScrewpropClass::setRudder ( float rudderDeflection )

Sets the rudder deflection.

Parameters

rudderDeflection The rudder deflection, from -1 (full right deflection) to 1 (full left deflection).

◆ setThrottle()

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

Sets the throttle.