FrameworkZ API - FrameworkZ.Players

Home / FrameworkZ.Players Module

FrameworkZ.Players

module

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

3
Functions
26
Methods
3
Fields

📋 On This Page

Fields

3
FrameworkZ.Players 📋 table
Players module for FrameworkZ. Defines and interacts with PLAYER object.
Initial value: {}
FrameworkZ.Players.List 📋 table
List of all instanced players in the game.
Initial value: {}
FrameworkZ.Players.Roles 📋 table
Roles for players in FrameworkZ.
Initial value: { User = "User", Operator = "Operator", Moderator = "Moderator", Admin = "Admin", Super_Admin = "Super Admin", Owner = "Owner" }

Methods

26

FrameworkZ.Players:CreateCharacter(username, characterData, characterID)

method undocumented
No documentation available

Parameters (inferred)

username ❓ unknown
Parameter inferred from function signature
characterData ❓ unknown
Parameter inferred from function signature
characterID ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.Players:CreateCharacterSaveInterval()

method
Create the character auto-save interval timer.

FrameworkZ.Players:DeleteCharacter(username, character)

method undocumented
No documentation available

Parameters (inferred)

username ❓ unknown
Parameter inferred from function signature
character ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Players:DeleteCharacterByID(username, characterID)

method undocumented
No documentation available

Parameters (inferred)

username ❓ unknown
Parameter inferred from function signature
characterID ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Players:Destroy(username, callback)

method undocumented
No documentation available

Parameters (inferred)

username ❓ unknown
Parameter inferred from function signature
callback ❓ unknown
Parameter inferred from function signature

FrameworkZ.Players:GetAllPlayers()

method
Get all registered players.

Returns

📋 table
Table of all PLAYER objects indexed by username.

FrameworkZ.Players:GetCharacterDataByID(username, characterID, callback)

method
Gets saved character data by their ID.

Parameters

username 📝 string
The username of the player.
characterID 🔢 integer
The ID of the character.
callback ⚡ function
(Optional) Callback function for async handling.

Returns

📋 table | ✅ boolean
The character data or false if the data failed to be retrieved.

FrameworkZ.Players:GetLoadedCharacterByID(username)

method
Get the loaded character for a specific player.

Parameters

username 📝 string
The username of the player.

Returns

🏷️ CHARACTER | ✅ boolean
The loaded CHARACTER object or false if not found or no character loaded.

FrameworkZ.Players:GetNextCharacterID(username)

method
Get the next available character ID for a player.

Parameters

username 📝 string
The username of the player.

Returns

🔢 number | ✅ boolean
The next character ID or false if max characters reached or player not found.
❔ string?
Error message if applicable.

FrameworkZ.Players:GetPlayerByID(username)

method
Gets the player object by their username.

Parameters

username 📝 string
The username of the player.

Returns

📦 object | ✅ boolean
The player object or false if the player was not found.

FrameworkZ.Players:Initialize(isoPlayer)

method
Initialize a player and add them to the player list.

Parameters

isoPlayer 🏷️ IsoPlayer
The Project Zomboid IsoPlayer object to initialize.

Returns

🏷️ PLAYER | ✅ boolean
The initialized PLAYER object or false if creation failed.

FrameworkZ.Players:LoadCharacter(username, characterData, survivorDescriptor, loadCharacterStartTime)

method undocumented
No documentation available

Parameters (inferred)

username ❓ unknown
Parameter inferred from function signature
characterData ❓ unknown
Parameter inferred from function signature
survivorDescriptor ❓ unknown
Parameter inferred from function signature
loadCharacterStartTime ❓ unknown
Parameter inferred from function signature

FrameworkZ.Players:LoadCharacterByID(username, characterID, callback)

method undocumented
No documentation available

Parameters (inferred)

username ❓ unknown
Parameter inferred from function signature
characterID ❓ unknown
Parameter inferred from function signature
callback ❓ unknown
Parameter inferred from function signature

FrameworkZ.Players:New(isoPlayer)

method
Create a new PLAYER object.

Parameters

isoPlayer 🏷️ IsoPlayer
The Project Zomboid IsoPlayer object to create a player for.

Returns

🏷️ PLAYER | ✅ boolean
The new PLAYER object or false if isoPlayer is nil.

FrameworkZ.Players:OnDisconnect()

method undocumented
No documentation available

Returns (inferred)

✅ boolean
Return type inferred from function name pattern

FrameworkZ.Players:OnFillWorldObjectContextMenu(playerNumber, context, worldObjects, test)

method undocumented
No documentation available

Parameters (inferred)

playerNumber ❓ unknown
Parameter inferred from function signature
context ❓ unknown
Parameter inferred from function signature
worldObjects ❓ unknown
Parameter inferred from function signature
test ❓ unknown
Parameter inferred from function signature

FrameworkZ.Players:OnInitGlobalModData(isNewGame)

method undocumented
No documentation available

Parameters (inferred)

isNewGame ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Players:OnLoadCharacter(username, characterID, callback)

method undocumented
No documentation available

Parameters (inferred)

username ❓ unknown
Parameter inferred from function signature
characterID ❓ unknown
Parameter inferred from function signature
callback ❓ unknown
Parameter inferred from function signature

FrameworkZ.Players:OnPostLoadCharacter(isoPlayer, player, character, characterData)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature
player ❓ unknown
Parameter inferred from function signature
character ❓ unknown
Parameter inferred from function signature
characterData ❓ unknown
Parameter inferred from function signature

FrameworkZ.Players:OnPreLoadCharacter(isoPlayer, player, character, characterData)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature
player ❓ unknown
Parameter inferred from function signature
character ❓ unknown
Parameter inferred from function signature
characterData ❓ unknown
Parameter inferred from function signature

FrameworkZ.Players:OnStorageSet(isoPlayer, command, namespace, keys, value)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature
command ❓ unknown
Parameter inferred from function signature
namespace ❓ unknown
Parameter inferred from function signature
keys ❓ unknown
Parameter inferred from function signature
value ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Players:ResetCharacterSaveInterval()

method
Reset the character auto-save interval timer.

FrameworkZ.Players:Save(username, continueOnFailure, callback)

method
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.

FrameworkZ.Players:SaveCharacter(username, character)

method undocumented
No documentation available

Parameters (inferred)

username ❓ unknown
Parameter inferred from function signature
character ❓ unknown
Parameter inferred from function signature

FrameworkZ.Players:SaveCharacterByID(username, characterID)

method undocumented
No documentation available

Parameters (inferred)

username ❓ unknown
Parameter inferred from function signature
characterID ❓ unknown
Parameter inferred from function signature

FrameworkZ.Players:StartPlayerTick(player)

method
Start the player tick system for executing periodic player updates.

Parameters

player 🏷️ PLAYER
The player object to start ticking for.

Functions

3

FrameworkZ.Players.LoadCharacter(_data, username, characterID)

function undocumented
No documentation available

Parameters (inferred)

_data ❓ unknown
Parameter inferred from function signature
username ❓ unknown
Parameter inferred from function signature
characterID ❓ unknown
Parameter inferred from function signature

FrameworkZ.Players.OnCreateCharacter(data, username, characterData)

function undocumented
No documentation available

Parameters (inferred)

data ❓ unknown
Parameter inferred from function signature
username ❓ unknown
Parameter inferred from function signature
characterData ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.Players.OnLoadCharacter(data, characterID)

function undocumented
No documentation available

Parameters (inferred)

data ❓ unknown
Parameter inferred from function signature
characterID ❓ unknown
Parameter inferred from function signature