Kinetix AI Emote Creator for FiveM - Documentation
GitHubDiscord
  • ๐Ÿ–๏ธIntroduction
  • ๐Ÿ‘€Overview
  • ๐Ÿš€Get started
  • ๐Ÿ‘จโ€๐Ÿ’ปDeveloper Portal
    • Game/App Space - Creation
    • Game/App Space - Settings
  • โš™๏ธCore
    • User Creation
    • Emote generation
    • Webhook
    • User bag
    • Sharing emote
    • Validation / Retake process
    • Paywalls
    • File download
    • Playing animations
  • ๐Ÿ–ฅ๏ธInterface
    • Events
      • Server
      • Client
    • Render functions
      • CreateRootMenu()
      • CreateQRCodeAlert(url)
      • CreateMainMenu()
      • CreateEmoteBagMenu(emotes)
      • OpenEmoteBagMenu()
      • CreateProcessValidationMenu(process)
      • CreateEmoteCreatorMenu(processes)
      • CreateErrorMenu(statusCode, error)
      • NotifyProcessUpdate(process)
      • NotifyEmoteReady(data)
      • CreateEmoteWheel(emotes)
  • ๐Ÿ”ŒIntegrations
  • ๐ŸงชLive Demo
  • ๐Ÿ“šVideo recording Guidelines & AI Specs
    • AI Emote Creator - specifications
    • Video recording guidelines
Powered by GitBook
On this page
  1. Core

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.

PreviousPaywallsNextPlaying animations

Last updated 7 months ago

โš™๏ธ