FrameworkZ::Factions Class Reference

Factions module for FrameworkZ. Defines and interacts with FACTION object. More...

Public Member Functions
void	GetClassByID (factionID)
table	GetFactionByID (factionID)
	Get a faction by their ID.
string	GetFactionNameByID (factionID)
	Get a faction's name by their ID. Useful for getting a faction's actual name if the initialized faction ID differs from the name field.
string	Initialize (id, object)
	Initialize a faction.
table	New (name)
	Create a new faction object.

Data Fields
FrameworkZ Factions	__index
FrameworkZ	Factions
FrameworkZ Factions	List

Detailed Description

Factions module for FrameworkZ. Defines and interacts with FACTION object.

Definition at line 13 of file Factions.lua.

Member Function Documentation

GetClassByID()

void GetClassByID

(

factionID

)

GetFactionByID()

table GetFactionByID

(

factionID

)

Get a faction by their ID.

Parameters

factionID

string The faction's ID

Returns

table The faction's object.

GetFactionNameByID()

string GetFactionNameByID

(

factionID

)

Get a faction's name by their ID. Useful for getting a faction's actual name if the initialized faction ID differs from the name field.

Parameters

factionID

string The faction's ID.

Returns

string The faction's name.

Initialize()

string Initialize	(	id	,
		object	)

Initialize a faction.

Parameters

data	table The faction object's data.
name	string The faction's name (i.e. ID).

Returns

string The faction ID.

New()

table New

(

name

)

Create a new faction object.

Parameters

name	string Faction name.

Returns

table The new faction object.

Field Documentation

__index

FrameworkZ Factions __index

Definition at line 15 of file Factions.lua.

Factions

FrameworkZ Factions

Definition at line 19 of file Factions.lua.

List

FrameworkZ Factions List

Definition at line 17 of file Factions.lua.

---

The documentation for this class was generated from the following files:

• Factions.lua
• Sub_Classes.lua