Kinetix Documentation
Website
  • đŸ–ī¸Welcome
  • đŸ•ēAbout Kinetix
  • đŸ–Œī¸User-Generated Emote
    • 🤖Video-to-animation AI
    • 🤸Kinetix Emote Standards
    • đŸĻ´Retargeting
    • 🏂Kinanim (Emote streaming)
    • đŸ–Šī¸Try the User-Generated Emote feature
  • INTEGRATION
    • 🤷SDK or API: what to choose
    • 🤩Kinetix SDK
      • âš™ī¸SDK - Core Package
      • 🧩SDK - Sample scene
      • 🧑‍đŸ’ģTested & approved Game Engines for the SDK
      • đŸ’ģSDK Integration in Unity
        • âŦ‡ī¸Set-up Unity & Import the SDK
          • 🔑Get your Game authentification API Key
          • âš™ī¸Setup your Unity environment
          • 🔧Install the Kinetix SDK in Unity
          • âŒ¨ī¸SDK Initialization - Unity
        • ⚡Quickstart - Unity SDK
        • đŸĻ‹SDK Core Modules activation - Unity
          • 🔐Account Management in Unity
          • 💃Animation System - Unity
            • đŸŽĸUnity's Animator System
            • 🎨Custom Animation System
            • đŸŒŗRoot Motion
              • RootMotion + NavMeshAgent
            • đŸŽžī¸Frame Controller
            • đŸ’ĒIK Controller
            • đŸĢĨAvatar Mask
          • đŸ“ļNetwork - Unity SDK
            • Photon PUN
            • Photon Fusion
        • đŸ•ēUser-Generated Emote integration (Unity)
          • Embedding the PWA in your Unity application
          • Validation / Retake
        • 🚧How to update Kinetix SDK in Unity?
        • 📕SDK API Reference - Unity
          • KinetixCore
          • KinetixCore.Account
          • KinetixCore.Animation
          • KinetixCore.Metadata
          • KinetixCore.Network
          • KinetixCore.UGC
        • 📂Unity SDK Changelog
      • đŸ•šī¸SDK Integration in Unreal Engine
        • âŦ‡ī¸Set-up Unreal Engine & Download the SDK
          • 🔑Get your Game authentification API Key
          • âš™ī¸Set up your Unreal Engine environment
          • 🔧Install the Kinetix SDK in Unreal
          • âŒ¨ī¸UE SDK Core Package Initialization
        • ⚡Quick Start
        • đŸĻ‹SDK Core Modules activation - Unreal
          • 🔐Account Management - UE
          • 💃Animation System - UE
            • Local player system in Unreal Engine
            • Avatar system in Unreal Engine
            • Without uploading an avatar (deprecated)
              • Animation in a Third Person Template
              • Animation in an existing project
          • đŸ“ļNetwork - UE SDK
        • đŸ•ēUser-Generated Emote integration (UE)
        • 📕SDK API Reference - UE
          • KinetixCore
          • KinetixCore.Account
          • KinetixCore.Animation
          • KinetixCore.Metadata
          • KinetixCore.Network
        • âŦ†ī¸Updating from 0.3 to 0.4
        • 📂UE SDK Changelog
    • 😍Kinetix API
      • 🔑Get your Authentification API key
      • 🔌API routes
      • đŸĒAPI Webhooks
      • 🏓Possible Return Codes
  • Management
    • đŸšĒDeveloper Portal
      • đŸ‘ŊAvatar Upload
      • 👮UGC Moderation
    • đŸ–Œī¸UGE: Guides & Best Practices
      • 📐User-Generated Emote specifications
      • 👌Video recording best practices
      • đŸ‘ģUser-Generate Emote Use Cases
  • SUPPORT
    • đŸ“ŦBugs reports & features requests
    • ❓FAQ
      • FAQ: General questions
      • FAQ: Unity SDK
      • FAQ: Unreal Engine SDK
    • 🤕Troubleshooting
    • 📚Glossary of terms
Powered by GitBook
On this page
  • Events
  • Public Methods

Was this helpful?

Export as PDF
  1. INTEGRATION
  2. Kinetix SDK
  3. SDK Integration in Unreal Engine
  4. SDK API Reference - UE

KinetixCore.Animation

Events

Event
Params
Description

OnRegisteredLocalPlayer

None

Called upon updated informations on account.

OnPlayedKinetixAnimationLocalPlayer

const FAnimationID&

Called upon animation being played from local player.

OnPlayedAnimationQueueLocalPlayer

const TArray<FAnimationID>&

Called upon animation queue is played from local player

OnAnimationStartOnLocalPlayerAnimator

const FAnimationID&

Called upon animation starts on animator

OnAnimationEndOnLocalPlayerAnimator

const FAnimationID&

Called upon animation ends on animator


Public Methods

Method
Returns
Description

RegisterLocalPlayerAnimator(

Animator _Animator

)

void

Register Local Player Animator

RegisterLocalPlayerAnimInstance(

UAnimInstance* InAnimInstance

)

void

Register Local Player AnimInstance

UnregisterLocalPlayer()

void

Unregister the Local Player

PlayAnimationOnLocalPlayer(

const FAnimationID& InAnimationID

)

void

Play animation on Local Player

PlayAnimationQueueOnLocalPlayer(

const TArray<FAnimationID>& InAnimationIDS,

bool _Loop

)

void

Play animation queue on Local Player

StopAnimationOnLocalPlayer()

void

Stop animation on local player

LoadLocalPlayerAnimation(

const FAnimationID& InAnimationId, FString& InLockID,

const FOnKinetixLocalAnimationLoadingFinished& OnSuccessDelegate

)

void

Load a local player animation

LoadLocalPlayerAnimations(

TArray<FAnimationID>& InAnimationIDs, FString& InLockID,

Action _OnSuccess

)

void

Load local player animations

UnloadLocalPlayerAnimation(

TArray<FAnimationID>& InAnimationID, FString& InLockID,

const FOnKinetixLocalAnimationLoadingFinished& OnSuccessDelegate

)

void

Unload a local player animation

UnloadLocalPlayerAnimations(

TArray<FAnimationID>& InAnimationIDs, FString& InLockID,

Action _OnSuccess

)

void

Unload local player animations

GetLocalKCC()

UKinetixCharacterComponent*

Get the Local Kinetix Character Component [Returns : Local Kinetix Character Component]

PreviousKinetixCore.AccountNextKinetixCore.Metadata

Last updated 1 year ago

Was this helpful?

🤩
đŸ•šī¸
📕