WsfScriptFuelClass Class Reference

Define script methods for WsfFuel. More...

#include <WsfScriptFuelClass.hpp>

Inheritance diagram for WsfScriptFuelClass:

Collaboration diagram for WsfScriptFuelClass:

Public Member Functions
	WsfScriptFuelClass (const std::string &aClassName, UtScriptTypes *aTypesPtr)
	UT_DECLARE_SCRIPT_METHOD (CurrentMode)
	UT_DECLARE_SCRIPT_METHOD (SelectMode)
	UT_DECLARE_SCRIPT_METHOD (Refuel_1)
	UT_DECLARE_SCRIPT_METHOD (Refuel_2)
	UT_DECLARE_SCRIPT_METHOD (QuantityRemaining)
	UT_DECLARE_SCRIPT_METHOD (QuantityRequired_1)
	UT_DECLARE_SCRIPT_METHOD (QuantityRequired_2)
	UT_DECLARE_SCRIPT_METHOD (QuantityRequired_3)
	UT_DECLARE_SCRIPT_METHOD (SetQuantityRemaining)
	UT_DECLARE_SCRIPT_METHOD (ConsumptionRate_1)
	UT_DECLARE_SCRIPT_METHOD (ConsumptionRate_2)
	UT_DECLARE_SCRIPT_METHOD (SetConsumptionRate)
	UT_DECLARE_SCRIPT_METHOD (MaximumQuantity)
	UT_DECLARE_SCRIPT_METHOD (SetMaximumQuantity)
	UT_DECLARE_SCRIPT_METHOD (InitialQuantity)
	UT_DECLARE_SCRIPT_METHOD (SetInitialQuantity)
	UT_DECLARE_SCRIPT_METHOD (BingoQuantity)
	UT_DECLARE_SCRIPT_METHOD (SetBingoQuantity)
	UT_DECLARE_SCRIPT_METHOD (ReserveQuantity)
	UT_DECLARE_SCRIPT_METHOD (SetReserveQuantity)
	UT_DECLARE_SCRIPT_METHOD (TimeAtBingo_1)
	UT_DECLARE_SCRIPT_METHOD (TimeAtBingo_2)
	UT_DECLARE_SCRIPT_METHOD (TimeAtReserve_1)
	UT_DECLARE_SCRIPT_METHOD (TimeAtReserve_2)
	UT_DECLARE_SCRIPT_METHOD (TimeToBingo_1)
	UT_DECLARE_SCRIPT_METHOD (TimeToBingo_2)
	UT_DECLARE_SCRIPT_METHOD (TimeToReserve_1)
	UT_DECLARE_SCRIPT_METHOD (TimeToReserve_2)
	UT_DECLARE_SCRIPT_METHOD (TimeToEmpty_1)
	UT_DECLARE_SCRIPT_METHOD (TimeToEmpty_2)
	UT_DECLARE_SCRIPT_METHOD (DistanceAtBingo_1)
	UT_DECLARE_SCRIPT_METHOD (DistanceAtBingo_2)
	UT_DECLARE_SCRIPT_METHOD (DistanceAtReserve_1)
	UT_DECLARE_SCRIPT_METHOD (DistanceAtReserve_2)
	UT_DECLARE_SCRIPT_METHOD (DistanceToBingo_1)
	UT_DECLARE_SCRIPT_METHOD (DistanceToBingo_2)
	UT_DECLARE_SCRIPT_METHOD (DistanceToReserve_1)
	UT_DECLARE_SCRIPT_METHOD (DistanceToReserve_2)
	UT_DECLARE_SCRIPT_METHOD (DistanceToEmpty_1)
	UT_DECLARE_SCRIPT_METHOD (DistanceToEmpty_2)
Public Member Functions inherited from WsfScriptPlatformPartClass
	WsfScriptPlatformPartClass (const std::string &aClassName, UtScriptTypes *aScriptTypesPtr)
