FrameworkZ API Documentation - FrameworkZ.Factions

Home / FrameworkZ.Factions Module

FrameworkZ.Factions

module

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

0
Functions
5
Methods
1
Fields

📋 On This Page

Fields

1
FrameworkZ.Factions 📋 table
Factions module for FrameworkZ. Defines and interacts with FACTION object.
Initial value: {}

Methods

5

FrameworkZ.Factions:GetClassByID(factionID)

method undocumented
No documentation available

Parameters (inferred)

factionID ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Factions:GetFactionByID(factionID)

method
Get a faction by their ID.

Parameters

factionID 📝 string
The faction's ID

Returns

📋 table
The faction's object.

FrameworkZ.Factions:GetFactionNameByID(factionID)

method
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.

FrameworkZ.Factions:Initialize(id, object)

method
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.

FrameworkZ.Factions:New(name)

method
Create a new faction object.

Parameters

name 📝 string
Faction name.

Returns

📋 table
The new faction object.