Skip to content

Recognition

This page documents the hooks defined by the recognition module.


CharForceRecognized(ply, range)View Source

Purpose

Called after the recognition system force-recognizes nearby players for a speaker.

Realm

Server

Parameters

Player ply The player who triggered forced recognition.

string range The recognition range key that was used, such as `whisper`, `normal`, `talk`, or `yell`.


IsRecognizedChatType(chatType)View Source

Purpose

Lets code mark additional chat types as recognized chat for unknown-name masking.

Realm

Client

Parameters

string chatType The chat class unique ID being checked.

Returns

boolean|nil Return true to treat the chat type as recognition-sensitive.


OnCharRecognized(ply)View Source

Purpose

Called after a player recognizes another character through the recognition system.

Realm

Client / Server

Parameters

Player ply The player whose recognition data was updated.