Is there a free trial?

Yes. Start a free 3-day trial from your account at codefizz.dev/account, no credit card required. The trial unlocks the full Pro plugin for UE 5.6, 5.7 and 5.8 on one machine. When it ends, upgrade to a paid plan and the same key keeps working with five machine seats. There is also a separate free, open-source community edition (Unreal MCP).

Which Unreal Engine versions are supported?

UE 5.6, 5.7 and 5.8 on Win64. Each release ships as a separate binary plugin matched to the engine ABI, and the cfa CLI downloads the build that matches the engine you point it at. Future engine versions are added as they release.

Which platforms are supported?

Right now, Windows 64-bit only. The plugin is built and tested on Windows for this first release. Linux and Mac support are on the roadmap and will be added when there is clear demand from paying customers. I would rather wait until I can properly test those builds end to end than ship binaries I have not run myself. If you are on Mac or Linux and would buy the plugin today, drop a note in Discord or send me an email. That is how the priority for adding those platforms gets set.

Do I need a license key, and how do I enter it?

Activate from the CLI with your CodeFizz website account. Install or update the free cfa CLI, run cfa login, and sign in in the browser. That machine is activated and the editor plugin reads the same sign in, with nothing to paste inside Unreal. Offline grace still applies. A license key remains under License and billing for recovery and older cfa builds (cfa login --key), but new setups should use browser login only.

What MCP clients work with the plugin?

Any MCP-compatible client. The plugin exposes a TCP bridge and the Go CLI ships separately, so Claude Code, Cursor, VS Code, Gemini, and other MCP hosts all work out of the box.

Can I cancel anytime?

Yes. Open your account at codefizz.dev/account and click Manage billing to open the Polar billing portal, then cancel in one click. You keep access through the end of your billing period and stop being charged afterward.

What happens to my installed plugin if I cancel?

You keep the version you installed and it keeps working. Your license stays valid after you cancel, so the plugin does not switch off. You stop receiving new releases and you lose access to the private Discord and roadmap. The plugin you paid for is yours to keep.

Do you offer refunds?

No refunds on subscriptions, since the plugin is downloadable software you get immediately. You can cancel any time and keep access through the end of the period you have already paid for. If you ran into a real bug or a feature you reasonably expected to be there, email me and we will figure it out. Full policy on the Refund Policy page in the footer.

Why is Patron more expensive when I get the same plugin?

Patron is for people who want to influence the direction of CodeFizz Editor Agent, with voting, a private roadmap, priority answers, and direct input on new APIs. If you just need the plugin and updates, stay on Pro.

Is there a free version?

Yes. There is a free, open-source community edition (Unreal MCP) that gives you the core bridge and a basic command set, which is great for trying the workflow. The paid Pro edition is the fully maintained build with the complete toolset (Niagara, PCG, StateTree, Insights, and more), regular updates, and support. The open-source edition is linked in the footer.

Studio / team licensing?

For studios needing multiple seats, an enterprise tier is available off-platform. Contact directly for pricing.

UMG Widgets

Every UMG Widgets command in CodeFizz Editor Agent, with parameters and examples.

51 commands. Each shows its parameters and an example, and has a copyable deep link, so you (or an AI agent) can jump straight to one.

get_widget_tree

Get the widget hierarchy of a Widget Blueprint

Returns the full widget hierarchy of a Widget Blueprint as a tree. Shows each widget's class, name, and nesting level. Use this before add_widget or move_widget to understand the existing structure and find valid parent_widget_name values.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path

example

cfa get_widget_tree --widget-blueprint-path /Game/UI/WBP_MainHUD

add_widget

Add a widget to a Widget Blueprint

