Recognition

Hook Documentation for Recognition Module.

Functions

MODULE:CharRecognize(level, name)

Initiates character recognition process.

Parameters

  • level Integer

    The recognition level.

  • name String

    The name of the character to be recognized.

MODULE:GetDisplayedDescription(entity, isHUD)

Retrieves the displayed description of an entity. This hook is used to get the description that should be displayed for an entity, either on the HUD or in another context.

Parameters

  • entity Entity

    The entity whose description is being retrieved.

  • isHUD Boolean

    Whether the description is being displayed on the HUD.

Returns

  • string

    The description to be displayed.

MODULE:GetDisplayedName(client, chatType)

Retrieves the displayed name of a client. This hook is used to get the name that should be displayed for a client in a specific chat type.

Parameters

  • client Player

    The client whose displayed name is being retrieved.

  • chatType String

    The type of chat where the name will be displayed.

Returns

  • string

    The name to be displayed.

MODULE:OnCharRecognized(client, id)

Called when a character is recognized.

Parameters

  • client Player

    The client whose character is recognized.

  • id Integer

    Identifier for the recognized character.

MODULE:isCharFakeRecognized(character, id)

Checks if a character is fake recognized.

Parameters

  • character Character

    The character to check.

  • id Integer

    Identifier for the character.

MODULE:isCharRecognized(character, id)

Checks if a character is recognized.

Parameters

  • character Character

    The character to check.

  • id Integer

    Identifier for the character.

MODULE:isFakeNameExistant(name, nameList)

Checks if a fake name exists in the given character name list.

Parameters

  • name String

    The name to check.

  • nameList Table

    A list of character names.

Returns

  • True

    if the name exists in the list, false otherwise.

MODULE:isRecognizedChatType(chatType)

Determines if a chat type is recognized. This hook is used to check if a specific chat type is recognized within the system.

Parameters

  • chatType String

    The chat type being checked for recognition.

Returns

  • bool

    True if the chat type is recognized, false otherwise.