Inheritance diagram for SCR_FuelSupportStationComponent:

[legend]

Public Member Functions
override bool	IsValid (IEntity actionOwner, IEntity actionUser, SCR_BaseUseSupportStationAction action, vector actionPosition, out ESupportStationReasonInvalid reasonInvalid, out int supplyCost)
	Executed when action has been executed.

override ESupportStationType	GetSupportStationType ()
	Get Support station type.

override void	OnExecutedServer (notnull IEntity actionOwner, notnull IEntity actionUser, notnull SCR_BaseUseSupportStationAction action)
	Executed the support Station effect (Server only).

Public Member Functions inherited from SCR_BaseSupportStationComponent
void	OnExecutedServer (notnull IEntity actionOwner, notnull IEntity actionUser, notnull SCR_BaseUseSupportStationAction action)
	Executed the support Station effect (Server only).

bool	IsValid (IEntity actionOwner, IEntity actionUser, SCR_BaseUseSupportStationAction action, vector actionPosition, out ESupportStationReasonInvalid reasonInvalid, out int supplyCost)
	Executed when action has been executed.

ESupportStationType	GetSupportStationType ()
	Get Support station type.

ESupportStationPriority	GetSupportStationPriority ()
	Get Support station priority.

void	SetEnabled (bool enable)
	Set support station enabled.

bool	IsEnabled ()
	Get if support station is enabled.

ScriptInvoker	GetOnEnabledChanged ()
	Get scriptinvoker when support station is enabled changes.

SCR_Faction	GetFaction ()
	Get current faction of Support Station (Or if allowed get default faction)

int	GetMaxAvailableSupplies ()
	Scan for the max available supplies that can be used for the action.

bool	AreSuppliesEnabled ()
	Get if support station should check for supplies.

SCR_ResourceConsumer	GetResourceConsumer ()

float	GetRange ()
	Returns range.

bool	IsInRange (notnull IEntity actionOwner, vector actionPosition)
	param[in] actionOwner Owner of the support station action to check range of param[in] actionPosition Action position if the bounding box is not used or in valid to check range

bool	UsesRange ()
	If true then the action will use range, if false it will not use range and only execute if the action and the action manager is on the entity itself.

vector	GetPosition ()
	Get the center of the Support station that is used with range + offset.

vector	GetOffset ()

bool	IgnoreSelf ()
	If true and the action uses range it will never check itself.

LocalizedString	GetOverrideUserActionName ()

bool	OverrideDamageState (EDamageState damageState, bool checkIfHasDamageSystem)
	Allows devs to functionally destroy the Support station (or other state) without the need of a DamageManager.

override bool	RplSave (ScriptBitWriter writer)

override bool	RplLoad (ScriptBitReader reader)

override void	EOnInit (IEntity owner)

override void	OnPostInit (IEntity owner)

override void	OnDelete (IEntity owner)

Protected Member Functions
override void	DelayedInit (IEntity owner)

void	OnFuelAddedToVehicleServer (float fuelAmount, SCR_FuelNode nodeUsedForRefuel)

void	GetFuelNodeInfo (out float maxFlowCapacity, out SCR_FuelNode nodeUsedForRefuel, float actionDuration)

void	OnExecuteFuelBroadcast (RplId ownerId, RplId userId, int userPlayerId, float fuelTankFillPercentage, bool currentTankFull, int actionId)

void	OnExecuteFuel (IEntity actionOwner, IEntity actionUser, int playerId, float fuelPercentage, bool currentTankFull, SCR_BaseUseSupportStationAction action)

override void	OnExecute (IEntity actionOwner, IEntity actionUser, int playerId, SCR_BaseUseSupportStationAction action)
	Called by OnExecuteBroadcast and is executed both on server and on client playerId can be -1 if the user was not a player.

void	PlayRefuelUpdateSound (IEntity actionOwner, SCR_BaseUseSupportStationAction action)

Protected Member Functions inherited from SCR_BaseSupportStationComponent
void	FindEntityIds (IEntity owner, IEntity user, out RplId ownerId, out RplId userId, out int playerId)

void	GetEntitiesFromID (RplId ownerId, RplId userId, out IEntity owner, out IEntity user)

