FrameworkZ 4.4.2
Provides a framework for Project Zomboid with various systems.
Loading...
Searching...
No Matches
FrameworkZ::Players Class Reference

Players module for FrameworkZ. Defines and interacts with PLAYER object. More...

Public Member Functions

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)
 

Data Fields

 Admin
 
FrameworkZ Players List
 List of all instanced players in the game.
 
 Moderator
 
 Operator
 
 Owner
 
FrameworkZ Players
 
FrameworkZ Players Roles
 Roles for players in FrameworkZ.
 
 Super_Admin
 
 User
 

Detailed Description

Players module for FrameworkZ. Defines and interacts with PLAYER object.

Definition at line 13 of file Players.lua.

Member Function Documentation

◆ CreateCharacter()

void CreateCharacter ( username ,
data  )

◆ DeleteCharacter()

void DeleteCharacter ( username ,
character  )

◆ DeleteCharacterByID()

void DeleteCharacterByID ( username ,
characterID  )

◆ Destroy()

void Destroy ( username )

◆ GetCharacterByID()

void GetCharacterByID ( username ,
characterID  )

◆ GetCharacterDataByID()

table GetCharacterDataByID ( username ,
characterID  )

Gets saved character data by their ID.

Parameters
usernamestring The username of the player.
characterIDinteger The ID of the character.
Returns
table or boolean The character data or false if the data failed to be retrieved.

◆ GetPlayerByID()

void GetPlayerByID ( username )

◆ Initialize()

void Initialize ( username ,
player  )

◆ InitializeClient()

void InitializeClient ( isoPlayer )

◆ LoadCharacter()

void LoadCharacter ( username ,
characterData ,
survivorDescriptor  )

◆ LoadCharacterByID()

void LoadCharacterByID ( username ,
characterID  )

◆ New()

void New ( isoPlayer )

◆ OnClientCommand()

void OnClientCommand ( module ,
command ,
isoPlayer ,
args  )

◆ ResetCharacterSaveInterval()

void ResetCharacterSaveInterval ( )

◆ Save()

boolean Save ( username ,
continueOnFailure  )

Saves the player and their currently loaded character.

Parameters
usernamestring The username of the player.
continueOnFailureboolean (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()

void SaveCharacter ( username ,
character  )

◆ SaveCharacterByID()

void SaveCharacterByID ( username ,
characterID  )

Field Documentation

◆ Admin

FrameworkZ::Players::Admin

Definition at line 31 of file Players.lua.

◆ List

List of all instanced players in the game.

Definition at line 18 of file Players.lua.

◆ Moderator

FrameworkZ::Players::Moderator

Definition at line 29 of file Players.lua.

◆ Operator

FrameworkZ::Players::Operator

Definition at line 27 of file Players.lua.

◆ Owner

FrameworkZ::Players::Owner

Definition at line 35 of file Players.lua.

◆ Players

Definition at line 37 of file Players.lua.

◆ Roles

Roles for players in FrameworkZ.

Definition at line 23 of file Players.lua.

◆ Super_Admin

FrameworkZ::Players::Super_Admin

Definition at line 33 of file Players.lua.

◆ User

FrameworkZ::Players::User

Definition at line 25 of file Players.lua.


The documentation for this class was generated from the following file: