SCR_FuelNode Interface Reference

Inheritance diagram for SCR_FuelNode:

Public Member Functions
bool	CanReceiveFuel ()
bool	CanProvideFuel ()
bool	HasExactTypeFlags (SCR_EFuelNodeTypeFlag typeFlag)
	Check if FuelNodeType enum is exactly the same as the nodeType enum.
bool	HasAllTypeFlags (SCR_EFuelNodeTypeFlag typeFlag)
	Check if FuelNodeType enum contains all the given fuel node type flags.
bool	HasAnyTypeFlag (SCR_EFuelNodeTypeFlag typeFlag)
	Check if FuelNodeType enum contains any of the given fuel node type flags.
int	GetFuelTankID ()
	Assigned fuel tank ID.
IEntity	GetOwner ()
	Owner entity of the fuel tank.
void	SetHealth (float health)
override void	OnFixedFrame (IEntity owner, float timeSlice)
	Fixed Frame Call in script.
ScriptInvokerFloat	GetOnFuelChanged ()
float	GetHealth ()
float	GetLeakableFuel ()
EFuelFlowCapacityOut	GetMaxFlowCapacityOut ()
EFuelFlowCapacityIn	GetMaxFlowCapacityIn ()
override void	OnInit (IEntity owner)
	Init call in script.
Public Member Functions inherited from BaseFuelNode
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.

Static Public Attributes
static ref ScriptInvoker	s_OnRefuelingFinished = new ScriptInvoker()

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

Protected Attributes
float	m_fInitialFuelTankState
EFuelFlowCapacityOut	m_MaxFlowCapacityOut
EFuelFlowCapacityIn	m_MaxFlowCapacityIn
int	m_iFuelLeakSpeed
SCR_EFuelNodeTypeFlag	m_eFuelNodeType
int	m_iFuelTankID
ref ScriptInvokerFloat	m_OnFuelChanged
float	m_fTimeSkip
IEntity	m_Owner
float	m_fHealth = 1
SignalsManagerComponent	m_SignalManagerComp
int	m_iSignalFuelStateIdx
int	m_iSignalIndexFuelTank
string	m_sSignalFuelState

Static Protected Attributes
const float	TIME_STEP = 1
const string	SIGNAL_FUEL_TANK_PREFIX = "fuel"
const string	SIGNAL_FUEL_TANK_ID = "fueltank"

Member Function Documentation

CanProvideFuel()

bool SCR_FuelNode.CanProvideFuel

(

)

Returns

true if fuel node can provide fuel

CanReceiveFuel()

bool SCR_FuelNode.CanReceiveFuel

(

)

Returns

true if fuel node can receive fuel

GetFuelTankID()

int SCR_FuelNode.GetFuelTankID

(

)

Assigned fuel tank ID.

GetHealth()

float SCR_FuelNode.GetHealth

(

)

Returns

GetLeakableFuel()

float SCR_FuelNode.GetLeakableFuel

(

)

Returns

GetMaxFlowCapacityIn()

EFuelFlowCapacityIn SCR_FuelNode.GetMaxFlowCapacityIn

(

)

Returns

GetMaxFlowCapacityOut()

EFuelFlowCapacityOut SCR_FuelNode.GetMaxFlowCapacityOut

(

)

Returns

GetOnFuelChanged()

ScriptInvokerFloat SCR_FuelNode.GetOnFuelChanged

(

)

Returns

GetOwner()

IEntity SCR_FuelNode.GetOwner

(

)

Owner entity of the fuel tank.

HasAllTypeFlags()

bool SCR_FuelNode.HasAllTypeFlags

(

SCR_EFuelNodeTypeFlag

typeFlag

)

Check if FuelNodeType enum contains all the given fuel node type flags.

Parameters

typeFlag

Queried flag types

Returns

true if FuelNode Type contains all required type flags

HasAnyTypeFlag()

bool SCR_FuelNode.HasAnyTypeFlag

(

SCR_EFuelNodeTypeFlag

typeFlag

)

Check if FuelNodeType enum contains any of the given fuel node type flags.

Parameters

typeFlag

Queried flag types

Returns

True if FuelNode Type contains any required type flag

HasExactTypeFlags()

bool SCR_FuelNode.HasExactTypeFlags

(

SCR_EFuelNodeTypeFlag

typeFlag

)

Check if FuelNodeType enum is exactly the same as the nodeType enum.

Parameters

typeFlag

Queried flag types

Returns

true if FuelNode Type contains the exact same flags, false otherwise

OnFixedFrame()

override void SCR_FuelNode.OnFixedFrame	(	IEntity	owner,
		float	timeSlice
	)

Fixed Frame Call in script.

Implements BaseFuelNode.

OnFuelChanged()

override void SCR_FuelNode.OnFuelChanged ( float  newFuel )

protected

Implements BaseFuelNode.

OnInit()

override void SCR_FuelNode.OnInit

(

IEntity

owner

)

Init call in script.

Implements BaseFuelNode.

SetHealth()

void SCR_FuelNode.SetHealth

(

float

health

)

Parameters

[in]

health

Member Data Documentation

m_eFuelNodeType

SCR_EFuelNodeTypeFlag SCR_FuelNode.m_eFuelNodeType

protected

m_fHealth

float SCR_FuelNode.m_fHealth = 1

protected

m_fInitialFuelTankState

float SCR_FuelNode.m_fInitialFuelTankState

protected

m_fTimeSkip

float SCR_FuelNode.m_fTimeSkip

protected

m_iFuelLeakSpeed

int SCR_FuelNode.m_iFuelLeakSpeed

protected

m_iFuelTankID

int SCR_FuelNode.m_iFuelTankID

protected

m_iSignalFuelStateIdx

int SCR_FuelNode.m_iSignalFuelStateIdx

protected

m_iSignalIndexFuelTank

int SCR_FuelNode.m_iSignalIndexFuelTank

protected

m_MaxFlowCapacityIn

EFuelFlowCapacityIn SCR_FuelNode.m_MaxFlowCapacityIn

protected

m_MaxFlowCapacityOut

EFuelFlowCapacityOut SCR_FuelNode.m_MaxFlowCapacityOut

protected

m_OnFuelChanged

ref ScriptInvokerFloat SCR_FuelNode.m_OnFuelChanged

protected

m_Owner

IEntity SCR_FuelNode.m_Owner

protected

m_SignalManagerComp

SignalsManagerComponent SCR_FuelNode.m_SignalManagerComp

protected

m_sSignalFuelState

string SCR_FuelNode.m_sSignalFuelState

protected

s_OnRefuelingFinished

ref ScriptInvoker SCR_FuelNode.s_OnRefuelingFinished = new ScriptInvoker()

static

SIGNAL_FUEL_TANK_ID

const string SCR_FuelNode.SIGNAL_FUEL_TANK_ID = "fueltank"

staticprotected

SIGNAL_FUEL_TANK_PREFIX

const string SCR_FuelNode.SIGNAL_FUEL_TANK_PREFIX = "fuel"

staticprotected

TIME_STEP

const float SCR_FuelNode.TIME_STEP = 1

staticprotected

---

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

• Game/Components/Fuel/SCR_FuelNode.c