Class Generator

Create sub-roles and specialized classes for your factions, such as 'Medic' or 'Officer'.

---

Overview

Use this tool to generate the Lua structure for your custom class. Once generated, the code should be placed in a new file within your schema's classes directory.

Recommended Placement:

garrysmod/gamemodes/[schema folder]/schema/classes/[class_name].lua

---

Class Index: The unique identifier for this class (e.g., CLASS_POLICEOFFICER)

Faction Index: The faction index this class belongs to (e.g., FACTION_POLICE)

Class Name:

Description:

Whitelist Required Joining requires an admin to grant access via /classwhitelist. Has no effect if Is Default is also set.

Is Default Class Automatically assigned to new characters in this faction. Only one class per faction should have this set.

Player Limit: Max concurrent players in this class. 0 = unlimited.

Model:

+ Add Model Model path(s). A single entry defaults to that model automatically; multiple entries let players choose one in the classes menu.

Color (R,G,B):

Comma-separated RGB values (0-255). Leave empty to use faction color.

Skin: Skin index applied to the class model preview. Default is 0.

Default Bodygroups:

+ Add Bodygroup Bodygroup values forcibly applied to a character each time they spawn in this class. Each entry is a bodygroup ID and the value to set it to.

Default Sub-Materials:

+ Add Sub-Material Sub-material overrides forcibly applied to a character each time they spawn in this class. Each entry is a slot (1-indexed) and the material path to assign.

Logo: Material path for the class logo displayed in the scoreboard.

Model Scale: Model scale multiplier. Also adjusts view offset proportionally. Default is 1.

Health: Base health. Overrides faction value when set.

Armor: Base armor. Overrides faction value when set.

Pay/Salary: Salary amount per paycheck. Overrides faction pay when set.

Blood Color: Default (BLOOD_COLOR_RED) BLOOD_COLOR_RED BLOOD_COLOR_YELLOW BLOOD_COLOR_GREEN BLOOD_COLOR_MECH BLOOD_COLOR_ANTLION BLOOD_COLOR_ZOMBIE Blood color constant applied on spawn. Leave default unless the class is non-human.

Run Speed: Use as multiplier Overrides faction value. When multiplier is checked, multiplies against the config default.

Walk Speed: Use as multiplier Overrides faction value. When multiplier is checked, multiplies against the config default.

Jump Power: Use as multiplier Overrides faction value. When multiplier is checked, multiplies against the player's current jump power.

Weapons:

+ Add Weapon Weapons given on spawn. Additive with faction weapons — both sets are given, this does not replace them.

Hidden from Scoreboard If true, this class is not shown as a row in the scoreboard.

Can Invite to Faction Players in this class can use the faction invite system without needing the Z privilege flag.

Can Invite to Class Players in this class can use the class invite system without needing the X privilege flag.

NPC Relations:

+ Add NPC Relation When set, replaces all faction NPC relations entirely. Absent = all NPCs are hostile (D_HT) by default.

Commands:

+ Add Command Command names (registered via lia.command.add) that members of this class can execute, bypassing normal privilege checks.

Generate Class Code Generate Example

Generated Code

---