BaseFuelNode Interface Reference

Inheritance diagram for BaseFuelNode:

Public Member Functions
proto external void	SetShouldSimulate (bool value)
	Set whether or not this node should receive Fixed Frame calls.
proto external bool	ShouldSimulate ()
	Returns whether or not fixed frame calls are done on this node.
proto external void	SetFuel (float value)
	Set current amount of fuel in this fuel node.
proto external float	GetFuel ()
	Get current amount of fuel.
proto external float	GetMaxFuel ()
	Get max amount of fuel.
proto external EFuelType	GetFuelType ()
	Get type of fuel stored in this node.
proto external PointInfo	GetFuelCapPointInfo ()
	Returns the point info representing the fuel cap or null if none defined.

Protected Member Functions
void	OnInit (IEntity owner)
	Init call in script.
void	OnFixedFrame (IEntity owner, float timeSlice)
	Fixed Frame Call in script.
void	OnFuelChanged (float newFuel)

Member Function Documentation

GetFuel()

proto external float BaseFuelNode.GetFuel

(

)

Get current amount of fuel.

GetFuelCapPointInfo()

proto external PointInfo BaseFuelNode.GetFuelCapPointInfo

(

)

Returns the point info representing the fuel cap or null if none defined.

Returns

PointInfo instance or null if none.

GetFuelType()

proto external EFuelType BaseFuelNode.GetFuelType

(

)

Get type of fuel stored in this node.

GetMaxFuel()

proto external float BaseFuelNode.GetMaxFuel

(

)

Get max amount of fuel.

OnFixedFrame()

void BaseFuelNode.OnFixedFrame ( IEntity  owner, float  timeSlice  )

protected

Fixed Frame Call in script.

Implemented in SCR_FuelNode.

OnFuelChanged()

void BaseFuelNode.OnFuelChanged ( float  newFuel )

protected

Implemented in SCR_FuelNode.

OnInit()

void BaseFuelNode.OnInit ( IEntity  owner )

protected

Init call in script.

Implemented in SCR_FuelNode.

SetFuel()

proto external void BaseFuelNode.SetFuel

(

float

value

)

Set current amount of fuel in this fuel node.

SetShouldSimulate()

proto external void BaseFuelNode.SetShouldSimulate

(

bool

value

)

Set whether or not this node should receive Fixed Frame calls.

ShouldSimulate()

proto external bool BaseFuelNode.ShouldSimulate

(

)

Returns whether or not fixed frame calls are done on this node.

---

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

• Game/generated/UI/BaseFuelNode.c