Players module for FrameworkZ. Defines and interacts with PLAYER object.
More...
|
void | CreateCharacter (username, data) |
|
void | DeleteCharacter (username, character) |
|
void | DeleteCharacterByID (username, characterID) |
|
void | Destroy (username) |
|
void | GetCharacterByID (username, characterID) |
|
table | GetCharacterDataByID (username, characterID) |
| Gets saved character data by their ID.
|
|
void | GetPlayerByID (username) |
|
void | Initialize (username, player) |
|
void | InitializeClient (isoPlayer) |
|
void | LoadCharacter (username, characterData, survivorDescriptor) |
|
void | LoadCharacterByID (username, characterID) |
|
void | New (isoPlayer) |
|
void | OnClientCommand (module, command, isoPlayer, args) |
|
void | ResetCharacterSaveInterval () |
|
boolean | Save (username, continueOnFailure) |
| Saves the player and their currently loaded character.
|
|
void | SaveCharacter (username, character) |
|
void | SaveCharacterByID (username, characterID) |
|
Players module for FrameworkZ. Defines and interacts with PLAYER object.
Definition at line 13 of file Players.lua.
◆ CreateCharacter()
void CreateCharacter |
( |
username | , |
|
|
data | ) |
◆ DeleteCharacter()
◆ DeleteCharacterByID()
void DeleteCharacterByID |
( |
username | , |
|
|
characterID | ) |
◆ Destroy()
◆ GetCharacterByID()
void GetCharacterByID |
( |
username | , |
|
|
characterID | ) |
◆ GetCharacterDataByID()
table GetCharacterDataByID |
( |
username | , |
|
|
characterID | ) |
Gets saved character data by their ID.
- Parameters
-
username | string The username of the player. |
characterID | integer The ID of the character. |
- Returns
- table or boolean The character data or false if the data failed to be retrieved.
◆ GetPlayerByID()
◆ Initialize()
◆ InitializeClient()
◆ LoadCharacter()
void LoadCharacter |
( |
username | , |
|
|
characterData | , |
|
|
survivorDescriptor | ) |
◆ LoadCharacterByID()
void LoadCharacterByID |
( |
username | , |
|
|
characterID | ) |
◆ New()
◆ OnClientCommand()
◆ ResetCharacterSaveInterval()
void ResetCharacterSaveInterval |
( |
| ) |
|
◆ Save()
boolean Save |
( |
username | , |
|
|
continueOnFailure | ) |
Saves the player and their currently loaded character.
- Parameters
-
username | string The username of the player. |
continueOnFailure | boolean (Optional) Whether or not to continue saving either the player or character if either should fail. Default = false. True not recommended. |
- Returns
- boolean Whether or not the player was successfully saved.
-
string The failure message if the player or character failed to save.
◆ SaveCharacter()
◆ SaveCharacterByID()
void SaveCharacterByID |
( |
username | , |
|
|
characterID | ) |
◆ Admin
FrameworkZ::Players::Admin |
◆ List
List of all instanced players in the game.
Definition at line 18 of file Players.lua.
◆ Moderator
FrameworkZ::Players::Moderator |
◆ Operator
FrameworkZ::Players::Operator |
◆ Owner
FrameworkZ::Players::Owner |
◆ Players
◆ Roles
◆ Super_Admin
FrameworkZ::Players::Super_Admin |
◆ User
FrameworkZ::Players::User |
The documentation for this class was generated from the following file: