Templates

ClassWizard templates for GS_UI — custom UI animation motion tracks.
Categories:
Tags:

All GS_UI extension types are generated through the ClassWizard CLI. The wizard handles UUID generation and cmake file-list registration automatically.

For usage guides and setup examples, see The Basics: GS_UI.

python ClassWizard.py \
    --template <TemplateName> \
    --gem <GemPath> \
    --name <SymbolName> \
    [--input-var key=value ...]

 

Contents

Ui Motion Track

Template: UiMotionTrack

Creates a custom animation track for the GS_UI motion system. A UiMotionTrack child animates one LyShine UI element property (position, scale, alpha, color, rotation, etc.) over a normalised [0,1] eased progress value. Tracks are added to UiMotionAnimations assets in the editor and played by UIMotionAnimationComponent.

Generated files:

  • Include/${GemName}/UIMotions/MotionTracks/${Name}Track.h
  • Source/UIMotions/MotionTracks/${Name}Track.cpp

CLI:

python ClassWizard.py --template UiMotionTrack --gem <GemPath> --name <Name>

Post-generation — manual registration required:

In UIDataAssetsSystemComponent.cpp, add:

#include <path/to/${Name}Track.h>
// inside Reflect(context):
${Name}Track::Reflect(context);

Extensibility: One track class per animatable property. Any number of track types can be registered. Instances are stored as polymorphic pointers in UiMotionAnimation assets — the property editor’s type picker discovers them automatically via O3DE’s serialization reflection (EnumerateDerived).

See also: UI Animation — the full track architecture, domain extension pattern, and built-in track type reference.

See Also

For the full API, component properties, and C++ extension guide:

For all ClassWizard templates across GS_Play gems:

Get GS_UI

GS_UI — Explore this gem on the product page and add it to your project.