Factions module for FrameworkZ. Defines and interacts with FACTION object.
More...
|
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.
|
|
Factions module for FrameworkZ. Defines and interacts with FACTION object.
Definition at line 25 of file Factions.lua.
◆ 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()
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()
Create a new faction object.
- Parameters
-
- Returns
- table The new faction object.
◆ __index
◆ Factions
◆ List
The documentation for this class was generated from the following files: