SCR_VehicleFactionAffiliationComponent Interface Reference

Inheritance diagram for SCR_VehicleFactionAffiliationComponent:

Public Member Functions
override void	OnPostInit (IEntity owner)
	Called after all components are initialized.
bool	IsVehicleOccupied ()
	Check if there are any occupants regardless of life state.
bool	IsVehicleActive ()
	Check if there are any conscious and alive occupants among the occupants.
void	UpdateOccupantsCount (IEntity ignoreOccupant=null)
void	OnOccupantLifeStateChanged (ECharacterLifeState previousLifeState, ECharacterLifeState newLifeState)
Public Member Functions inherited from SCR_FactionAffiliationComponent
void	ClearAffiliatedFaction ()
ScriptInvoker	GetOnFactionUpdate ()
OnFactionChangedInvoker	GetOnFactionChanged ()
Public Member Functions inherited from FactionAffiliationComponent
proto external IEntity	GetOwner ()
	Returns the entity owning the component.
proto external Faction	GetAffiliatedFaction ()
	Returns the affiliated faction or null if none.
proto external Faction	GetDefaultAffiliatedFaction ()
	Returns the default affiliated faction or null if none.
proto external void	SetAffiliatedFaction (Faction faction)
	Sets the affiliated faction to the provided one or clears current one if null.
proto external void	SetAffiliatedFactionByKey (FactionKey factionKey)
	Sets affiliated faction by the faction identifier as registered in FactionManager.
proto external FactionKey	GetDefaultFactionKey ()
proto external FactionKey	GetAffiliatedFactionKey ()
Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Protected Member Functions
override void	OnCompartmentEntered (IEntity vehicle, IEntity occupant, BaseCompartmentSlot compartment, bool move)
override void	OnCompartmentLeft (IEntity vehicle, IEntity occupant, BaseCompartmentSlot compartment, bool move)
Protected Member Functions inherited from SCR_FactionAffiliationComponent
override void	OnFactionChanged (Faction previous, Faction current)
Protected Member Functions inherited from FactionAffiliationComponent
void	OnPostInit (IEntity owner)
	Called after all components are initialized.
void	OnCompartmentEntering (IEntity vehicle, IEntity occupant, BaseCompartmentSlot compartment, bool move)
void	OnCompartmentEntered (IEntity vehicle, IEntity occupant, BaseCompartmentSlot compartment, bool move)
void	OnCompartmentLeft (IEntity vehicle, IEntity occupant, BaseCompartmentSlot compartment, bool move)
void	OnFactionChanged (Faction previous, Faction current)

Protected Attributes
int	m_iOccupantCount
int	m_iAliveOccupantCount

Additional Inherited Members
Static Public Member Functions inherited from SCR_FactionAffiliationComponent
static void	SetFaction (IEntity owner, Faction faction)
	Set faction.

Member Function Documentation

IsVehicleActive()

bool SCR_VehicleFactionAffiliationComponent.IsVehicleActive

(

)

Check if there are any conscious and alive occupants among the occupants.

IsVehicleOccupied()

bool SCR_VehicleFactionAffiliationComponent.IsVehicleOccupied

(

)

Check if there are any occupants regardless of life state.

OnCompartmentEntered()

override void SCR_VehicleFactionAffiliationComponent.OnCompartmentEntered ( IEntity  vehicle, IEntity  occupant, BaseCompartmentSlot  compartment, bool  move  )

protected

Implements FactionAffiliationComponent.

OnCompartmentLeft()

override void SCR_VehicleFactionAffiliationComponent.OnCompartmentLeft ( IEntity  vehicle, IEntity  occupant, BaseCompartmentSlot  compartment, bool  move  )

protected

Implements FactionAffiliationComponent.

OnOccupantLifeStateChanged()

void SCR_VehicleFactionAffiliationComponent.OnOccupantLifeStateChanged	(	ECharacterLifeState	previousLifeState,
		ECharacterLifeState	newLifeState
	)

OnPostInit()

override void SCR_VehicleFactionAffiliationComponent.OnPostInit

(

IEntity

owner

)

Called after all components are initialized.

Parameters

owner

Entity this component is attached to.

Implements FactionAffiliationComponent.

UpdateOccupantsCount()

void SCR_VehicleFactionAffiliationComponent.UpdateOccupantsCount

(

IEntity

ignoreOccupant = null

)

Member Data Documentation

m_iAliveOccupantCount

int SCR_VehicleFactionAffiliationComponent.m_iAliveOccupantCount

protected

m_iOccupantCount

int SCR_VehicleFactionAffiliationComponent.m_iOccupantCount

protected

---

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

• Game/Vehicle/SCR_VehicleFactionAffiliationComponent.c