Faction Interface Reference

Inheritance diagram for Faction:

Public Member Functions
proto external FactionIdentity	GetFactionIdentity ()
proto external bool	IsFactionFriendly (Faction otherFaction)
	Returns true if this faction and other faction are friendly.
proto external bool	IsFactionEnemy (Faction otherFaction)
	Returns true if this faction and other faction are hostile.
proto external string	GetFactionName ()
	Returns the name of this faction for via this Faction's UI Info.
proto external FactionKey	GetFactionKey ()
	Returns the identifier of this faction specified in FactionManager.
proto ref Color	GetFactionColor ()
	Returns the color of this faction specified in FactionManager.
proto external UIInfo	GetUIInfo ()
	Returns the UI info of this faction.
proto external string	GetFactionRadioEncryptionKey ()
	Returns the encryption key used for radio transmissions.

Member Function Documentation

GetFactionColor()

proto ref Color Faction.GetFactionColor

(

)

Returns the color of this faction specified in FactionManager.

GetFactionIdentity()

proto external FactionIdentity Faction.GetFactionIdentity

(

)

GetFactionKey()

proto external FactionKey Faction.GetFactionKey

(

)

Returns the identifier of this faction specified in FactionManager.

GetFactionName()

proto external string Faction.GetFactionName

(

)

Returns the name of this faction for via this Faction's UI Info.

GetFactionRadioEncryptionKey()

proto external string Faction.GetFactionRadioEncryptionKey

(

)

Returns the encryption key used for radio transmissions.

GetUIInfo()

proto external UIInfo Faction.GetUIInfo

(

)

Returns the UI info of this faction.

IsFactionEnemy()

proto external bool Faction.IsFactionEnemy

(

Faction

otherFaction

)

Returns true if this faction and other faction are hostile.

IsFactionFriendly()

proto external bool Faction.IsFactionFriendly

(

Faction

otherFaction

)

Returns true if this faction and other faction are friendly.

---

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

• Game/generated/Faction/Faction.c