void	OnNewScriptRef (UtScriptRef &aReference) override
	UT_DECLARE_SCRIPT_METHOD (Platform)
	UT_DECLARE_SCRIPT_METHOD (IsNonOperational)
	UT_DECLARE_SCRIPT_METHOD (IsOperational)
	UT_DECLARE_SCRIPT_METHOD (SetOperational)
	UT_DECLARE_SCRIPT_METHOD (IsNonCritical)
	UT_DECLARE_SCRIPT_METHOD (IsCritical)
	UT_DECLARE_SCRIPT_METHOD (SetCritical)
	UT_DECLARE_SCRIPT_METHOD (IsTurnedOff)
	UT_DECLARE_SCRIPT_METHOD (IsTurnedOn)
	UT_DECLARE_SCRIPT_METHOD (InitiallyTurnedOn)
	UT_DECLARE_SCRIPT_METHOD (TimeSinceLastStatusChange)
	UT_DECLARE_SCRIPT_METHOD (SendMessage_1)
	UT_DECLARE_SCRIPT_METHOD (SendMessage_2)
	UT_DECLARE_SCRIPT_METHOD (SendMessageToProcessor)
	UT_DECLARE_SCRIPT_METHOD (SetDebugEnabled)
	UT_DECLARE_SCRIPT_METHOD (DebugEnabled)
	UT_DECLARE_SCRIPT_METHOD (SetDamageFactor)
	UT_DECLARE_SCRIPT_METHOD (DamageFactor)
	UT_DECLARE_SCRIPT_METHOD (CanBeMadeOperational)
	UT_DECLARE_SCRIPT_METHOD (CanBeMadeNonOperational)
	UT_DECLARE_SCRIPT_METHOD (CanBeTurnedOn)
	UT_DECLARE_SCRIPT_METHOD (CanBeTurnedOff)
	UT_DECLARE_SCRIPT_METHOD (CategoryMemberOf)
	UT_DECLARE_SCRIPT_METHOD (GroupMemberOf_1)
	UT_DECLARE_SCRIPT_METHOD (GroupMemberOf_2)
	UT_DECLARE_SCRIPT_METHOD (GroupMemberOf_3)
	UT_DECLARE_SCRIPT_METHOD (GetGroupByIndex)
	UT_DECLARE_SCRIPT_METHOD (GetGroupByName)
	UT_DECLARE_SCRIPT_METHOD (GroupsByName)
	UT_DECLARE_SCRIPT_METHOD (Groups)
	UT_DECLARE_SCRIPT_METHOD (GroupJoin)
	UT_DECLARE_SCRIPT_METHOD (GroupLeave)
Public Member Functions inherited from WsfScriptObjectClass
	WsfScriptObjectClass (const std::string &aClassName, UtScriptTypes *aTypesPtr)
	~WsfScriptObjectClass () override
void *	Create (const UtScriptContext &aInstance) override
void *	Clone (void *aObjectPtr) override
void	Destroy (void *aObjectPtr) override
std::string	ToString (void *aObjectPtr) const override
	UT_DECLARE_SCRIPT_METHOD (Name)
	UT_DECLARE_SCRIPT_METHOD (Type)
	UT_DECLARE_SCRIPT_METHOD (BaseType)
	UT_DECLARE_SCRIPT_METHOD (IsA_TypeOf)
	UT_DECLARE_SCRIPT_METHOD (ProcessInput)

Detailed Description

Define script methods for WsfFuel.

Constructor & Destructor Documentation

WsfScriptFuelClass()

WsfScriptFuelClass::WsfScriptFuelClass	(	const std::string &	aClassName,
		UtScriptTypes *	aTypesPtr )

References WsfScriptPlatformPartClass::WsfScriptPlatformPartClass().

Member Function Documentation

UT_DECLARE_SCRIPT_METHOD() [1/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

BingoQuantity

)

