Teams¶
This page documents the hooks defined by the teams module.
CanCharBeTransfered(character, targetValue, previousValue)View Source
Purpose
Determines whether a character may be transferred to a different faction or class.
Realm
Server
Parameters
Character character The character being transferred.
number|string targetValue The destination faction or class identifier.
number|string previousValue The character's current faction or class identifier.
Returns
boolean|nil Return false to block the transfer.
CanInviteToClass(client, target)View Source
Purpose
Determines whether a player may invite another player to a class.
Realm
Server
Parameters
Returns
boolean|nil Return false to block the class invitation.
CanInviteToFaction(client, target)View Source
Purpose
Determines whether a player may invite another player to a faction.
Realm
Server
Parameters
Returns
boolean|nil Return false to block the faction invitation.
CanPlayerJoinClass(client, class, info)View Source
Purpose
Determines whether a player may join a class during class eligibility checks.
Realm
Server
Parameters
Player client The player attempting to join the class.
number class The class index being checked.
table info The registered class data for the class.
Returns
boolean|nil Return false to block the class join attempt.
CheckFactionLimitReached(faction, character, client)View Source
Purpose
Allows code to override faction population limit checks.
Realm
Server
Parameters
number|string faction The faction being checked.
Character character The character being evaluated for the faction.
Player client The player associated with the character.
Returns
boolean|nil Return true when the faction should be treated as full.
OverrideFactionDesc(uniqueID, desc)View Source
Purpose
Allows clientside code to override a faction description before display.
Realm
Client
Parameters
string uniqueID The faction unique ID or display identifier.
string desc The current faction description text.
Returns
string|nil Return replacement description text.
OverrideFactionModelCustomization(client, faction, context, skinAllowed, bodygroupsAllowed)View Source
Purpose
Allows clientside code to override whether faction model skins or bodygroups may be customized.
Realm
Client
Parameters
Player client The player viewing or creating the character.
table faction The faction data being customized.
any context The customization context provided by the caller.
boolean skinAllowed The current skin customization permission.
boolean bodygroupsAllowed The current bodygroup customization permission.
Returns
boolean|nil, boolean|nil Return replacement values for skin and bodygroup customization permissions.
OverrideFactionModels(uniqueID, models)View Source
OverrideFactionName(uniqueID, name)View Source
Purpose
Allows clientside code to override a faction name before display.
Realm
Client
Parameters
Returns
string|nil Return replacement faction name text.