Characters module for FrameworkZ. Defines and interacts with CHARACTER object.
More...
Characters module for FrameworkZ. Defines and interacts with CHARACTER object.
Definition at line 18 of file Characters.lua.
◆ CreateCharacterTick()
void CreateCharacterTick |
( |
player | , |
|
|
tickTime | ) |
◆ GetCharacterByID()
Gets the user's loaded character by their ID.
- Parameters
-
username | string The player's username to get their character object with. |
- Returns
- table The character object from the list of characters.
◆ GetCharacterInventoryByID()
void GetCharacterInventoryByID |
( |
username | | ) |
|
◆ GetDescriptionLines()
◆ Initialize()
Initialize a character.
- Parameters
-
username | string The player's username. |
character | table The character's object data. |
- Returns
- string The username added to the list of characters.
◆ New()
Create a new character object.
- Parameters
-
username | string The player's username as their ID. |
id | integer The character's ID from the player stored data. |
data | table (Optional) The character's data stored on the object. |
- Returns
- table The new character object.
◆ OnClientCommand()
Initialize a character called by OnServerStarted event hook.
- Parameters
-
◆ OnPreUIDraw()
◆ PostLoad()
boolean PostLoad |
( |
isoPlayer | , |
|
|
characterData | ) |
Initializes a player's character after loading.
- Returns
- boolean Whether or not the post load was successful.
◆ Save()
Saves the user's currently loaded character.
- Parameters
-
username | string The player's username to get their loaded character from. |
- Returns
- boolean Whether or not the character was successfully saved.
◆ __index
◆ Characters
◆ EQUIPMENT_SLOT_BACKPACK
FrameworkZ::Characters::EQUIPMENT_SLOT_BACKPACK |
◆ EQUIPMENT_SLOT_BELT
FrameworkZ::Characters::EQUIPMENT_SLOT_BELT |
◆ EQUIPMENT_SLOT_EARS
FrameworkZ::Characters::EQUIPMENT_SLOT_EARS |
◆ EQUIPMENT_SLOT_FACE
FrameworkZ::Characters::EQUIPMENT_SLOT_FACE |
◆ EQUIPMENT_SLOT_GLOVES
FrameworkZ::Characters::EQUIPMENT_SLOT_GLOVES |
◆ EQUIPMENT_SLOT_HEAD
FrameworkZ::Characters::EQUIPMENT_SLOT_HEAD |
EQUIPMENT_SLOT_HEAD = "Hat" Enumeration for the character's head slot.
Definition at line 71 of file Characters.lua.
◆ EQUIPMENT_SLOT_OVERSHIRT
FrameworkZ::Characters::EQUIPMENT_SLOT_OVERSHIRT |
◆ EQUIPMENT_SLOT_PANTS
FrameworkZ::Characters::EQUIPMENT_SLOT_PANTS |
◆ EQUIPMENT_SLOT_SHOES
FrameworkZ::Characters::EQUIPMENT_SLOT_SHOES |
◆ EQUIPMENT_SLOT_SOCKS
FrameworkZ::Characters::EQUIPMENT_SLOT_SOCKS |
◆ EQUIPMENT_SLOT_UNDERSHIRT
FrameworkZ::Characters::EQUIPMENT_SLOT_UNDERSHIRT |
◆ EQUIPMENT_SLOT_VEST
FrameworkZ::Characters::EQUIPMENT_SLOT_VEST |
◆ EquipmentSlots
◆ HAIR_COLOR_BLACK_B
FrameworkZ::Characters::HAIR_COLOR_BLACK_B |
◆ HAIR_COLOR_BLACK_G
FrameworkZ::Characters::HAIR_COLOR_BLACK_G |
◆ HAIR_COLOR_BLACK_R
FrameworkZ::Characters::HAIR_COLOR_BLACK_R |
◆ HAIR_COLOR_BLONDE_B
FrameworkZ::Characters::HAIR_COLOR_BLONDE_B |
◆ HAIR_COLOR_BLONDE_G
FrameworkZ::Characters::HAIR_COLOR_BLONDE_G |
◆ HAIR_COLOR_BLONDE_R
FrameworkZ::Characters::HAIR_COLOR_BLONDE_R |
◆ HAIR_COLOR_BROWN_B
FrameworkZ::Characters::HAIR_COLOR_BROWN_B |
◆ HAIR_COLOR_BROWN_G
FrameworkZ::Characters::HAIR_COLOR_BROWN_G |
◆ HAIR_COLOR_BROWN_R
FrameworkZ::Characters::HAIR_COLOR_BROWN_R |
◆ HAIR_COLOR_GRAY_B
FrameworkZ::Characters::HAIR_COLOR_GRAY_B |
◆ HAIR_COLOR_GRAY_G
FrameworkZ::Characters::HAIR_COLOR_GRAY_G |
◆ HAIR_COLOR_GRAY_R
FrameworkZ::Characters::HAIR_COLOR_GRAY_R |
◆ HAIR_COLOR_RED_B
FrameworkZ::Characters::HAIR_COLOR_RED_B |
◆ HAIR_COLOR_RED_G
FrameworkZ::Characters::HAIR_COLOR_RED_G |
◆ HAIR_COLOR_RED_R
FrameworkZ::Characters::HAIR_COLOR_RED_R |
◆ HAIR_COLOR_WHITE_B
FrameworkZ::Characters::HAIR_COLOR_WHITE_B |
◆ HAIR_COLOR_WHITE_G
FrameworkZ::Characters::HAIR_COLOR_WHITE_G |
◆ HAIR_COLOR_WHITE_R
FrameworkZ::Characters::HAIR_COLOR_WHITE_R |
◆ List
◆ SKIN_COLOR_BROWN
FrameworkZ::Characters::SKIN_COLOR_BROWN |
◆ SKIN_COLOR_DARK_BROWN
FrameworkZ::Characters::SKIN_COLOR_DARK_BROWN |
◆ SKIN_COLOR_PALE
FrameworkZ::Characters::SKIN_COLOR_PALE |
◆ SKIN_COLOR_TANNED
FrameworkZ::Characters::SKIN_COLOR_TANNED |
◆ SKIN_COLOR_WHITE
FrameworkZ::Characters::SKIN_COLOR_WHITE |
The documentation for this class was generated from the following file: