SCR_FactionAffiliationComponent Interface Reference

Inheritance diagram for SCR_FactionAffiliationComponent:

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

Static Public Member Functions
static void	SetFaction (IEntity owner, Faction faction)
	Set faction.

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

Member Function Documentation

ClearAffiliatedFaction()

void SCR_FactionAffiliationComponent.ClearAffiliatedFaction

(

)

GetOnFactionChanged()

OnFactionChangedInvoker SCR_FactionAffiliationComponent.GetOnFactionChanged

(

)

Returns

GetOnFactionUpdate()

ScriptInvoker SCR_FactionAffiliationComponent.GetOnFactionUpdate

(

)

Returns

OnFactionChanged()

override void SCR_FactionAffiliationComponent.OnFactionChanged ( Faction  previous, Faction  current  )

protected

Implements FactionAffiliationComponent.

SetFaction()

static void SCR_FactionAffiliationComponent.SetFaction ( IEntity  owner, Faction  faction  )

static

Set faction.

Parameters

[in]	owner
[in]	faction	the desired faction

---

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

• Game/Components/SCR_FactionAffiliationComponent.c