FrameworkZ API - FrameworkZ.Logs

Home / FrameworkZ.Logs Module

FrameworkZ.Logs

module

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

1
Functions
13
Methods
5
Fields

📋 On This Page

Fields

5
FrameworkZ.Logs 📋 table
Logs module for FrameworkZ. Logs player actions, system events, errors, warnings, and informational messages.
Initial value: {}
FrameworkZ.Logs.LogDirectories ❓ unknown inferred
Initial value: { AdminLogs = { -- /AdminLogs/[username]/ "Audit", -- Bans, kicks, mutes, etc. "ItemSpawns", }, PlayerLogs = { -- /PlayerLogs/[username]/ "Actions", -- Enter/exit vehicle, grab/place/drop item, etc. "Chat", -- Everything entered into chat and who heard message "Commands", -- Commands entered into chat "Damage", -- Kills, deaths, and damage received/dealt
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.Logs.RootDirectory 📝 string inferred
Initial value: "FrameworkZ_Logs"

Methods

13

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

logType 📝 string
Optional log type to filter by.
player 📝 string
Optional player username to filter by.

Returns

📋 table
A table of log entries.

FrameworkZ.Logs:GetRootDirectory()

method undocumented
No documentation available

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Logs:Initialize()

method undocumented
No documentation available

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Logs:LoadLogsFromFile(player)

method
Load log entries from a file.

Parameters

player 📝 string
The player username to load logs for.

FrameworkZ.Logs:LogError(message)

method undocumented
No documentation available

Parameters (inferred)

message ❓ unknown
Parameter inferred from function signature

FrameworkZ.Logs:LogInfo(message)

method undocumented
No documentation available

Parameters (inferred)

message ❓ unknown
Parameter inferred from function signature

FrameworkZ.Logs:LogPlayerAction(player, action)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
action ❓ unknown
Parameter inferred from function signature

FrameworkZ.Logs:LogSystemEvent(message)

method undocumented
No documentation available

Parameters (inferred)

message ❓ unknown
Parameter inferred from function signature

FrameworkZ.Logs:LogWarning(message)

method undocumented
No documentation available

Parameters (inferred)

message ❓ unknown
Parameter inferred from function signature

FrameworkZ.Logs:OpenLogMenu()

method
Display logs in a menu for admins.

FrameworkZ.Logs:SaveLogToFile(logEntry)

method
Save a log entry to a file.

Parameters

logEntry 📋 table
The log entry to save.

FrameworkZ.Logs:SearchLogs(keyword)

method
Search log entries by keyword.

Parameters

keyword 📝 string
The keyword to search for.

Returns

📋 table
A table of log entries that contain the keyword.

Functions

1

FrameworkZ.Logs.OnWeaponHitCharacter(characterGivingDamage, characterTakingDamage, handWeapon, damage)

function
Log damage dealt to players from players and zombies.

Parameters

characterGivingDamage 📋 table
The character dealing the damage.
characterTakingDamage 📋 table
The character taking the damage.
handWeapon 📋 table
The weapon used to deal the damage.
damage 🔢 integer
The amount of damage dealt.