FactionAffiliationComponent Interface Reference

Inheritance diagram for FactionAffiliationComponent:

Public Member Functions
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
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)

Member Function Documentation

GetAffiliatedFaction()

proto external Faction FactionAffiliationComponent.GetAffiliatedFaction

(

)

Returns the affiliated faction or null if none.

GetAffiliatedFactionKey()

proto external FactionKey FactionAffiliationComponent.GetAffiliatedFactionKey

(

)

GetDefaultAffiliatedFaction()

proto external Faction FactionAffiliationComponent.GetDefaultAffiliatedFaction

(

)

Returns the default affiliated faction or null if none.

GetDefaultFactionKey()

proto external FactionKey FactionAffiliationComponent.GetDefaultFactionKey

(

)

GetOwner()

proto external IEntity FactionAffiliationComponent.GetOwner

(

)

Returns the entity owning the component.

OnCompartmentEntered()

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

protected

Implemented in SCR_VehicleFactionAffiliationComponent.

OnCompartmentEntering()

void FactionAffiliationComponent.OnCompartmentEntering ( IEntity vehicle, IEntity occupant, BaseCompartmentSlot compartment, bool move )

protected

OnCompartmentLeft()

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

protected

Implemented in SCR_VehicleFactionAffiliationComponent.

OnFactionChanged()

void FactionAffiliationComponent.OnFactionChanged ( Faction previous, Faction current )

protected

Implemented in SCR_FactionAffiliationComponent.

OnPostInit()

void FactionAffiliationComponent.OnPostInit ( IEntity owner )

protected

Called after all components are initialized.

Parameters

owner

Entity this component is attached to.

Implemented in SCR_PlayerFactionAffiliationComponent, and SCR_VehicleFactionAffiliationComponent.

SetAffiliatedFaction()

proto external void FactionAffiliationComponent.SetAffiliatedFaction

(

Faction

faction

)

Sets the affiliated faction to the provided one or clears current one if null.

Parameters

faction

The new affiliated faction

SetAffiliatedFactionByKey()

proto external void FactionAffiliationComponent.SetAffiliatedFactionByKey

(

FactionKey

factionKey

)

Sets affiliated faction by the faction identifier as registered in FactionManager.

Invalid or empty key will clear the currently affiliated faction.

Parameters

factionKey

The identifier of the faction

---

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

• Game/generated/Components/FactionAffiliationComponent.c