ix.faction

Helper library for loading/getting faction information.

Functions

ix.faction.Get(identifier)

 View source »

Retrieves a faction table.

Parameters

  • identifier

    Index or name of the faction

Returns

Example Usage

print(ix.faction.Get(Entity(1):Team()).name)
 > "Citizen"

ix.faction.GetIndex(uniqueID)

 View source »

Retrieves a faction index.

Parameters

  • uniqueID string

    Unique ID of the faction

Returns

  • number

    Faction index

ix.faction.HasWhitelist(faction)

 View source »

Returns true if a faction requires a whitelist.

Parameters

  • faction number

    Index of the faction

Returns

  • bool

    Whether or not the faction requires a whitelist

ix.faction.LoadFromDir(directory)

 View source »

Loads factions from a directory.

Parameters

  • directory string

    The path to the factions files.