FrameworkZ API Documentation

FrameworkZ

core

FrameworkZ core object table. Contains core functionality for FrameworkZ.

Functions

445

Methods

Fields

📋 On This Page

Overview
Statistics
Fields99
Methods445
Functions32

Fields

FrameworkZ.CharacterDataManager 📋 table

Centralized character data manager for FrameworkZ

Initial value: {}

FrameworkZ.CharacterDataManager.Templates ❓ unknown inferred

Initial value:

{ -- Base character data structure CharacterData = { -- Meta information [FZ_ENUM_CHARACTER_META_ID] = nil, [FZ_ENUM_CHARACTER_META_UID] = nil, [FZ_ENUM_CHARACTER_META_FIRST_LOAD] = true, [FZ_ENUM_CHARACTER_META_RECOGNIZES] = {},  -- Basic info

FrameworkZ.Characters 📋 table

Characters module for FrameworkZ. Defines and interacts with CHARACTER object.

Initial value: {}

FrameworkZ.Characters.Cache 📋 table

Unique IDs list for characters by UID.

Initial value: {}

FrameworkZ.Characters.List 📋 table

List of all active character instances by username.

Initial value: {}

FrameworkZ.Characters.MetaObject ❓ unknown

Reference to the CHARACTER metatable for external access.

Initial value: CHARACTER

FrameworkZ.Classes 📋 table

Initial value: {}

FrameworkZ.Config ❓ unknown inferred

Initial value: FrameworkZ:CreateObject(FrameworkZ.Config, "Config")

FrameworkZ.Config.Options ❓ unknown inferred

Initial value:

{ SkipIntro = true, Version = "10.8.3", VersionType = "alpha",  IntroFrameworkImage = "media/textures/fz.png", IntroGamemodeImage = "media/textures/hl2rp.png", MainMenuImage = "media/textures/citidel.png",  IntroMusic = "hl2_song25_teleporter_short", -- Approximately 15 seconds long

FrameworkZ.DollarFormats 📋 table

Initial value: {}

FrameworkZ.Entities 📋 table

Entities module for FrameworkZ. Defines and interacts with ENTITY object.

Initial value: {}

FrameworkZ.Enumerations ❓ unknown inferred

Initial value: FrameworkZ.Enumerations or {}

FrameworkZ.Enumerations.EquipmentSlots ❓ unknown inferred

Initial value:

{ FZ_ENUM_EQUIPMENT_SLOT_AMMO_STRAP, FZ_ENUM_EQUIPMENT_SLOT_BACK, FZ_ENUM_EQUIPMENT_SLOT_BANDAGE, FZ_ENUM_EQUIPMENT_SLOT_BATH_ROBE, FZ_ENUM_EQUIPMENT_SLOT_BELLY_BUTTON, FZ_ENUM_EQUIPMENT_SLOT_BELT, FZ_ENUM_EQUIPMENT_SLOT_BELT_EXTRA, FZ_ENUM_EQUIPMENT_SLOT_BOILDER_SUIT, FZ_ENUM_EQUIPMENT_SLOT_DRESS,

FrameworkZ.Factions 📋 table

Factions module for FrameworkZ. Defines and interacts with FACTION object.

Initial value: {}

FrameworkZ.Foundation 📦 object

The foundational systems for FrameworkZ.

Initial value: FrameworkZ.Foundation.New()

FrameworkZ.Foundation 📋 table

Foundational systems for FrameworkZ.

Initial value: {}

FrameworkZ.Foundation.Events 📋 table

Contains all event handling functions for the Foundation system.

Initial value: {}

FrameworkZ.Foundation.HookHandlers 📋 table

Collection of hook handlers organized by category. Each category contains hooks that can be registered.

Initial value: { framework = {}, module = {}, gamemode = {}, plugin = {}, generic = {} }

FrameworkZ.Foundation.Modules ❓ unknown

Contains modules for FrameworkZ. Extends the framework with additional functionality.

Initial value: FrameworkZ.Foundation.Modules or {}

FrameworkZ.Foundation.Namespaces ❓ unknown

Collection of registered namespaces for data storage.

Initial value: FrameworkZ.Foundation.Namespaces or {}

FrameworkZ.Foundation.NetworksName 📝 string

The name of the networking module for commands in OnClientCommand and OnServerCommand. Not to be confused with a FrameworkZ module.

Initial value: "FZ_NETWORKS"

FrameworkZ.Foundation.PendingConfirmations 📋 table

Pending confirmations for network requests. This is used to track requests that are waiting for a response.

Initial value: {}

FrameworkZ.Foundation.RegisteredHooks 📋 table

Collection of registered hook functions organized by category and hook name.

Initial value: { framework = {}, module = {}, gamemode = {}, plugin = {}, generic = {} }

FrameworkZ.Foundation.StorageName 📝 string

STORAGE BACKEND - The base name used for storage operations.

Initial value: "FZ_STORAGE"

FrameworkZ.Foundation.Subscribers 📋 table

Subscribers for the network system. This is used to track subscribers for channels.

Initial value: {}

FrameworkZ.Foundation.SubscribersMeta 📋 table

Meta data for the subscribers. This is used to track when a channel was created and when it was last fired.

Initial value: {}

FrameworkZ.Foundation.SyncQueues ❓ unknown

Queues for batching synchronization operations.

Initial value: FrameworkZ.Foundation.SyncQueues or {}

FrameworkZ.Foundation.version 📝 string

Version information for the Foundation system.

Initial value: "1.0.0"

FrameworkZ.Initialized ✅ boolean inferred

Initial value: false

FrameworkZ.Interfaces 📋 table

Initial value: {}

FrameworkZ.Inventories 📋 table

The Inventories module for FrameworkZ. Defines and interacts with INVENTORY object.

Initial value: {}

FrameworkZ.Inventories.SlotLookup ❓ unknown inferred

Initial value: FrameworkZ.Characters.SlotList or {

FrameworkZ.Inventories.SlotNameLookup ❓ unknown inferred

Initial value:

{ [FZ_SLOT_BANDAGE] = FZ_ENUM_CHARACTER_SLOT_BANDAGE, [FZ_SLOT_WOUND] = FZ_ENUM_CHARACTER_SLOT_WOUND, [FZ_SLOT_BELT_EXTRA] = FZ_ENUM_CHARACTER_SLOT_BELT_EXTRA, [FZ_SLOT_BELT] = FZ_ENUM_CHARACTER_SLOT_BELT, [FZ_SLOT_BELLY_BUTTON] = FZ_ENUM_CHARACTER_SLOT_BELLY_BUTTON, [FZ_SLOT_MAKEUP_FULL_FACE] = FZ_ENUM_CHARACTER_SLOT_MAKEUP_FULL_FACE, [FZ_SLOT_MAKEUP_EYES] = FZ_ENUM_CHARACTER_SLOT_MAKEUP_EYES, [FZ_SLOT_MAKEUP_EYES_SHADOW] = FZ_ENUM_CHARACTER_SLOT_MAKEUP_EYES_SHADOW, [FZ_SLOT_MAKEUP_LIPS] = FZ_ENUM_CHARACTER_SLOT_MAKEUP_LIPS,

FrameworkZ.Inventories.Types 📋 table inferred

Initial value: { Character = "Character", Container = "Container", Vehicle = "Vehicle" }

FrameworkZ.Items 📋 table

Items module for FrameworkZ. Defines and interacts with ITEM \object.

Initial value: {}

FrameworkZ.Items.InstanceMap 📋 table

An instance map. Contains references to item instances indexed by an item's unique ID and instance ID as a string for optimized lookups. Instance Map is structured as follows: [uniqueID][username][#index] = instance

Initial value: {}

FrameworkZ.Logs 📋 table

Logs module for FrameworkZ. Logs player actions, system events, errors, warnings, and informational messages.

Initial value: {}

FrameworkZ.Logs.LogDirectory 📝 string inferred

Initial value: "FrameworkZ_Logs/"

FrameworkZ.Logs.LogTypes ❓ unknown inferred

Initial value:

{ PLAYER_ACCEPT_TRADE = "Player Accept Trade", PLAYER_CANCEL_TRADE = "Player Cancel Trade", PLAYER_CREATE_CHARACTER = "Player Create Character", PLAYER_DEATH = "Player Death", PLAYER_DECLINE_TRADE = "Player Decline Trade", PLAYER_ENTER_CAR = "Player Enter Car", PLAYER_EXIT_CAR = "Player Exit Car", PLAYER_FINALIZE_TRADE = "Player Finalize Trade", PLAYER_GIVE_DAMAGE = "Player Give Damage",

FrameworkZ.Logs.MaxEntries 🔢 number inferred

Initial value: 1000

FrameworkZ.Meta.Author 📝 string inferred

Initial value: "RJ_RayJay"

FrameworkZ.Meta.Description 📝 string inferred

Initial value: "FrameworkZ Bootstrap"

FrameworkZ.Meta.Version 📝 string inferred

Initial value: "1.0.0"

FrameworkZ.Notifications 📋 table

Notifications module for FrameworkZ. Queues and sends notifications.

Initial value: {}

FrameworkZ.Notifications.Colors 📋 table inferred

Initial value:

{ Default = {r = 1, g = 1, b = 1, a = 1}, Info = {r = 0.051, g = 0.792, b = 0.941, a = 1}, Success = {r = 0.098, g = 0.529, b = 0.329, a = 1}, Warning = {r = 1, g = 0.757, b = 0.027, a = 1}, Danger = {r = 0.863, g = 0.208, b = 0.271, a = 1} }

FrameworkZ.Notifications.Types 📋 table inferred

Initial value: { Default = "Default", Info = "Info", Success = "Success", Warning = "Warning", Danger = "Danger" }

FrameworkZ.Overrides ❓ unknown inferred

Initial value: FrameworkZ.Foundation:GetModule("Overrides")

FrameworkZ.Overrides ❓ unknown inferred

Initial value: FrameworkZ.Foundation:NewModule(FrameworkZ.Overrides, "Overrides")

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" }

FrameworkZ.Plugins 📋 table

Plugins module for FrameworkZ. Extends the framework with modular plugins.

Initial value: {}

FrameworkZ.Security 📋 table

Initial value: {}

FrameworkZ.Security.BaseObject 📋 table inferred

Initial value:

{ __valid = function(object) local currentHash = hashObject(object) return object.__hash == currentHash end,  __index = function(tbl, key) return rawget(FrameworkZ.Security.BaseObject, key) end }

FrameworkZ.SubClasses 📋 table

Initial value: {}

FrameworkZ.Timers 📋 table

Timers module for FrameworkZ. Allows for the creation of timers for delaying code executions.

Initial value: {}

FrameworkZ.Timers.Resume ❓ unknown inferred

Initial value: FrameworkZ.Timers.UnPause

FrameworkZ.Tooltips 📋 table

Manage dynamic on-screen tooltips for player characters with scoring and typewriter effects.

Initial value: {}

FrameworkZ.Tooltips.HoveredCharacterData ❓ unknown inferred

Initial value:

{ UI = nil, Texture = getTexture("media/textures/fz-selector.png"), TextureScale = 1.0, TextureAlpha = 0.8, TextureYOffset = 0.25, TooltipShowing = false, TooltipPlayer = nil, TooltipCharacterName = "", TooltipCharacterFaction = "",

FrameworkZ.UI ❓ unknown

Contains all of the User Interfaces for FrameworkZ.

Initial value: FrameworkZ.UI or {}

FrameworkZ.UI.CharacterPreview ❓ unknown inferred

Initial value: FrameworkZ.UI.CharacterPreview or {}

FrameworkZ.UI.CharacterView ❓ unknown inferred

Initial value: FrameworkZ.UI.CharacterView or {}

FrameworkZ.UI.CharacterView.instance ❓ unknown inferred

Initial value: o

FrameworkZ.UI.CreateCharacterAppearance ❓ unknown inferred

Initial value: FrameworkZ.UI.CreateCharacterAppearance or {}

FrameworkZ.UI.CreateCharacterAppearance.instance ❓ unknown inferred

Initial value: o

FrameworkZ.UI.CreateCharacterAppearance.instance ❓ unknown inferred

Initial value: nil

FrameworkZ.UI.CreateCharacterAppearance.instance.hairColor ❓ unknown inferred

Initial value: menu.hairColor

FrameworkZ.UI.CreateCharacterAppearance.instance.skinColor ❓ unknown inferred

Initial value: menu.skinColor

FrameworkZ.UI.CreateCharacterAppearance.instance.wasGenderUpdated ✅ boolean inferred

Initial value: false

FrameworkZ.UI.CreateCharacterFaction ❓ unknown inferred

Initial value: FrameworkZ.UI.CreateCharacterFaction or {}

FrameworkZ.UI.CreateCharacterFaction.instance ❓ unknown inferred

Initial value: o

FrameworkZ.UI.CreateCharacterFaction.instance ❓ unknown inferred

Initial value: nil

FrameworkZ.UI.CreateCharacterInfo ❓ unknown inferred

Initial value: FrameworkZ.UI.CreateCharacterInfo or {}

FrameworkZ.UI.CreateCharacterInfo.instance ❓ unknown inferred

Initial value: nil

FrameworkZ.UI.CreateCharacterInfo.instance ❓ unknown inferred

Initial value: o

FrameworkZ.UI.InitializationScreen ❓ unknown inferred

Initial value: FrameworkZ.UI.InitializationScreen or {}

FrameworkZ.UI.InitializationScreen.instance ❓ unknown inferred

Initial value: self

FrameworkZ.UI.Introduction ❓ unknown inferred

Initial value: FrameworkZ.UI.Introduction or {}

FrameworkZ.UI.Introduction.instance ❓ unknown inferred

Initial value: o

FrameworkZ.UI.LoadCharacterMenu ❓ unknown inferred

Initial value: FrameworkZ.UI.LoadCharacterMenu or {}

FrameworkZ.UI.LoadCharacterMenu.instance ❓ unknown inferred

Initial value: o

FrameworkZ.UI.MainMenu ❓ unknown inferred

Initial value: FrameworkZ.Interfaces:New("MainMenu", FrameworkZ.UI)

FrameworkZ.UI.MainMenu.instance ❓ unknown inferred

Initial value: o

FrameworkZ.UI.MusicControls ❓ unknown inferred

Initial value: FrameworkZ.UI.MusicControls or {}

FrameworkZ.UI.MusicControls.instance ❓ unknown inferred

Initial value: self

FrameworkZ.UI.Notification ❓ unknown inferred

Initial value: FrameworkZ.UI.Notification or {}

FrameworkZ.UI.TabMenu ❓ unknown inferred

Initial value: FrameworkZ.UI.TabMenu or {}

FrameworkZ.UI.TabMenu.instance ❓ unknown inferred

Initial value: o

FrameworkZ.UI.TabPanel ❓ unknown inferred

Initial value: FrameworkZ.UI.TabPanel or {}

FrameworkZ.UI.TabPanel.buttons 📋 table inferred

Initial value:

{ {text = "CHARACTERS", internal = "CHARACTERS", callback = FrameworkZ.UI.TabPanel.onMenuSelect}, {text = "MY CHARACTER", internal = "MY_CHARACTER", callback = FrameworkZ.UI.TabPanel.onMenuSelect}, {text = "Session", internal = "SESSION", callback = FrameworkZ.UI.TabPanel.onMenuSelect}, {text = "Directory", internal = "DIRECTORY", callback = FrameworkZ.UI.TabPanel.onMenuSelect}, {text = "Config", internal = "CONFIG", callback = FrameworkZ.UI.TabPanel.onMenuSelect} }

FrameworkZ.UI.TabPanel.instance ❓ unknown inferred

Initial value: nil

FrameworkZ.UI.TabSession ❓ unknown inferred

Initial value: FrameworkZ.UI.TabSession or {}

FrameworkZ.UI.TabSession.instance ❓ unknown inferred

Initial value: nil

FrameworkZ.UI.TabSession.instance ❓ unknown inferred

Initial value: nil

FrameworkZ.UpgradeSystem ❓ unknown inferred

Initial value: FrameworkZ.UpgradeSystem or {}

FrameworkZ.UserInterfaces 📋 table

User Interfaces module. This module is used to create user interfaces for the game.

Initial value: {}

FrameworkZ.UserInterfaces.ButtonTheme ❓ unknown inferred

Initial value:

{ massiveButtonFontSize = UIFont.Massive, hugeButtonFontSize = UIFont.Title, largeButtonFontSize = UIFont.Large, mediumButtonFontSize = UIFont.Medium, smallButtonFontSize = UIFont.Small, buttonBackground = false, buttonBackgroundColor = {r=0.1, g=0.1, b=0.1, a=1}, buttonBorder = false, buttonBorderColor = {r=1, g=1, b=1, a=1},

FrameworkZ.Utilities 📋 table

Utility module for FrameworkZ. Contains utility functions and classes.

Initial value: {}

FrameworkZ.Utilities.Directions 📋 table inferred

Initial value:

{ { dx =  1, dy =  0, wallFlag = IsoFlagType.collideW, doorFlag = IsoFlagType.doorW, windowFlag = IsoFlagType.windowW }, { dx = -1, dy =  0, wallFlag = IsoFlagType.collideW, doorFlag = IsoFlagType.doorW, windowFlag = IsoFlagType.windowW }, { dx =  0, dy =  1, wallFlag = IsoFlagType.collideN, doorFlag = IsoFlagType.doorN, windowFlag = IsoFlagType.windowN }, { dx =  0, dy = -1, wallFlag = IsoFlagType.collideN, doorFlag = IsoFlagType.doorN, windowFlag = IsoFlagType.windowN }, }

Methods

445

FrameworkZ.CharacterDataManager:AddItemToLogicalInventory(characterData, uniqueID, quantity)

method

Add item to logical inventory during character creation

Parameters

characterData 📋 table

Character data structure

uniqueID 📝 string

FrameworkZ item unique ID

quantity 🔢 integer

Quantity to add

FrameworkZ.CharacterDataManager:CreateCharacterData(creationData, player)

method

Create a new character data structure from creation UI

Parameters

survivor 📋 table

The SurvivorDesc object

characterData 📋 table

The character data containing appearance info

Returns

The character's unique ID.

character 📋 table

The character object to add.

Returns

📋 table

\boolean The added character object or false if failed.

FrameworkZ.Characters:AddToList(username, character)

method

Add a character to the active character list.

Parameters

isoPlayer 📋 table

The IsoPlayer object.

characterData 📋 table

The character's stored data.

Returns

📋 table

The initialized character object.

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

method

Storage set event handler for character data.

Parameters

isoPlayer 📋 table

The IsoPlayer object.

command 📝 string

The command type.

namespace 📝 string

❓ unknown

Return type inferred from function name pattern

FrameworkZ.Classes:Initialize(id, object)

method undocumented

No documentation available

Parameters (inferred)

No documentation available

Parameters (inferred)

optionName ❓ unknown

Parameter inferred from function signature

value ❓ unknown

Parameter inferred from function signature

Returns (inferred)

⭕ void

Return type inferred from function name pattern

FrameworkZ.DollarFormats:CommaValue(amount)

method undocumented

No documentation available

Parameters (inferred)

amount ❓ unknown

Parameter inferred from function signature

FrameworkZ.DollarFormats:Get(amount, decimal, prefix, neg_prefix)

method undocumented

No documentation available

Parameters (inferred)

amount ❓ unknown

Parameter inferred from function signature

decimal ❓ unknown

Parameter inferred from function signature

prefix ❓ unknown

Parameter inferred from function signature

neg_prefix ❓ unknown

Parameter inferred from function signature

Returns (inferred)

❓ unknown

Return type inferred from function name pattern

FrameworkZ.DollarFormats:Round(val, decimal)

method undocumented

No documentation available

Parameters (inferred)

val ❓ unknown

Parameter inferred from function signature

decimal ❓ unknown

Parameter inferred from function signature

FrameworkZ.Entities:EmitSound(worldObject, sound)

method undocumented

No documentation available

Parameters (inferred)

worldObject ❓ unknown

Parameter inferred from function signature

sound ❓ unknown

Parameter inferred from function signature

FrameworkZ.Entities:GetData(worldObject, index)

method undocumented

No documentation available

Parameters (inferred)

worldObject ❓ unknown

Parameter inferred from function signature

index ❓ unknown

Parameter inferred from function signature

Returns (inferred)

❓ unknown

name 📝 string

The entity's name (i.e. ID).

square 📋 table

The square the entity is on.

Returns

📋 table

The entity's object table.

FrameworkZ.Entities:SetData(worldObject, index, value)

method undocumented

No documentation available

Parameters (inferred)

worldObject ❓ unknown

Parameter inferred from function signature

index ❓ unknown

Parameter inferred from function signature

value ❓ unknown

Parameter inferred from function signature

Returns (inferred)

⭕ void

Return type inferred from function name pattern

FrameworkZ.Factions:GetClassByID(factionID)

method undocumented

No documentation available

Parameters (inferred)

factionID ❓ unknown

Parameter inferred from function signature

Returns (inferred)

❓ unknown

Return type inferred from function name pattern

FrameworkZ.Factions:GetFactionByID(factionID)

method

Get a faction by their ID.

Parameters

factionID 📝 string

The faction's ID

Returns

📋 table

The faction's object.

FrameworkZ.Factions:GetFactionNameByID(factionID)

method

Get a faction's name by their ID. Useful for getting a faction's actual name if the initialized faction ID differs from the name field.

Parameters

factionID 📝 string

The faction's ID.

Returns

📝 string

The faction's name.

FrameworkZ.Factions:Initialize(id, object)

method

Initialize a faction.

Parameters

data 📋 table

The faction object's data.

player 📦 object

The player object.

context 📦 object

The context menu object.

items 📋 table

The items being examined.

FrameworkZ.Foundation.Events:OnFillWorldObjectContextMenu(playerNumber, context, worldObjects, test)

method

Called when filling a world object's context menu.

Parameters

playerNumber 🔢 integer

The player number.

context 📦 object

The context menu object.

worldObjects 📋 table

The world objects being examined.

object 📦 object

The object that was clicked.

x 🔢 integer

The X coordinate of the click.

y 🔢 integer

The Y coordinate of the click.

FrameworkZ.Foundation.Events:OnPlayerDeath(player)

method

Called when a player dies.

Parameters

player 📦 object

The player object that died.

FrameworkZ.Foundation.Events:OnPreFillInventoryObjectContextMenu(playerID, context, items)

method

Called before filling an inventory object's context menu.

Parameters

playerID 🔢 integer

The player ID.

context 📦 object

The context menu object.

items 📋 table

The items being examined.

FrameworkZ.Foundation.Events:OnReceiveGlobalModData(key, data)

method

Called when global mod data is received.

Parameters

key 📝 string

The key of the data received.

data 🏷️ mixed

The data that was received.

FrameworkZ.Foundation.Events:OnResetLua(reason)

method

Called when the Lua state is reset.

Parameters

reason 📝 string

The reason for the reset.

FrameworkZ.Foundation.Events:OnServerCommand(module, command, arguments)

method

Handles server commands received on the client.

Parameters

module 📝 string

The module name that sent the command.

command 📝 string

The command that was sent.

The category of the hook (framework, module, plugin, generic). Defaults to HOOK_CATEGORY_GENERIC if not specified.

FrameworkZ.Foundation:Broadcast(namespace, key, remove)

method

Broadcasts updated or removed data to all clients.

Parameters

namespace 📝 string

The category of the hook (framework, module, plugin, generic). Defaults to HOOK_CATEGORY_GENERIC if not specified.

key 📝 string

method

Gets a value from a namespace by key(s).

Parameters

isoPlayer 📦 object

(Optional) The player to get the value for. This is only used on the client to send a request to the server.

namespace 📝 string

The namespace to get the value from.

keys 📝 string

or \table The key(s) to get the value for. Supplying a table will do a lookup through all keys and get value at the last index.

subscriptionID 📝 string

(Optional) A unique identifier for the subscription to be fired server-side after the value has been retrieved.

callback ⚡ function

(Optional) A callback function to call after the value is retrieved. This is only used on the client to handle the response from the server.

Returns

🌟 any

(except \function) The value for the key in the namespace, or false if the namespace or key does not exist. Server-side only.

📝 Notes

If called on the client, the value may only be accessed in the callback immediately, or later after data has synchronized.

FrameworkZ.Foundation:GetLocalData(namespace, keys)

method

Gets data from local storage using namespace and keys.

Parameters

📋 table

The subscribers for the key.

FrameworkZ.Foundation:GetVersion()

method

Get the version of FrameworkZ Foundation.

Returns

📝 string

The version of the FrameworkZ Foundation.

FrameworkZ.Foundation:HasChannel(key)

method

Check if a channel exists for a key. This will return true if the channel exists, false otherwise.

Parameters

key 📝 string

or \table The key to use for the channel. Use a table to create nested channels. \see FrameworkZ.Foundation::Subscribe for an example on how to supply a table as a key.

Returns

✅ boolean

True if the channel exists, false otherwise.

FrameworkZ.Foundation:HasSubscription(key, id)

method

Check if a subscription exists for a key. This will return true if the subscription exists, false otherwise.

Parameters

key 📝 string

The key to check for. Use a \table to check for nested values. \see FrameworkZ.Foundation::Subscribe for an example on how to supply a table as a key.

id 📝 string

The ID of the function callback being checked.

Returns

✅ boolean

True if the subscription exists, false otherwise.

FrameworkZ.Foundation:Initialize()

method

Initializes the FrameworkZ Foundation system by setting up event handlers and registering them with the Project Zomboid event system.

📝 Notes

The LoadGridSquare event is not added to the hook system for performance reasons, as it is called very frequently.

This function wraps the Project Zomboid Events system to integrate with the FrameworkZ hook system, allowing all foundation events to be processed through the hook mechanism.

FrameworkZ.Foundation:InitializeClient(isoPlayer)

method

Main client initialization function. Sets up player state and communicates with the server.

Parameters

isoPlayer 📦 object

The player object being initialized.

FrameworkZ.Foundation:InitializePlayer(isoPlayer, playerData, charactersData)

method

Initializes a player with framework data and sets up their initial state.

Parameters

isoPlayer 📦 object

The player's ISO object.

playerData 📋 table

(Optional) Existing player data for restoration.

charactersData 📋 table

(Optional) Existing character data for restoration.

Returns

✅ boolean

\table, \table Returns success status, player data, and character data.

FrameworkZ.Foundation:LogChannels()

method

Log all channels and their subscribers to the console. This is useful for debugging and understanding the network system.

FrameworkZ.Foundation:NewModule(moduleObject, moduleName)

method

Create a new module for the FrameworkZ framework.

Parameters

moduleObject 📦 object

The object to use as the module.

moduleName 📝 string

The name of the module.

Returns

📦 object

The new module.

FrameworkZ.Foundation:OnClientCommand(module, command, isoPlayer, arguments)

method

Handles incoming commands from the client on the server.

Parameters

module 📝 string

The name of the module that sent the command. This should match the NetworksName defined in FrameworkZ.Foundation.NetworksName.

command 📝 string

The command that was sent by the client.

isoPlayer 📦 object

The player that sent the command. This is the player object that sent the command.

arguments 📋 table

The arguments that were sent with the command. This contains the data needed to process the command.

📝 Notes

This function is called on the server when a client sends a command to the server. It processes the command and sends a response back to the client using the networking system.

FrameworkZ.Foundation:OnGameStart()

method

Called when the game starts. Executes the OnGameStart function for all modules.

FrameworkZ.Foundation:OnServerCommand(module, command, arguments)

method

Handles incoming commands from the server on the client.

Parameters

module 📝 string

The name of the module that sent the command. This should match the NetworksName defined in FrameworkZ.Foundation.NetworksName.

command 📝 string

The command that was sent by the server.

arguments 📋 table

The arguments that were sent with the command. This contains the data needed to process the command.

object 📋 table

The object to process for saving.

ignoreList 📋 table

List of keys to ignore during processing.

encodeList 📋 table

List of keys that should be encoded using their GetSaveableData method.

Returns

📋 table

The processed saveable data.

FrameworkZ.Foundation:QueueBatchSync(isoPlayer, namespace, key)

method

Queue a key in a namespace for batch synchronization.

Parameters

isoPlayer 📦 object

The player to queue sync for.

namespace 📝 string

The namespace containing the data.

key 📝 string

The key to sync.

FrameworkZ.Foundation:RegisterFramework()

method

FrameworkZ.Foundation:RegisterFrameworkHandler()

method

FrameworkZ.Foundation:RegisterGamemodeHandler(gamemode)

method

Parameters

gamemode 📋 table

The gamemode table containing the functions.

FrameworkZ.Foundation:RegisterGenericHandler()

method

FrameworkZ.Foundation:RegisterHandler(hookName, handler, object, functionName, category)

method

Parameters

hookName 📝 string

The name of the hook.

handler ⚡ function

The function to call when the hook is executed.

object (optional) 📋 table

The object containing the function.

functionName (optional) 📝 string

The name of the function to call.

category 📝 string

The category of the hook (framework, module, plugin, generic). Defaults to HOOK_CATEGORY_GENERIC if not specified.

FrameworkZ.Foundation:RegisterHandlers(objectOrHandlers, category)

method

Parameters

objectOrHandlers 📋 table

The object containing the functions, or nil for generic handlers.

Parameters

name 📝 string

The name of the namespace to register.

📝 Notes

This must be used in the shared scope within an OnInitGlobalModData function.

FrameworkZ.Foundation:RegisterPluginHandler(plugin)

FrameworkZ.Foundation:RemoveHookHandler(hookName, category)

method

Remove a hook handler from the list.

Parameters

hookName 📝 string

The name of the hook handler to remove.

category 📝 string

The category of the hook (framework, module, plugin, generic). Defaults to HOOK_CATEGORY_GENERIC if not specified.

FrameworkZ.Foundation:RestoreData(isoPlayer, command, namespace, keys, callback)

method

Restores data from storage for client-server synchronization.

Parameters

isoPlayer 📦 object

The player object.

command 📝 string

The command identifier.

namespace 📝 string

The namespace to restore from.

keys 📝 string

or \table The key(s) to restore.

callback ⚡ function

Callback function to handle the restored data.

Returns

✅ boolean

Returns true if successful on server, varies on client.

FrameworkZ.Foundation:RestorePlayer(isoPlayer, player, username, playerData, charactersData)

method

Restores player data from storage or creates new data if none exists.

Parameters

isoPlayer 📦 object

The player's ISO object.

player 📦 object

The framework player object.

username 📝 string

The player's username.

playerData 📋 table

(Optional) Existing player data on client-side.

charactersData 📋 table

(Optional) Existing character data on client-side.

Returns

📋 table

\table The player data and character data, or false if new.

FrameworkZ.Foundation:SaveData(isoPlayer)

method

Saves all namespace data to persistent storage.

Parameters

isoPlayer 📦 object

(Optional) The player object. Used on client to send request to server.

FrameworkZ.Foundation:SaveNamespace(isoPlayer, namespace)

method

Saves a specific namespace to persistent storage.

Parameters

isoPlayer 📦 object

(Optional) The player object. Used on client to send request to server.

namespace 📝 string

The namespace to save.

FrameworkZ.Foundation:SendFire(isoPlayer, subscriptionID, callback, ...)

method

Sends a fire event to the server or client. This is used to send events to subscribers.

Parameters

isoPlayer 📦 object

The player sending the fire event. If nil, the event will be fired but no confirmation will be sent back (send and forget).

subscriptionID 📝 string

The ID of the subscription to fire. This is the key used to subscribe to the event. It's recommended to use a string matching your function's callback name in a unique way when adding a subscription.

callback ⚡ function

The callback to call when the server confirms the fire event. This is optional and can be nil if you don't need confirmation.

Returns

📝 string

The request ID for the fire event. This can be used to track the request and get confirmation later.

FrameworkZ.Foundation:SendGet(key, callback, callbackID, broadcast, ...)

method

Sends a get request to the server.

Parameters

key 🏷️ mixed

The key to get. Does not support getting functions.

callback ⚡ function

The callback to call on the client when the server returns the value.

callbackID 📝 string

The key to use for the callback on the server after getting the value.

broadcast ✅ boolean

Whether to broadcast the get callback to all clients.

FrameworkZ.Foundation:SendSet(key, value, callback, callbackID, broadcast)

method

Sends a set request to the server.

Parameters

key 📝 string

or \table The key to set. Use a table to set nested values. \note Example key argument as a table: {"key", "subkey"} == _G["key"]["subkey"] or _G.key.subkey on lookup when setting.

value 🏷️ mixed

The value to set. Does not support functions.

callback ⚡ function

The callback to call on the client when the server confirms the set.

callbackID 📝 string

The key to use for the callback on the server after setting the value.

broadcast ✅ boolean

Whether to broadcast the set callback to all clients.

FrameworkZ.Foundation:ServerTick()

method

Server tick handler that manages periodic data saving.

FrameworkZ.Foundation:SetData(isoPlayer, namespace, keys, value, subscriptionID, broadcast, callback)

method

Sets a value in a namespace and (optionally) broadcasts to all clients.

Parameters

isoPlayer 📦 object

(Optional when called server-side only) The player to set the value for. This is only used on the client to send a request to the server.

namespace 📝 string

The namespace to set the value in.

keys 📝 string

or \table The key(s) to set the value for. Supplying a table will do a lookup through all keys and set value at the last index.

value 🌟 any

(except \function) The value to set.

subscriptionID 📝 string

(Optional) A unique identifier for the subscription to be fired server-side after the value has been set.

broadcast ✅ boolean

(Optional) Whether or not to broadcast the value to all clients.

callback ⚡ function

(Optional) A callback function to call after the value is set. This is only used on the client to handle the response from the server.

Returns

✅ boolean

Whether or not the value was set successfully. Server-side only.

📝 Notes

If called on the client, the value may only be accessed in the callback immediately, or later after data has synchronized.

FrameworkZ.Foundation:SetLocalData(namespace, keys, value)

method

Sets data in local storage using namespace and keys.

Parameters

namespace 📝 string

The namespace to store data in.

keys 📝 string

or \table The key(s) to set. If table, performs nested assignment.

value 🏷️ mixed

The value to store.

Returns

✅ boolean

Returns true if successful, false otherwise.

FrameworkZ.Foundation:SetNestedValue(root, path, value)

method

Set a nested value in a table using a path. This is used to set values in nested tables.

Parameters

root 📋 table

The root table to set the value in.

path 📋 table

The path to the value. This is a table of keys to traverse the nested tables.

value 🏷️ mixed

The value to set at the end of the path.

Returns

🏷️ mixed

The value that was set at the end of the path.

The function to unregister.

object 📋 table

(Optional) The object containing the function.

functionName 📝 string

(Optional) The name of the function to unregister.

category 📝 string

The category of the hook (framework, module, plugin, generic). Defaults to HOOK_CATEGORY_GENERIC if not specified.

FrameworkZ.Foundation:UnregisterHandlers(objectOrHandlers, category)

method

Unregister handlers for a specific category.

Parameters

objectOrHandlers 📋 table

The object containing the functions, or nil for generic handlers.

key 📝 string

The key to unsubscribe from. Use a \table to unsubscribe from nested values. \see FrameworkZ.Foundation::Subscribe for an example on how to supply a table as a key.

id 🏷️ sting

The ID of the function callback being removed. Default for fire events: "__default"

FrameworkZ.Foundation:Watch(key, id, callback)

method

Subscribes and fires callback immediately if the value is already set. Useful for UIs.

Parameters

key 📝 string

or \table The key to watch. Use a table to watch nested values. \see FrameworkZ.Foundation::Subscribe for an example on how to supply a table as a key.

id 📝 string

The ID of the function callback being added.

callback ⚡ function

The callback to call when the key changes.

FrameworkZ.Interfaces:GetInterface(index)

method undocumented

No documentation available

Parameters (inferred)

index ❓ unknown

Parameter inferred from function signature

Returns (inferred)

❓ unknown

id ❓ unknown

Parameter inferred from function signature

Returns (inferred)

❓ unknown

Return type inferred from function name pattern

FrameworkZ.Inventories:GetItemByUniqueID(inventoryID, uniqueID)

method undocumented

No documentation available

Parameters (inferred)

inventoryID ❓ unknown

Parameter inferred from function signature

uniqueID ❓ unknown

Parameter inferred from function signature

Returns (inferred)

❓ unknown

Return type inferred from function name pattern

FrameworkZ.Inventories:GetItemCountByID(inventoryID, uniqueID)

method undocumented

No documentation available

Parameters (inferred)

inventoryID ❓ unknown

Parameter inferred from function signature

uniqueID ❓ unknown

Parameter inferred from function signature

Returns (inferred)

❓ unknown

Return type inferred from function name pattern

FrameworkZ.Inventories:Initialize(id, object)

method

Initialize an inventory.

Parameters

id 📋 table

The inventory's id.

object 📋 table

The inventory's object.

Returns

🔢 integer

The inventory's ID.

FrameworkZ.Inventories:New(username, type, id)

method

Create a new inventory object.

Parameters

username 📝 string

The owner's username. Can be nil for no owner.

type 📝 string

The type of inventory. Can be nil, but creates a character inventory type by default. Refer to FrameworkZ.Inventories.Types table for available types.

id 📝 string

The inventory's ID. Can be nil for an auto generated ID (recommended).

Returns

📋 table

The new inventory object.

FrameworkZ.Inventories:Rebuild(isoPlayer, inventory, items)

method

character 📋 table

The character object with inventory

Returns

📋 table

The complete inventory data including equipment

FrameworkZ.Items:AddInstance(item, isoPlayer, worldItem, callback)

method undocumented

No documentation available

Parameters (inferred)

item ❓ unknown

Parameter inferred from function signature

isoPlayer ❓ unknown

Parameter inferred from function signature

worldItem ❓ unknown

Parameter inferred from function signature

callback ❓ unknown

Parameter inferred from function signature

Returns (inferred)

⭕ void

Return type inferred from function name pattern

FrameworkZ.Items:CreateItem(uniqueID, isoPlayer, callback)

method

Creates an item instance and links it to a world item.

Parameters

No documentation available

Parameters (inferred)

worldItem ❓ unknown

Parameter inferred from function signature

instanceData ❓ unknown

Parameter inferred from function signature

FrameworkZ.Items:New(uniqueID, itemID, isBase)

method undocumented

No documentation available

Parameters (inferred)

uniqueID ❓ unknown

Parameter inferred from function signature

itemID ❓ unknown

Parameter inferred from function signature

Parameter inferred from function signature

items ❓ unknown

Parameter inferred from function signature

FrameworkZ.Items:OnUnequipItemCallback(parameters)

method undocumented

No documentation available

Parameters (inferred)

parameters ❓ unknown

Parameter inferred from function signature

FrameworkZ.Items:OnUseItemCallback(parameters)

method undocumented

No documentation available

Parameters (inferred)

parameters ❓ unknown

Parameter inferred from function signature

FrameworkZ.Items:RemoveInstance(instanceID, username)

method

Removes an item instance from the game world and the item instance list.

Parameters

instanceID 🔢 integer

The instance ID of the item to remove.

username 📦 object

(Optional) The player's username whose inventory the item should be removed from.

Returns

✅ boolean

\string Success status and message.

FrameworkZ.Items:RemoveItemInstanceByUniqueID(owner, uniqueID)

method undocumented

No documentation available

Parameters (inferred)

owner ❓ unknown

Parameter inferred from function signature

uniqueID ❓ unknown

Parameter inferred from function signature

Returns (inferred)

⭕ void

Return type inferred from function name pattern

FrameworkZ.Logs:AddLog(logType, message, player)

method

Add a log entry.

Parameters

logType 📝 string

The type of log (e.g., "PlayerAction", "SystemEvent").

message 📝 string

The log message.

player 📋 table

Optional player table associated with the log.

FrameworkZ.Logs:GetLogs(logType, player)

method

Retrieve log entries.

Parameters

No documentation available

Parameters (inferred)

player ❓ unknown

Parameter inferred from function signature

action ❓ unknown

Parameter inferred from function signature

FrameworkZ.Logs:LogSystemEvent(message)

Parameter inferred from function signature

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

method

Gets saved character data by their ID.

Parameters

username 📝 string

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 undocumented

No documentation available

Returns (inferred)

⭕ void

Return type inferred from function name pattern

FrameworkZ.Players:Save(username, continueOnFailure)

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)

Parameters

commandName 📝 string

The name of the command.

callback ⚡ function

The function to call when the command is executed.

FrameworkZ.Plugins:RegisterInterface(interfaceName, interfaceTable)

method undocumented

No documentation available

Parameters (inferred)

interfaceName ❓ unknown

Parameter inferred from function signature

interfaceTable ❓ unknown

Parameter inferred from function signature

Returns (inferred)

✅ boolean

Return type inferred from function name pattern

FrameworkZ.Plugins:RegisterPlugin(plugin, overwrite)

method

Parameters

pluginName 📝 string

The name of the plugin.

pluginTable 📋 table

The table containing the plugin's functions and data.

metadata 📋 table

Optional metadata for the plugin.

FrameworkZ.Plugins:RegisterPluginEventHandlers(plugin)

Parameters (inferred)

objectName ❓ unknown

Parameter inferred from function signature

Parameter inferred from function signature

Returns (inferred)

method

Creates a simple timer that executes a function after a delay.

Parameters

integer 🏷️ delay

The delay in seconds before the function is executed.

localPlayer ❓ unknown

Parameter inferred from function signature

targetPlayer ❓ unknown

Parameter inferred from function signature

mouseX ❓ unknown

Parameter inferred from function signature

mouseY ❓ unknown

Parameter inferred from function signature

Returns (inferred)

❓ unknown

Return type inferred from function name pattern

FrameworkZ.Tooltips:CalculateLineOfSight(localPlayer, targetPlayer, restrictive, adjacentRange)

method undocumented

No documentation available

Parameters (inferred)

localPlayer ❓ unknown

Parameter inferred from function signature

targetPlayer ❓ unknown

Parameter inferred from function signature

restrictive ❓ unknown

Parameter inferred from function signature

adjacentRange ❓ unknown

Parameter inferred from function signature

Returns (inferred)

❓ unknown

Return type inferred from function name pattern

FrameworkZ.Tooltips:CalculatePlayerTargetAngle(player, targetX, targetY)

method undocumented

No documentation available

Parameters (inferred)

player ❓ unknown

Parameter inferred from function signature

targetX ❓ unknown

Parameter inferred from function signature

targetY ❓ unknown

Parameter inferred from function signature

Returns (inferred)

❓ unknown

Return type inferred from function name pattern

FrameworkZ.Tooltips:CalculateTypewriterSpeed(localPlayer, targetPlayer)

method undocumented

No documentation available

Parameters (inferred)

localPlayer ❓ unknown

Parameter inferred from function signature

targetPlayer ❓ unknown

Parameter inferred from function signature

Returns (inferred)

❓ unknown

Return type inferred from function name pattern

FrameworkZ.Tooltips:CheckAdjacentOpening(localSquare, targetSquare, dx, dy, restrictive)

method undocumented

No documentation available

Parameters (inferred)

localSquare ❓ unknown

Parameter inferred from function signature

targetSquare ❓ unknown

Parameter inferred from function signature

dx ❓ unknown

Parameter inferred from function signature

dy ❓ unknown

Parameter inferred from function signature

restrictive ❓ unknown

Parameter inferred from function signature

Returns (inferred)

✅ boolean

Return type inferred from function name pattern

FrameworkZ.Tooltips:CheckSquareObstructions(square, stepX, stepY, isTargetSquare, restrictive)

method undocumented

No documentation available

Parameters (inferred)

square ❓ unknown

Parameter inferred from function signature

stepX ❓ unknown

Parameter inferred from function signature

stepY ❓ unknown

✅ boolean

Return type inferred from function name pattern

FrameworkZ.UI.CharacterPreview:new(x, y, width, height, defaultAnimation, defaultDirection)

method undocumented

No documentation available

Parameters (inferred)

x ❓ unknown

Parameter inferred from function signature

y ❓ unknown

Parameter inferred from function signature

width ❓ unknown

Parameter inferred from function signature

height ❓ unknown

Parameter inferred from function signature

defaultAnimation ❓ unknown

Parameter inferred from function signature

defaultDirection ❓ unknown

Parameter inferred from function signature

Returns (inferred)

📦 object

Return type inferred from function name pattern

FrameworkZ.UI.CharacterPreview:onAnimSelected(combo)

method undocumented

No documentation available

Parameters (inferred)

combo ❓ unknown

Parameter inferred from function signature

FrameworkZ.UI.CharacterPreview:onTurnChar(button, x, y)

method undocumented

No documentation available

Parameters (inferred)

button ❓ unknown

x ❓ unknown

Parameter inferred from function signature

y ❓ unknown

Parameter inferred from function signature

width ❓ unknown

Parameter inferred from function signature

height ❓ unknown

Parameter inferred from function signature

isoPlayer ❓ unknown

Parameter inferred from function signature

character ❓ unknown

Parameter inferred from function signature

name ❓ unknown

x ❓ unknown

Parameter inferred from function signature

y ❓ unknown

Parameter inferred from function signature

height ❓ unknown

Parameter inferred from function signature

entryWidth ❓ unknown

Parameter inferred from function signature

colorButtonWidth ❓ unknown

Parameter inferred from function signature

labelText ❓ unknown

Parameter inferred from function signature

clothingLocation ❓ unknown

newValue ❓ unknown

Parameter inferred from function signature

slider ❓ unknown

Parameter inferred from function signature

Returns (inferred)

📦 object

Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterInfo:onGenderChanged(dropdown)

method undocumented

No documentation available

Parameters (inferred)

dropdown ❓ unknown

Parameter inferred from function signature

Returns (inferred)

📦 object

Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterInfo:onHeightChanged(newValue, slider)

method undocumented

No documentation available

Parameters (inferred)

newValue ❓ unknown

Parameter inferred from function signature

slider ❓ unknown

Parameter inferred from function signature

Returns (inferred)

📦 object

Return type inferred from function name pattern

FrameworkZ.UI.CreateCharacterInfo:onWeightChanged(newValue, slider)

method undocumented

No documentation available

Parameters (inferred)

x ❓ unknown

Parameter inferred from function signature

y ❓ unknown

Parameter inferred from function signature

width ❓ unknown

Parameter inferred from function signature

height ❓ unknown

Parameter inferred from function signature

playerObject ❓ unknown

Parameter inferred from function signature

Returns (inferred)

📦 object

Return type inferred from function name pattern

FrameworkZ.UI.Introduction:onMuteToggle()

method undocumented

No documentation available

FrameworkZ.UI.Introduction:onVolumeChanged(newValue, slider)

method undocumented

No documentation available

Parameters (inferred)

newValue ❓ unknown

Parameter inferred from function signature

Parameter inferred from function signature

width ❓ unknown

Parameter inferred from function signature

height ❓ unknown

Parameter inferred from function signature

backButton ❓ unknown

Parameter inferred from function signature

forwardButton ❓ unknown

Parameter inferred from function signature

FrameworkZ.UI.MainMenu:initialise()

method undocumented

No documentation available

Returns (inferred)

✅ boolean

Return type inferred from function name pattern

FrameworkZ.UI.MainMenu:new(x, y, width, height, playerObject)

method undocumented

No documentation available

Parameters (inferred)

x ❓ unknown

Parameter inferred from function signature

y ❓ unknown

Parameter inferred from function signature

width ❓ unknown

backButton ❓ unknown

Parameter inferred from function signature

backButtonText ❓ unknown

Parameter inferred from function signature

forwardButtonIndex ❓ unknown

x ❓ unknown

Parameter inferred from function signature

y ❓ unknown

Parameter inferred from function signature

FrameworkZ.UI.Notification:onMouseMoveOutside(x, y)

method undocumented

No documentation available

Parameters (inferred)

x ❓ unknown

Parameter inferred from function signature

x ❓ unknown

Parameter inferred from function signature

y ❓ unknown

Parameter inferred from function signature

width ❓ unknown

Parameter inferred from function signature

height ❓ unknown

Parameter inferred from function signature

isoPlayer ❓ unknown

Parameter inferred from function signature

Returns (inferred)

📦 object

Return type inferred from function name pattern

FrameworkZ.UI.TabMenu:onClose()

method undocumented

No documentation available

FrameworkZ.UI.TabMenu:onOptionMouseDown(button, x, y)

method undocumented

No documentation available

Parameters (inferred)

button ❓ unknown

Parameter inferred from function signature

x ❓ unknown

Parameter inferred from function signature

Parameter inferred from function signature

y ❓ unknown

Parameter inferred from function signature

FrameworkZ.UI.TabSession:onClose(button, x, y)

method undocumented

No documentation available

Parameters (inferred)

button ❓ unknown

Parameter inferred from function signature

x ❓ unknown

Parameter inferred from function signature

Parameter inferred from function signature

y ❓ unknown

Parameter inferred from function signature

text ❓ unknown

Parameter inferred from function signature

target ❓ unknown

Parameter inferred from function signature

onClick ❓ unknown

Parameter inferred from function signature

Returns (inferred)

📦 object

Return type inferred from function name pattern

FrameworkZ.UserInterfaces:Initialize(uniqueID, userInterface)

method undocumented

No documentation available

Parameters (inferred)

uniqueID ❓ unknown

Parameter inferred from function signature

userInterface ❓ unknown

Parameter inferred from function signature

Returns (inferred)

⭕ void

Return type inferred from function name pattern

FrameworkZ.UserInterfaces:New(uniqueID, parent)

method undocumented

No documentation available

Parameters (inferred)

uniqueID ❓ unknown

Parameter inferred from function signature

parent ❓ unknown

Parameter inferred from function signature

Returns (inferred)

📦 object

Return type inferred from function name pattern

FrameworkZ.Utilities:CopyTable(originalTable, tableCopies, shouldCopyMetatable)

method

Copies a table.

Parameters

method undocumented

No documentation available

Parameters (inferred)

t1 ❓ unknown

Parameter inferred from function signature

t2 ❓ unknown

Parameter inferred from function signature

visited ❓ unknown

Parameter inferred from function signature

Returns (inferred)

❓ unknown

Return type inferred from function name pattern

FrameworkZ.Utilities:OrderedNext(t, state)

method undocumented

No documentation available

Parameters (inferred)

t ❓ unknown

Parameter inferred from function signature

Parameter inferred from function signature

FrameworkZ.Utilities:TableContainsValue(t, value)

method undocumented

No documentation available

Parameters (inferred)

t ❓ unknown

Parameter inferred from function signature

value ❓ unknown

Parameter inferred from function signature

FrameworkZ.Utilities:TableIsEmpty(t)

method undocumented

No documentation available

Parameters (inferred)

t ❓ unknown

Parameter inferred from function signature

Returns (inferred)

✅ boolean

Return type inferred from function name pattern

FrameworkZ.Utilities:TrimString(str, maxLength, addEllipsis)

method

Trims a string to a maximum length, optionally adding ellipsis.

Parameters

str 📝 string

The string to trim.

maxLength 🏷️ int

The maximum allowed length.

addEllipsis ✅ boolean

(Optional) If true, appends "..." if trimmed.

Returns

📝 string

The trimmed string.

FrameworkZ.Utilities:Unpack(t)

method undocumented

No documentation available

Parameters (inferred)

t ❓ unknown

Parameter inferred from function signature

FrameworkZ.Utilities:WordWrapText(text, maxLength, eolDelimiter)

method

Word wraps text to a specified length.

Parameters

text 📝 string

objectName ❓ unknown

Parameter inferred from function signature

Functions

FrameworkZ.Characters.PostLoad(data, characterData)

function

Post-load callback function for character initialization.

Parameters

No documentation available

Parameters (inferred)

player ❓ 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.Foundation.New()

function

Create a new instance of the FrameworkZ framework.

Returns

📋 table

The new instance of the FrameworkZ framework.

FrameworkZ.Foundation.OnGetData(data, namespace, keys, subscriptionID)

function

Network callback for getting data from storage.

Parameters

data 📋 table

The request data.

namespace 📝 string

The namespace to retrieve from.

keys 📝 string

or \table The key(s) to retrieve.

subscriptionID 📝 string

(Optional) Subscription ID for callback.

Returns

🏷️ mixed

The retrieved value.

FrameworkZ.Foundation.OnInitializePlayer(data)

function undocumented

No documentation available

Parameters (inferred)

data ❓ unknown

Parameter inferred from function signature

Returns (inferred)

⭕ void

Return type inferred from function name pattern

FrameworkZ.Foundation.OnRemoveData(data)

function

Client receives key removal broadcast.

Parameters

data 📋 table

The removal data containing namespace and key.

FrameworkZ.Foundation.OnSaveData(data)

function undocumented

No documentation available

Parameters (inferred)

data ❓ unknown

Parameter inferred from function signature

FrameworkZ.Foundation.OnSaveNamespace(data)

function

Client-side callback for saving a specific namespace.

Parameters

data 📋 table

The data containing the isoPlayer and namespace.

FrameworkZ.Foundation.OnSaveNamespace(data, namespace)

function

Server-side callback for saving a specific namespace.

Parameters

data 📋 table

The data containing the isoPlayer object.

namespace 📝 string

The namespace to save.

FrameworkZ.Foundation.OnSetData(data, namespace, keys, value, subscriptionID, broadcast)

function

Network callback for setting data in storage.

Parameters

data 📋 table

The request data.

namespace 📝 string

The namespace to store in.

keys 📝 string

or \table The key(s) to set.

value 🏷️ mixed

function undocumented

No documentation available

Parameters (inferred)

objTooltip ❓ unknown

Parameter inferred from function signature

item ❓ unknown

Parameter inferred from function signature

panel ❓ unknown

Parameter inferred from function signature

FrameworkZ.Overrides.onChatWindowInit()

function undocumented

No documentation available

Returns (inferred)

⭕ void

Return type inferred from function name pattern

FrameworkZ.Overrides.onMenuItemMouseDownMainMenu(item, x, y)

function undocumented

No documentation available

Parameters (inferred)

item ❓ unknown

Parameter inferred from function signature

x ❓ unknown

Parameter inferred from function signature

y ❓ unknown

Parameter inferred from function signature

FrameworkZ.Overrides.WordWrapText(text)

No documentation available

Parameters (inferred)

data ❓ unknown

Parameter inferred from function signature

characterID ❓ unknown

Parameter inferred from function signature

FrameworkZ.Tooltips.DrawTooltip()

function undocumented

No documentation available

FrameworkZ.Tooltips.OnTick()

function undocumented

No documentation available

FrameworkZ.Tooltips.RequestCharacterData(data, localUsername, targetUsername, requestingPlayer)

function undocumented

No documentation available

Parameters (inferred)

data ❓ unknown

Parameter inferred from function signature

localUsername ❓ unknown

Parameter inferred from function signature

targetUsername ❓ unknown

Parameter inferred from function signature

requestingPlayer ❓ unknown

Parameter inferred from function signature

FrameworkZ.UI.GetCenteredX(length, fontSize, text)

function

Get the x position to center text based on the text's width and what you're centering relative to.

Parameters

int 🏷️ length

The length of the object you're centering the text in.

string 🏷️ fontSize

The font size of the text (could be UIFont.Small, UIFont.Medium, UIFont.Large, or UIFont.Title).

string 🏷️ text

The text you're centering.

FrameworkZ.UI.GetHeight(fontSize, text)

function undocumented

No documentation available

Parameters (inferred)

Parameter inferred from function signature

Returns (inferred)

✅ boolean

Return type inferred from function name pattern

FrameworkZ API Documentation - FrameworkZ

FrameworkZ API Documentation - FrameworkZ

FrameworkZ

📋 On This Page

Fields

Methods

FrameworkZ.CharacterDataManager:AddItemToLogicalInventory(characterData, uniqueID, quantity)

Parameters

FrameworkZ.CharacterDataManager:CreateCharacterData(creationData, player)

Parameters

Returns

FrameworkZ.CharacterDataManager:DeepCopy(original)

Parameters

Returns

FrameworkZ.CharacterDataManager:ExtractItemData(item)

Parameters

Returns

FrameworkZ.CharacterDataManager:GenerateUID()

Returns

FrameworkZ.CharacterDataManager:RestoreCharacterAppearance(isoPlayer, characterData)

Parameters

Returns

FrameworkZ.CharacterDataManager:RestoreCharacterData(character, characterData)

Parameters

Returns

FrameworkZ.CharacterDataManager:RestoreInventoryData(character, characterData)

Parameters

Returns

FrameworkZ.CharacterDataManager:RestoreItemData(item, itemData)

Parameters

Returns

FrameworkZ.CharacterDataManager:RestoreSurvivorAppearance(survivor, characterData)

Parameters

Returns

FrameworkZ.CharacterDataManager:SaveCharacterData(character)

Parameters

Returns

FrameworkZ.CharacterDataManager:SaveInventoryData(character)

Parameters

Returns

FrameworkZ.CharacterDataManager:ValidateCharacterData(characterData)

Parameters

Returns

FrameworkZ.Characters:AddToCache(uid, character)

Parameters

Returns

FrameworkZ.Characters:AddToList(username, character)

Parameters

Returns

FrameworkZ.Characters:GetCharacterByID(username)

Parameters

Returns

FrameworkZ.Characters:GetCharacterByUID(uid)

Parameters

Returns

FrameworkZ.Characters:GetCharacterInventoryByID(username)

Parameters

Returns

FrameworkZ.Characters:Initialize(isoPlayer, id)

Parameters

Returns

FrameworkZ.Characters:New(isoPlayer, id)

Parameters

Returns

FrameworkZ.Characters:OnInitGlobalModData()

FrameworkZ.Characters:OnPostLoad(isoPlayer, characterData)

Parameters

Returns

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

Parameters

FrameworkZ.Characters:PlayerTick(player)

Parameters

FrameworkZ.Characters:RemoveFromCache(uid)

Parameters

Returns

FrameworkZ.Characters:RemoveFromList(username)

Parameters

Returns

FrameworkZ.Characters:Save(username)

Parameters