Administration

This page documents the hooks defined by the administration module.

---

CharListColumns(columns)View Source

Purpose

Allows code to add extra columns to the administration character list.

Realm

Client

Parameters

table columns The mutable list of character list column definitions.

---

CharListEntry(entry, row)View Source

Purpose

Allows code to append extra values to a generated character list row before it is sent to clients.

Realm

Server

Parameters

table entry The character entry data being serialized.

table row The mutable row data that will be sent to the client.

---

GetAdminESPTarget(ent, client)View Source

Purpose

Allows clientside code to override which entity should be treated as the admin ESP target.

Realm

Client

Parameters

Entity ent The entity currently under consideration.

Player client The local player drawing admin ESP.

Returns

Entity|false|nil Return a replacement target entity, or false to suppress the current target.

---

OnAdminSystemLoaded(groups, privileges)View Source

Purpose

Called after the administration system finishes loading usergroups and privileges.

Realm

Server

Parameters

table groups The registered administration groups.

table privileges The registered privilege definitions.

---

OnPrivilegeRegistered(privilege)View Source

Purpose

Called after a new administration privilege is registered.

Realm

Server

Parameters

table privilege The registered privilege definition.

---

OnPrivilegeUnregistered(privilege)View Source

Purpose

Called after an administration privilege is removed.

Realm

Server

Parameters

table privilege The privilege definition that was removed.

---

OnSetUsergroup(sid, newGroup, source, player)View Source

Purpose

Called after the administration system changes a player's usergroup.

Realm

Server

Parameters

string sid The SteamID being updated.

string newGroup The new usergroup name.

string source optional The source or provider that triggered the change.

Player player optional The online player object, if available.

---

OnUsergroupCreated(groupName, groupData)View Source

Purpose

Called after a new administration usergroup is created.

Realm

Server

Parameters

string groupName The created usergroup name.

table groupData The stored usergroup definition.

---

OnUsergroupPermissionsChanged(groupName, groupData)View Source

Purpose

Called after a usergroup's permissions are changed.

Realm

Server

Parameters

string groupName The updated usergroup name.

table groupData The updated usergroup definition.

---

OnUsergroupRemoved(groupName)View Source

Purpose

Called after an administration usergroup is removed.

Realm

Server

Parameters

string groupName The removed usergroup name.

---

OnUsergroupRenamed(oldName, newName)View Source

Purpose

Called after an administration usergroup is renamed.

Realm

Server

Parameters

string oldName The previous usergroup name.

string newName The new usergroup name.

---

PlayerGagged(target, admin)View Source

Purpose

Called after a player is gagged.

Realm

Server

Parameters

Player target The player who was gagged.

Player admin The admin who applied the gag.

---

PlayerMuted(target, admin)View Source

Purpose

Called after a player is muted.

Realm

Server

Parameters

Player target The player who was muted.

Player admin The admin who applied the mute.

---

PlayerUngagged(target, admin)View Source

Purpose

Called after a player is ungagged.

Realm

Server

Parameters

Player target The player who was ungagged.

Player admin The admin who removed the gag.

---

PlayerUnmuted(target, admin)View Source

Purpose

Called after a player is unmuted.

Realm

Server

Parameters

Player target The player who was unmuted.

Player admin The admin who removed the mute.

---

RunAdminSystemCommand(cmd, victim, dur, reason)View Source

Purpose

Allows clientside code to handle an admin command before the chat-command fallback runs.

Realm

Client

Parameters

string cmd The admin command being executed.

Player|string victim The target player or identifier.

number dur optional The optional duration for timed commands.

string reason optional The optional reason text supplied with the command.

Returns

boolean|nil, function|nil Return true and a callback to handle the command through the hook.

---