File download

The DownloadYCD function enables the downloading and handling of emote data. Below is a detailed explanation of the function parameters and the process it follows.

function DownloadYCD(body, playerId, refresh, notify)

Parameters:

  • body: This parameter should contain the emote data returned from the API. It must include the files array with URLs pointing to the emote assets.

  • playerId: The FiveM ID of the player who initiated the emote creation process. This ID is used to identify the source of the emote.

  • refresh: A boolean value that, when true, streams the new emote to clients. This can be set to false for optimization purposes if refreshing is not required.

  • notify: A boolean value that, when true, triggers notification client events. Two specific events are triggered:

    • emote_ready: Broadcasts to every player, requesting the client to load the animation dictionary (anim dict) in memory.

    • emote_ready_notify: Sent specifically to the source player, requesting the client to display a notification about the emote readiness.

Last updated