void	OnExecuteBroadcast (RplId ownerId, RplId userId, int userPlayerId, int actionId)

void	OnExecute (IEntity actionOwner, IEntity actionUser, int playerId, SCR_BaseUseSupportStationAction action)
	Called by OnExecuteBroadcast and is executed both on server and on client playerId can be -1 if the user was not a player.

void	OnSuccessfullyExecuted (IEntity actionOwner, IEntity actionUser, SCR_BaseUseSupportStationAction action)

void	PlaySoundEffect (SCR_AudioSourceConfiguration audioConfig, notnull IEntity soundOwner, SCR_BaseUseSupportStationAction action)

void	PlayCharacterVoiceEvent (IEntity character)

void	SetEnabledBroadcast (bool enable)

bool	IsMoving ()

bool	IsUserValidFaction (IEntity user)

int	GetSupplyCostAction (IEntity actionOwner, IEntity actionUser, SCR_BaseUseSupportStationAction action)
	Get the minimum amount of supplies needed for the action.

bool	HasEnoughSupplies (IEntity actionOwner, IEntity actionUser, int supplyAmountToCheck)

bool	OnConsumeSuppliesServer (int amount)
	Action is executed and supplies are used (Server Only)

SCR_ResourceComponent	GetResourceComponent ()

bool	GetSendNotificationOnUse ()

SCR_AudioSourceConfiguration	GetOnUseAudioConfig ()

void	GetPlayerIdsInVehicle (IEntity vehicle, out notnull array< int > playerIds)

void	OnHitZoneDamageStateChanged (SCR_HitZone defaultHitZone)
	Called when default hitZone damage state changed. Not called if entity has a damage manager.

void	OnDamageStateChanged (EDamageState damageState)
	Called when damage manager (or default hitZone) damage state changes.

void	AddRemoveOnDamageStateChanged (IEntity owner, bool subscribe)
	Grabs either damage manager or HitZoneContainer to subscribe to OnDamageStateChanged.

bool	InitValidSetup ()

void	TEMP_OnInteractorReplicated ()

void	DelayedInit (IEntity owner)

Protected Attributes
EFuelFlowCapacityOut	m_BackupMaxFlowCapacity

ESupportStationReasonInvalid	m_EmptyInvalidReason

SCR_FuelManagerComponent	m_SupportStationFuelManager

Protected Attributes inherited from SCR_BaseSupportStationComponent
ESupportStationPriority	m_eSupportStationPriority

float	m_fRange

bool	m_bUseRangeBoundingBox

bool	m_bIsEnabled

int	m_iBaseSupplyCostOnUse

bool	m_bIgnoreSelf

vector	m_vOffset

ESupportStationFactionUsage	m_eFactionUsageCheck

LocalizedString	m_sOverrideUserActionName

SCR_ResourceConsumer	m_ResourceConsumer

ref ScriptInvoker	Event_OnEnabledChanged

Physics	m_Physics

EDamageState	m_eCurrentDamageState = EDamageState.UNDAMAGED

FactionAffiliationComponent	m_FactionAffiliationComponent

SCR_ServicePointComponent	m_ServicePointComponent

SCR_ResourceSystemSubscriptionHandleBase	m_ResourceSubscriptionHandleConsumer

Additional Inherited Members
Static Public Member Functions inherited from SCR_BaseSupportStationComponent
static SCR_BaseSupportStationComponent	FindSupportStation (notnull IEntity entity, SCR_ESupportStationResupplyType type=SCR_ESupportStationResupplyType.NONE, SCR_EComponentFinderQueryFlags queryFlags=SCR_EComponentFinderQueryFlags.ENTITY\|SCR_EComponentFinderQueryFlags.SLOTS)
	Get support station from entity.

Member Function Documentation

◆ DelayedInit()

override void SCR_FuelSupportStationComponent.DelayedInit ( IEntity owner )

protected

Implements SCR_BaseSupportStationComponent.

◆ GetFuelNodeInfo()

void SCR_FuelSupportStationComponent.GetFuelNodeInfo	(	out float	maxFlowCapacity,
		out SCR_FuelNode	nodeUsedForRefuel,
		float	actionDuration
	)