Adds a new widget as a child of an existing widget in a Widget Blueprint. The parent_widget_name must be a panel widget (CanvasPanel, VerticalBox, HorizontalBox, Overlay, etc.) that supports children. Use slot_properties to set layout properties that belong to the parent's slot type (e.g., Anchors and Offsets for CanvasPanel slots, Size.Value for box slots). Use widget_properties to set properties on the widget itself (e.g., Text, ColorAndOpacity, Font). Run list_widget_types to discover available widget classes.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_class	string	Yes	Widget class name
parent_widget_name	string	No	Parent panel name. Empty makes this the tree root.
widget_name	string	No	Widget name
index	int	No	Insert index among siblings (-1 = append)
is_variable	bool	No	Expose this widget as a Blueprint variable (the designer's 'Is Variable' tick) so it can be referenced in graphs / bound to events. Available after the implicit compile.
slot_properties	json	No	JSON object of slot properties
widget_properties	json	No	JSON object of widget properties

example

cfa add_widget --widget-blueprint-path /Game/UI/WBP_MainHUD --widget-class TextBlock --parent-widget-name RootCanvas --widget-name "TitleText" --widget-properties '{"Text":"Hello World"}'
cfa add_widget --widget-blueprint-path /Game/UI/WBP_MainHUD --widget-class Image --parent-widget-name MainOverlay --slot-properties '{"Padding":{"Left":10,"Top":5,"Right":10,"Bottom":5}}'
cfa add_widget --widget-blueprint-path /Game/UI/WBP_MainHUD --widget-class VerticalBox --parent-widget-name RootCanvas --widget-name "LeftPanel" --slot-properties '{"LayoutData":{"Anchors":{"Minimum":{"X":0,"Y":0},"Maximum":{"X":0.3,"Y":1}}}}'

remove_widget

Remove a widget from a Widget Blueprint

Removes a widget and all its children from a Widget Blueprint. The widget is identified by name. Use get_widget_tree to find the exact widget name before removing.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Widget name to remove
widget_object_path	string	No	Optional object path override for cross-asset addressing

example

cfa remove_widget --widget-blueprint-path /Game/UI/WBP_MainHUD --widget-name TitleText

move_widget

Move a widget to a new parent

Reparents a widget (and all its children) to a new parent widget within the same Widget Blueprint. The new parent must be a panel widget that supports children. Use index to control insertion order among siblings (-1 appends to end).

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Widget name
new_parent_name	string	Yes	New parent widget name
index	int	No	Insert index (-1 = append)

example

cfa move_widget --widget-blueprint-path /Game/UI/WBP_MainHUD --widget-name TitleText --new-parent-name HeaderBox
cfa move_widget --widget-blueprint-path /Game/UI/WBP_MainHUD --widget-name StatusPanel --new-parent-name RootCanvas --index 0

rename_widget

Rename a widget

Renames a widget within a Widget Blueprint. Updates all internal references to use the new name. The new name must be unique within the blueprint.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Current widget name
new_name	string	Yes	New widget name

example

cfa rename_widget --widget-blueprint-path /Game/UI/WBP_MainHUD --widget-name TextBlock_0 --new-name HealthLabel

duplicate_widget

Duplicate a widget

Creates a copy of a widget and all its children. The duplicate is placed under the same parent by default, or under a different parent if parent_widget_name is specified. Useful for creating repeated UI elements like list items or grid cells.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Widget name to duplicate
new_name	string	No	New widget name
parent_widget_name	string	No	Parent widget name
index	int	No	Insert index in the parent (-1 = append)

example

cfa duplicate_widget --widget-blueprint-path /Game/UI/WBP_MainHUD --widget-name ItemSlot --new-name ItemSlot2
cfa duplicate_widget --widget-blueprint-path /Game/UI/WBP_MainHUD --widget-name ResourceRow --new-name OreRow --parent-widget-name ResourceList

create_widget_blueprint

Create a new Widget Blueprint asset

Creates a new Widget Blueprint (UMG) asset from a UserWidget parent class. Optionally seeds a root panel widget (e.g. CanvasPanel) so add_widget can immediately target it as a parent.

Parameter	Type	Required	Description
path	string	Yes	Destination folder, e.g. /Game/Demo
name	string	Yes	Asset name, e.g. DemoWidgetTest
parent_class	string	No	Parent UserWidget class (default UserWidget)
root_widget_class	string	No	Optional root panel widget class to seed (e.g. CanvasPanel)

example

cfa create_widget_blueprint --path /Game/Demo --name DemoWidgetTest --root-widget-class CanvasPanel
cfa create_widget_blueprint --path /Game/UI --name WBP_Menu --parent-class UserWidget

list_widget_types

List available widget types

Lists all UWidget subclasses available for use with add_widget. Use filter to search by class name. Set panels_only=true to see only panel widgets (CanvasPanel, VerticalBox, HorizontalBox, Overlay, etc.) that can contain children and serve as parent_widget_name values.

Parameter	Type	Required	Description
filter	string	No	Filter by type name
include_abstract	bool	No	Include abstract classes
panels_only	bool	No	Show only panel widgets

example

cfa list_widget_types
cfa list_widget_types --filter "Text"
cfa list_widget_types --panels-only

wrap_widget

Wrap a widget in a new panel

Wraps a widget inside a newly-constructed panel (Border, SizeBox, Overlay, etc.) placed where the widget was; the widget becomes the wrapper's child.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Widget to wrap
wrapper_class	string	Yes	Panel class to wrap it in

example

cfa wrap_widget --widget-blueprint-path /Game/UI/WBP_Menu --widget-name TitleText --wrapper-class Border

replace_widget

Replace a widget with another class

Replaces a widget with a new widget of another class, carrying its children over when both are panels. The name and references are preserved.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Widget to replace
new_class	string	Yes	New widget class

example

cfa replace_widget --widget-blueprint-path /Game/UI/WBP_Menu --widget-name MainBox --new-class HorizontalBox

set_root_widget

Set the tree root widget

Makes a new or existing widget the root of the Widget Blueprint's tree. Provide widget_class to construct a new root, or widget_name to promote an existing widget.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_class	string	No	Class to construct as the new root (OR widget_name)
widget_name	string	No	Existing widget to make root (OR widget_class)

example

cfa set_root_widget --widget-blueprint-path /Game/UI/WBP_Menu --widget-class CanvasPanel

get_widget_properties

Read a widget's properties

Reads a widget's properties: all of them, filtered by name, or a single dotted/indexed property path (e.g. Brush.TintColor, Tags[0]).

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Target widget
property_path	string	No	Read one dotted/indexed path instead of all
filter	string	No	Lower-case substring filter on names (reading all)
widget_object_path	string	No	Optional object path override

example

cfa get_widget_properties --widget-blueprint-path /Game/UI/WBP_Menu --widget-name TitleText --property-path Text

set_widget_properties

Set a widget's properties (faithful)

Faithfully sets widget properties from a JSON key->value map (scalars, structs, arrays), firing the editor change pipeline so the result is identical to a Details-panel edit.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Target widget
properties	json	Yes	JSON object of property name->value
widget_object_path	string	No	Optional object path override

example

cfa set_widget_properties --widget-blueprint-path /Game/UI/WBP_Menu --widget-name TitleText --properties '{"Text":"Score","ColorAndOpacity":{"SpecifiedColor":{"R":1,"G":0,"B":0,"A":1}}}'

get_slot_properties

Read a widget's slot (layout) properties

Reads the panel-slot (layout) properties of a widget, anchors, offsets, padding, alignment, size, depending on the parent panel's slot type.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Widget whose slot is read
filter	string	No	Lower-case substring filter on names

example

cfa get_slot_properties --widget-blueprint-path /Game/UI/WBP_Menu --widget-name MainBox

set_slot_properties

Set a widget's slot (layout) properties (faithful)

Faithfully sets the panel-slot (layout) properties of a widget (anchors, offsets, padding, alignment). For CanvasPanel slots the live anchors/offsets are synchronized exactly like the designer.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Widget whose slot is set
properties	json	Yes	JSON object of slot property name->value
filter	string	No	Unused on set (shared param)

example

cfa set_slot_properties --widget-blueprint-path /Game/UI/WBP_Menu --widget-name MainBox --properties '{"Padding":{"Left":10,"Top":5,"Right":10,"Bottom":5}}'

set_widget_is_variable

Toggle a widget's Is Variable flag

Sets whether a widget is exposed as a Blueprint variable (the designer's 'Is Variable' tick) so it can be referenced in graphs and bound to events.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Target widget
is_variable	bool	No	Expose as a Blueprint variable

example

cfa set_widget_is_variable --widget-blueprint-path /Game/UI/WBP_Menu --widget-name TitleText --is-variable true

get_widget_class_info

Describe a widget class

Returns a widget class's parent, whether it is a panel, abstract flag, and (for panels) the UPanelSlot class it creates for children.

Parameter	Type	Required	Description
widget_class	string	Yes	Widget class (short/U-name/path/content path)

example

cfa get_widget_class_info --widget-class VerticalBox

set_widget_blueprint_parent

Reparent a Widget Blueprint

Reparents a Widget Blueprint onto a new UserWidget base class and recompiles.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
parent_class	string	Yes	New parent UserWidget class

example

cfa set_widget_blueprint_parent --widget-blueprint-path /Game/UI/WBP_Menu --parent-class /Game/UI/WBP_BaseMenu

list_named_slots

List the Widget Blueprint's named slots

Lists the NamedSlot widgets in the Widget Blueprint's tree and the widget currently placed in each.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	No	Unused (shared param)

example

cfa list_named_slots --widget-blueprint-path /Game/UI/WBP_Menu

get_named_slot_content

Get a named slot's content

Returns the widget currently placed in a NamedSlot (identified by slot_name) in the Widget Blueprint's tree.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	No	Unused (shared param)
slot_name	string	Yes	NamedSlot widget name
content_widget_name	string	No	Unused on get (shared param)
content_widget_class	string	No	Unused on get (shared param)

example

cfa get_named_slot_content --widget-blueprint-path /Game/UI/WBP_Menu --slot-name ExtraSlot

set_named_slot_content

Place a widget in a named slot

Places an existing widget (content_widget_name) or a newly-constructed widget (content_widget_class) into a NamedSlot (identified by slot_name) in the Widget Blueprint's tree.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	No	Unused (shared param)
slot_name	string	Yes	NamedSlot widget name
content_widget_name	string	No	Existing widget to place (OR content_widget_class)
content_widget_class	string	No	Class to construct into the slot (OR content_widget_name)

example

cfa set_named_slot_content --widget-blueprint-path /Game/UI/WBP_Menu --slot-name ExtraSlot --content-widget-class TextBlock

clear_named_slot

Clear a named slot

Removes the content from a NamedSlot (identified by slot_name) in the Widget Blueprint's tree.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	No	Unused (shared param)
slot_name	string	Yes	NamedSlot widget name
content_widget_name	string	No	Unused on clear (shared param)
content_widget_class	string	No	Unused on clear (shared param)

example

cfa clear_named_slot --widget-blueprint-path /Game/UI/WBP_Menu --slot-name ExtraSlot

set_widget_navigation

Set a widget's navigation rule for a direction

Sets the keyboard/gamepad navigation rule for one direction of a widget (Up/Down/Left/Right/Next/Previous). Rules: Escape, Explicit (needs target_widget), Wrap, Stop, Custom, CustomBoundary.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Target widget
direction	string	Yes	Up, Down, Left, Right, Next, or Previous
rule	string	Yes	Escape, Explicit, Wrap, Stop, Custom, CustomBoundary
target_widget	string	No	Widget to focus when rule is Explicit

example

cfa set_widget_navigation --widget-blueprint-path /Game/UI/WBP_Menu --widget-name PlayButton --direction Down --rule Explicit --target-widget QuitButton

get_widget_navigation

Get a widget's navigation

Returns all six navigation directions' rule and target for a widget.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Target widget

example

cfa get_widget_navigation --widget-blueprint-path /Game/UI/WBP_Menu --widget-name PlayButton

clear_widget_navigation

Reset a widget's navigation

Resets a widget's navigation rules to defaults.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Target widget

example

cfa clear_widget_navigation --widget-blueprint-path /Game/UI/WBP_Menu --widget-name PlayButton

add_property_binding

Bind a widget property to a function (legacy)

Adds a legacy property binding: the widget's property reads its value from a Blueprint function each frame (the designer's 'Bind' dropdown).

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Widget owning the property
property_name	string	Yes	Property to bind (e.g. Text)
function_name	string	Yes	Blueprint function returning the value

example

cfa add_property_binding --widget-blueprint-path /Game/UI/WBP_HUD --widget-name HealthText --property-name Text --function-name GetHealthText

remove_property_binding

Remove a legacy property binding

Removes a legacy property binding from a widget.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Widget owning the binding
property_name	string	Yes	Property whose binding to remove

example

cfa remove_property_binding --widget-blueprint-path /Game/UI/WBP_HUD --widget-name HealthText --property-name Text

list_property_bindings

List legacy property bindings

Lists all legacy property bindings on a Widget Blueprint.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path

example

cfa list_property_bindings --widget-blueprint-path /Game/UI/WBP_HUD

list_widget_events

List a widget's event delegates

Lists a widget's BlueprintAssignable multicast event delegates (e.g. OnClicked, OnHovered) that can be bound in the event graph.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Target widget

example

cfa list_widget_events --widget-blueprint-path /Game/UI/WBP_Menu --widget-name PlayButton

add_ui_component

Add a UI component to a widget (UE 5.8+)

Adds a UUIComponent of the given class to a widget. UE 5.8 only; returns an error on 5.6/5.7.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Target widget
component_class	string	Yes	UUIComponent subclass

example

cfa add_ui_component --widget-blueprint-path /Game/UI/WBP_Menu --widget-name PlayButton --component-class MyUIComponent

remove_ui_component

Remove a UI component from a widget (UE 5.8+)

Removes a UUIComponent of the given class from a widget. UE 5.8 only.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Target widget
component_class	string	Yes	UUIComponent subclass to remove

example

cfa remove_ui_component --widget-blueprint-path /Game/UI/WBP_Menu --widget-name PlayButton --component-class MyUIComponent

list_ui_components

List a widget's UI components (UE 5.8+)

Lists the UUIComponent classes attached to a widget. UE 5.8 only.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Target widget

example

cfa list_ui_components --widget-blueprint-path /Game/UI/WBP_Menu --widget-name PlayButton

create_widget_animation

Create a UMG animation

Creates a UWidgetAnimation (and its MovieScene) on a Widget Blueprint with the given length.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
name	string	Yes	Animation name
duration	float	No	Length in seconds

example

cfa create_widget_animation --widget-blueprint-path /Game/UI/WBP_Menu --name FadeIn --duration 0.5

list_widget_animations

List a Widget Blueprint's animations

Lists each animation's name, start/end time, and bound widget names.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path

example

cfa list_widget_animations --widget-blueprint-path /Game/UI/WBP_Menu

remove_widget_animation

Remove a UMG animation

Removes a named animation from a Widget Blueprint.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
name	string	Yes	Animation name

example

cfa remove_widget_animation --widget-blueprint-path /Game/UI/WBP_Menu --name FadeIn

add_animation_widget_binding

Bind a widget to an animation

Adds a MovieScene possessable + FWidgetAnimationBinding so an animation can target a widget.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
animation_name	string	Yes	Animation that targets the widget
widget_name	string	Yes	Widget to bind

example

cfa add_animation_widget_binding --widget-blueprint-path /Game/UI/WBP_Menu --animation-name FadeIn --widget-name TitleText

remove_animation_widget_binding

Remove a widget binding from an animation

Removes a widget's possessable + binding from an animation.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
animation_name	string	Yes	Animation name
widget_name	string	Yes	Bound widget

example

cfa remove_animation_widget_binding --widget-blueprint-path /Game/UI/WBP_Menu --animation-name FadeIn --widget-name TitleText

add_animation_track

Add a track to an animation

Adds a real MovieScene track (Opacity=RenderOpacity, Transform=RenderTransform, Color=ColorAndOpacity) bound to a widget on an animation. The widget must already be bound via add_animation_widget_binding.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
animation_name	string	Yes	Animation name
widget_name	string	Yes	Bound widget the track animates
track_type	string	Yes	Opacity \| Transform \| Color

example

cfa add_animation_track --widget-blueprint-path /Game/UI/WBP_Menu --animation-name FadeIn --widget-name TitleText --track-type Opacity

add_animation_key

Add a keyframe to an animation track

Adds a keyframe at a time (seconds) with a value on a track's channel. Transform channels: TranslationX/TranslationY/ScaleX/ScaleY/ShearX/ShearY/Angle; Color: R/G/B/A; Opacity ignores channel.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
animation_name	string	Yes	Animation name
widget_name	string	Yes	Bound widget
track_type	string	Yes	Opacity \| Transform \| Color
time	float	Yes	Key time in seconds
value	float	Yes	Key value
channel	string	No	Channel for Transform/Color tracks

example

cfa add_animation_key --widget-blueprint-path /Game/UI/WBP_Menu --animation-name FadeIn --widget-name TitleText --track-type Opacity --time 0 --value 0
cfa add_animation_key --widget-blueprint-path /Game/UI/WBP_Menu --animation-name FadeIn --widget-name TitleText --track-type Transform --time 1.0 --value 200 --channel TranslationY

list_animation_tracks

List an animation's tracks

Lists each track on an animation: bound widget, track type/property, section range, and per-channel key counts.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
animation_name	string	Yes	Animation name

example

cfa list_animation_tracks --widget-blueprint-path /Game/UI/WBP_Menu --animation-name FadeIn

add_viewmodel

Add an MVVM viewmodel

Adds a viewmodel context to a Widget Blueprint's MVVM view. Requires the ModelViewViewModel plugin (auto-enabled by this plugin).

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
view_model_class	string	Yes	Viewmodel class (short/U-name/path/content path)
name	string	No	Optional context name (auto-derived if empty)

example

cfa add_viewmodel --widget-blueprint-path /Game/UI/WBP_Menu --viewmodel-class /Game/UI/VM_Menu --name Menu

remove_viewmodel

Remove an MVVM viewmodel

Removes a viewmodel context by name.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
view_model_name	string	Yes	Viewmodel context name

example

cfa remove_viewmodel --widget-blueprint-path /Game/UI/WBP_Menu --viewmodel-name Menu

rename_viewmodel

Rename an MVVM viewmodel

Renames a viewmodel context.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
view_model_name	string	Yes	Current context name
new_name	string	Yes	New context name

example

cfa rename_viewmodel --widget-blueprint-path /Game/UI/WBP_Menu --viewmodel-name Menu --new-name MainMenu

list_viewmodels

List MVVM viewmodels

Lists viewmodel contexts (name/class/id/creation-type).

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path

example

cfa list_viewmodels --widget-blueprint-path /Game/UI/WBP_Menu

add_mvvm_binding

Add an MVVM binding

Binds a viewmodel property to a widget property. Auto-inserts a conversion function when types differ (e.g. FString->FText). Modes: OneTimeToDestination, OneWayToDestination (default), TwoWay, OneWayToSource. Execution: Immediate, Delayed, Tick, Auto.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Destination widget
widget_property	string	Yes	Destination property
view_model_name	string	Yes	Source viewmodel context
view_model_property	string	Yes	Source property
binding_mode	string	No	Binding mode (default OneWayToDestination)
execution_mode	string	No	Immediate, Delayed, Tick, Auto (default: project default)
conversion_function	string	No	Explicit conversion function (e.g. Conv_IntToText); overrides auto-detection
auto_convert	bool	No	Auto-insert a conversion when types differ (default true)
enabled	bool	No	Binding enabled at runtime (default true)

example

cfa add_mvvm_binding --widget-blueprint-path /Game/UI/WBP_Menu --widget-name TitleText --widget-property Text --viewmodel-name Menu --viewmodel-property Title

set_mvvm_binding

Modify an MVVM binding

Modifies an existing binding by id: binding mode, execution mode (Immediate/Delayed/Tick/Auto/Default), conversion function (name or None/Clear), enabled, compile.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
binding_id	string	Yes	Binding id (FGuid string)
binding_mode	string	No	Binding mode
execution_mode	string	No	Immediate, Delayed, Tick, Auto, or Default to clear override
conversion_function	string	No	Conversion function name, or None/Clear to remove
enabled	bool	No	Enable/disable the binding
compile	bool	No	Whether the binding compiles and runs

example

cfa set_mvvm_binding --widget-blueprint-path /Game/UI/WBP_Menu --binding-id <guid> --execution-mode Tick

list_mvvm_conversion_functions

List MVVM conversion functions

Lists valid conversion functions for a source viewmodel property -> destination widget property type pair, and whether the types are directly compatible.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
widget_name	string	Yes	Destination widget
widget_property	string	Yes	Destination property
view_model_name	string	Yes	Source viewmodel context
view_model_property	string	Yes	Source property

example

cfa list_mvvm_conversion_functions --widget-blueprint-path /Game/UI/WBP_Menu --widget-name TitleText --widget-property Text --viewmodel-name Menu --viewmodel-property Score

set_viewmodel_settings

Set viewmodel settings

Sets viewmodel context settings: creation type (Manual/CreateInstance/GlobalViewModelCollection/PropertyPath/Resolver/Context), public getter/setter, optional, expose-in-editor, global identifier/property path.

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
view_model_name	string	Yes	Viewmodel context name
creation_type	string	No	Manual, CreateInstance, GlobalViewModelCollection, PropertyPath, Resolver, Context
global_view_model_identifier	string	No	Global identifier (GlobalViewModelCollection)
view_model_property_path	string	No	Property path (PropertyPath creation type)
create_public_setter	bool	No	Generate a public setter
create_public_getter	bool	No	Generate a public getter
optional	bool	No	Do not warn if instance missing
expose_instance_in_editor	bool	No	Expose instance per-widget for editing
global_collection_update	bool	No	Auto-update from global collection

example

cfa set_viewmodel_settings --widget-blueprint-path /Game/UI/WBP_Menu --viewmodel-name Player --creation-type CreateInstance --create-public-getter true

set_variable_field_notify

Set variable Field Notify

Enables/disables Field Notify on a Blueprint member variable. Required for a viewmodel property to broadcast changes and drive reactive MVVM bindings.

Parameter	Type	Required	Description
blueprint_path	string	Yes	Blueprint owning the variable
variable_name	string	Yes	Member variable name
enabled	bool	No	Enable (true) or disable (false) Field Notify

example

cfa set_variable_field_notify --blueprint-path /Game/UI/VM_Player --variable-name Health --enabled true

remove_mvvm_binding

Remove an MVVM binding

Removes an MVVM binding by its id (FGuid).

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path
binding_id	string	Yes	Binding id (FGuid string)

example

cfa remove_mvvm_binding --widget-blueprint-path /Game/UI/WBP_Menu --binding-id <guid>

list_mvvm_bindings

List MVVM bindings

Lists MVVM bindings (id/source/destination/mode).

Parameter	Type	Required	Description
widget_blueprint_path	string	Yes	Widget Blueprint path

example

cfa list_mvvm_bindings --widget-blueprint-path /Game/UI/WBP_Menu

Loading…

PreviousObject Properties NextData Tables