For the complete documentation index, see llms.txt. This page is also available as Markdown.

Exports

toggleUI

Description: Toggles the visibility of the UI.

Usage:

exports['cdev_emotemenu']:toggleUI()

hideUI

Description: Hides the UI.

Usage:

exports['cdev_emotemenu']:hideUI()

blockUIUsage

Description: Blocks UI usage.

Parameters:

  • block (boolean): Determines whether to block the UI usage (true) or allow it (false).

Usage:


showUI

Description: Shows the UI.

Usage:


playAnimById

Description: Plays an animation by its ID.

Parameters:

  • animId (number): The ID of the animation to play.

  • customCoords (table, optional): Custom coordinates to play the animation at.

  • customHeading (number, optional): Custom heading to play the animation at.

  • freezePlayer (boolean, optional): Whether to freeze the player while playing the animation.

  • oldCoords (table, optional): The old coordinates of the player before playing the animation.

  • forceLoop (boolean, optional): Force the animation to loop.

  • customPerson (string, optional): The person/side to play the animation on (first or second person).

Usage:


setExpressionById

Description: Sets a facial expression by its ID.

Parameters:

  • expressionId (number): The ID of the expression to set.

Usage:


resetExpression

Description: Resets the facial expression to the default.

Usage:


initializeExpression

Description: Initializes the facial expression system.

Usage:


getExpression

Description: Retrieves the current facial expression ID.

Returns:

  • (number): The ID of the current expression.

Usage:


setWalkStyleById

Description: Sets a walk style by its ID.

Parameters:

  • walkStyleId (number): The ID of the walk style to set.

Usage:


resetWalkStyle

Description: Resets the walk style to the default.

Usage:


initializeWalkStyle

Description: Initializes the walk style system.

Usage:


getWalkStyle

Description: Retrieves the current walk style ID.

Returns:

  • (number): The ID of the current walk style.

Usage:


cancelAnim

Description: Cancels the current animation.

Usage:


isAnimRunning

Description: Checks if an animation is currently running.

Returns:

  • (boolean): true if an animation is running; otherwise, false.

Usage:


blockAnimationUsage

Description: Blocks or unblocks animation usage.

Parameters:

  • block (boolean): Set to true to block animations, or false to unblock them.

Usage:


registerAnimation

Description: Registers a new animation.

Parameters:

  • data (table): A table containing animation data with the following fields:

    • id (number): The ID of the animation.

    • category (string): The category of the animation.

    • thumbnail (string): The path to the thumbnail image.

    • label (string): The display label for the animation.

    • firstperson (table): Contains dict and anim for the animation.

    • vip (boolean, optional): Indicates if the animation is VIP-only.

Usage:


toggleExtraActionBlock

Description: Enables or disables (blocks/unblocks) the usage of a specific extra action (e.g., prone, handsup, crouch, point, ragdoll).

Parameters:

  • action ('prone' | 'handsup' | 'crouch' | 'point' | 'ragdoll'): The action to control.

  • toggle (boolean): Set to true to block the action or false to unblock it.

Usage:


isExtraActionDisabled

Description: Checks whether a specific extra action is currently disabled.

Parameters:

  • action ('prone' | 'handsup' | 'crouch' | 'point' | 'ragdoll'): The action to check.

Returns:

  • (boolean): true if the action is disabled; otherwise, false.

Usage:


BlockIdleAnimation

Description: Blocks the idle animation from playing automatically.

Usage:


UnblockIdleAnimation

Description: Unblocks the idle animation, allowing it to play automatically again.

Usage:


Notes

Installation: Ensure that the cdev_emotemenu resource is properly installed and running on your server. Replace 'cdev_emotemenu' with the appropriate resource name if it differs.

Optional Parameters: Optional parameters can be omitted or set to nil.

Reference: Consult the resource documentation for specific IDs and available animations.

Last updated