UT_DECLARE_SCRIPT_METHOD() [2/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

ConsumptionRate_1

)

UT_DECLARE_SCRIPT_METHOD() [3/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

ConsumptionRate_2

)

UT_DECLARE_SCRIPT_METHOD() [4/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

CurrentMode

)

UT_DECLARE_SCRIPT_METHOD() [5/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

DistanceAtBingo_1

)

UT_DECLARE_SCRIPT_METHOD() [6/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

DistanceAtBingo_2

)

UT_DECLARE_SCRIPT_METHOD() [7/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

DistanceAtReserve_1

)

UT_DECLARE_SCRIPT_METHOD() [8/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

DistanceAtReserve_2

)

UT_DECLARE_SCRIPT_METHOD() [9/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

DistanceToBingo_1

)

UT_DECLARE_SCRIPT_METHOD() [10/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

DistanceToBingo_2

)

UT_DECLARE_SCRIPT_METHOD() [11/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

DistanceToEmpty_1

)

UT_DECLARE_SCRIPT_METHOD() [12/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

DistanceToEmpty_2

)

UT_DECLARE_SCRIPT_METHOD() [13/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

DistanceToReserve_1

)

UT_DECLARE_SCRIPT_METHOD() [14/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

DistanceToReserve_2

)

UT_DECLARE_SCRIPT_METHOD() [15/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

InitialQuantity

)

UT_DECLARE_SCRIPT_METHOD() [16/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

MaximumQuantity

)

UT_DECLARE_SCRIPT_METHOD() [17/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

QuantityRemaining

)

UT_DECLARE_SCRIPT_METHOD() [18/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

QuantityRequired_1

)

UT_DECLARE_SCRIPT_METHOD() [19/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

QuantityRequired_2

)

UT_DECLARE_SCRIPT_METHOD() [20/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

QuantityRequired_3

)

UT_DECLARE_SCRIPT_METHOD() [21/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

Refuel_1

)

UT_DECLARE_SCRIPT_METHOD() [22/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

Refuel_2

)

UT_DECLARE_SCRIPT_METHOD() [23/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

ReserveQuantity

)

UT_DECLARE_SCRIPT_METHOD() [24/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

SelectMode

)

UT_DECLARE_SCRIPT_METHOD() [25/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

SetBingoQuantity

)

UT_DECLARE_SCRIPT_METHOD() [26/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

SetConsumptionRate

)

UT_DECLARE_SCRIPT_METHOD() [27/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

SetInitialQuantity

)

UT_DECLARE_SCRIPT_METHOD() [28/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

SetMaximumQuantity

)

UT_DECLARE_SCRIPT_METHOD() [29/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

SetQuantityRemaining

)

UT_DECLARE_SCRIPT_METHOD() [30/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

SetReserveQuantity

)

UT_DECLARE_SCRIPT_METHOD() [31/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

TimeAtBingo_1

)

UT_DECLARE_SCRIPT_METHOD() [32/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

TimeAtBingo_2

)

UT_DECLARE_SCRIPT_METHOD() [33/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

TimeAtReserve_1

)

UT_DECLARE_SCRIPT_METHOD() [34/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

TimeAtReserve_2

)

UT_DECLARE_SCRIPT_METHOD() [35/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

TimeToBingo_1

)

UT_DECLARE_SCRIPT_METHOD() [36/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

TimeToBingo_2

)

UT_DECLARE_SCRIPT_METHOD() [37/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

TimeToEmpty_1

)

UT_DECLARE_SCRIPT_METHOD() [38/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

TimeToEmpty_2

)

UT_DECLARE_SCRIPT_METHOD() [39/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

TimeToReserve_1

)

UT_DECLARE_SCRIPT_METHOD() [40/40]

WsfScriptFuelClass::UT_DECLARE_SCRIPT_METHOD

(

TimeToReserve_2

)

---

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

• WsfScriptFuelClass.hpp
• WsfScriptFuelClass.cpp