protected

◆ GetSupportStationType()

override ESupportStationType SCR_FuelSupportStationComponent.GetSupportStationType ( )

Get Support station type.

Returns: type of support station

Implements SCR_BaseSupportStationComponent.

◆ IsValid()

override bool SCR_FuelSupportStationComponent.IsValid	(	IEntity	actionOwner,
		IEntity	actionUser,
		SCR_BaseUseSupportStationAction	action,
		vector	actionPosition,
		out ESupportStationReasonInvalid	reasonInvalid,
		out int	supplyCost
	)

Executed when action has been executed.

Here you can execute things such as removing supplies/fuel from the entity

Parameters

[in]	actionOwner	entity on which the ActionManager is
[in]	actionUser	Entity that started the interaction
[in]	action
[in]	actionPosition
[out]	reasonInvalid	Reason why action is invalid
[out]	supplyCost	cost when using the support station

Returns

Implements SCR_BaseSupportStationComponent.

◆ OnExecute()

override void SCR_FuelSupportStationComponent.OnExecute	(	IEntity	actionOwner,
		IEntity	actionUser,
		int	playerId,
		SCR_BaseUseSupportStationAction	action
	)

protected

Called by OnExecuteBroadcast and is executed both on server and on client playerId can be -1 if the user was not a player.

Implements SCR_BaseSupportStationComponent.

◆ OnExecutedServer()

override void SCR_FuelSupportStationComponent.OnExecutedServer	(	notnull IEntity	actionOwner,
		notnull IEntity	actionUser,
		notnull SCR_BaseUseSupportStationAction	action
	)

Executed the support Station effect (Server only).

Here you can execute things such as removing supplies/fuel from the entity

Parameters

[in]	actionOwner	entity that is the owner of the ActionManager which initiated the action
[in]	actionUser	Entity that started the interaction to use the support station
[in]	action

Implements SCR_BaseSupportStationComponent.

◆ OnExecuteFuel()

void SCR_FuelSupportStationComponent.OnExecuteFuel	(	IEntity	actionOwner,
		IEntity	actionUser,
		int	playerId,
		float	fuelPercentage,
		bool	currentTankFull,
		SCR_BaseUseSupportStationAction	action
	)

protected

◆ OnExecuteFuelBroadcast()

void SCR_FuelSupportStationComponent.OnExecuteFuelBroadcast	(	RplId	ownerId,
		RplId	userId,
		int	userPlayerId,
		float	fuelTankFillPercentage,
		bool	currentTankFull,
		int	actionId
	)

protected

◆ OnFuelAddedToVehicleServer()

void SCR_FuelSupportStationComponent.OnFuelAddedToVehicleServer	(	float	fuelAmount,
		SCR_FuelNode	nodeUsedForRefuel
	)

protected

◆ PlayRefuelUpdateSound()

void SCR_FuelSupportStationComponent.PlayRefuelUpdateSound	(	IEntity	actionOwner,
		SCR_BaseUseSupportStationAction	action
	)

protected

Member Data Documentation

◆ m_BackupMaxFlowCapacity

EFuelFlowCapacityOut SCR_FuelSupportStationComponent.m_BackupMaxFlowCapacity

protected

◆ m_EmptyInvalidReason

ESupportStationReasonInvalid SCR_FuelSupportStationComponent.m_EmptyInvalidReason

protected

◆ m_SupportStationFuelManager

SCR_FuelManagerComponent SCR_FuelSupportStationComponent.m_SupportStationFuelManager

protected

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

Game/Components/SupportStation/SCR_FuelSupportStationComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ DelayedInit()

◆ GetFuelNodeInfo()

◆ GetSupportStationType()

◆ IsValid()

◆ OnExecute()

◆ OnExecutedServer()

◆ OnExecuteFuel()

◆ OnExecuteFuelBroadcast()

◆ OnFuelAddedToVehicleServer()

◆ PlayRefuelUpdateSound()

Member Data Documentation

◆ m_BackupMaxFlowCapacity

◆ m_EmptyInvalidReason

◆ m_SupportStationFuelManager