Faction Fields
This document describes all the configurable FACTION
fields available in the codebase, with their descriptions and example usages.
Unspecified fields will use sensible defaults.
Overview
Each faction in the game is defined by a set of fields on the global FACTION
table. These fields control everything from display name and lore, to starting weapons and player statistics. All fields are optional; unspecified fields will fall back to sensible defaults.
Field Summary
Field | Type | Default | Description |
---|---|---|---|
name |
string |
"Unknown" |
Display name shown to players. |
desc |
string |
"No Description" |
Lore or descriptive text. |
isDefault |
boolean |
true |
Whether the faction is available without whitelist. |
color |
Color |
Color(255,255,255) |
UI color representing the faction. |
models |
table |
DefaultModels |
Available player model paths. |
uniqueID |
string |
filename |
Internal string identifier. |
weapons |
table |
{} |
Automatically granted weapons. |
items |
table |
{} |
Automatically granted items. |
index |
number |
auto |
Numeric ID assigned at registration time. |
pay |
number |
0 |
Payment amount per interval. |
payLimit |
number |
0 |
Maximum accumulated pay. |
payTimer |
number |
300 |
Interval (in seconds) between paychecks. |
limit |
number |
0 |
Maximum number of players in the faction. |
oneCharOnly |
boolean |
false |
Restrict players to one character only. |
health |
number |
0 |
Starting health. |
armor |
number |
0 |
Starting armor. |
scale |
number |
1 |
Player model scale multiplier. |
runSpeed |
number |
0 |
Base running speed. |
runSpeedMultiplier |
boolean |
false |
Multiply base speed instead of replacing it. |
walkSpeed |
number |
0 |
Base walking speed. |
walkSpeedMultiplier |
boolean |
false |
Multiply base walk speed instead of replacing it. |
jumpPower |
number |
0 |
Base jump power. |
jumpPowerMultiplier |
boolean |
false |
Multiply base jump power instead of replacing it. |
MemberToMemberAutoRecognition |
boolean |
false |
Auto-recognition among faction members. |
bloodcolor |
number |
0 |
Blood color enum. |
bodyGroups |
table |
{} |
Bodygroup name→index mapping applied on spawn. |
NPCRelations |
table |
{} |
NPC class→disposition mapping on spawn/creation. |
RecognizesGlobally |
boolean |
false |
Global player recognition. |
ScoreboardHidden |
boolean |
false |
Hide members from the scoreboard. |
Field Details
Basic Info
name
Type:
string
Description:
Display name shown for members of this faction.
Example Usage:
desc
Type:
string
Description:
Lore or descriptive text about the faction.
Example Usage:
isDefault
Type:
boolean
Description:
Set to true
if players may select this faction without a whitelist.
Example Usage:
uniqueID
Type:
string
Description:
Internal string identifier for referencing the faction.
Example Usage:
index
Type:
number
Description:
Numeric identifier assigned during faction registration.
Example Usage:
Appearance & Models
color
Type:
Color
Description:
Color used in UI elements to represent the faction. Defaults to Color(255, 255, 255)
if not specified.
Example Usage:
models
Type:
table
Description:
Table of player model paths available to faction members.
Example Usage:
bodyGroups
Type:
table
Description:
Mapping of bodygroup names to index values applied on spawn.
Example Usage:
Economy & Limits
weapons
Type:
table
Description:
Weapons automatically granted on spawn.
Example Usage:
items
Type:
table
Description:
Item uniqueIDs automatically granted on character creation.
Example Usage:
pay
Type:
number
Description:
Payment amount for members each interval.
Example Usage:
payLimit
Type:
number
Description:
Maximum pay a member can accumulate.
Example Usage:
payTimer
Type:
number
Description:
Interval in seconds between salary payouts.
Example Usage:
limit
Type:
number
Description:
Maximum number of players allowed in this faction.
Example Usage:
oneCharOnly
Type:
boolean
Description:
If true
, players may only create one character in this faction.
Example Usage:
Movement & Stats
health
Type:
number
Description:
Starting health for faction members.
Example Usage:
armor
Type:
number
Description:
Starting armor for faction members.
Example Usage:
scale
Type:
number
Description:
Player model scale multiplier.
Example Usage:
runSpeed
Type:
number
Description:
Base running speed.
Example Usage:
runSpeedMultiplier
Type:
boolean
Description:
If true
, multiplies the base speed rather than replacing it.
Example Usage:
walkSpeed
Type:
number
Description:
Base walking speed.
Example Usage:
walkSpeedMultiplier
Type:
boolean
Description:
If true
, multiplies the base walk speed rather than replacing it.
Example Usage:
jumpPower
Type:
number
Description:
Base jump power.
Example Usage:
jumpPowerMultiplier
Type:
boolean
Description:
If true
, multiplies the base jump power rather than replacing it.
Example Usage:
Recognition & Relations
MemberToMemberAutoRecognition
Type:
boolean
Description:
Whether faction members automatically recognize each other on sight.
Example Usage:
RecognizesGlobally
Type:
boolean
Description:
If true
, members recognize all players globally, regardless of faction.
Example Usage:
NPCRelations
Type:
table
Description:
Mapping of NPC class names to disposition constants (D_HT
, D_LI
, etc.). NPCs are updated on spawn/creation.
Example Usage:
bloodcolor
Type:
number
Description:
Blood color enumeration constant for faction members.
Example Usage:
ScoreboardHidden
Type:
boolean
Description:
If true
, members of this faction are hidden from the scoreboard.
Example Usage: