UAF (Animation Framework)

Every UAF (Animation Framework) command in CodeFizz Editor Agent, with parameters and examples.

25 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.

create_uaf_asset

Create any UAF asset: graph, system, shared variables, state tree, layer stack, blend mask/profile, sets, labels

Parameter	Type	Required	Description
asset_path	string	Yes	Content path of the new asset
asset_type	string	Yes	anim_graph, system, shared_variables, state_tree, layer_stack, blend_mask, blend_profile, set_collection, set_binding, label_collection, label_binding, or a UAF class/New-menu name
skeleton	string	No	Skeleton asset; required for blend_mask and blend_profile
profile_type	string	No	blend_profile only: WeightFactor (default) or TimeFactor

example

cfa create_uaf_asset --asset-path /Game/Anim/AG_Locomotion --asset-type anim_graph
cfa create_uaf_asset --asset-path /Game/Anim/BM_UpperBody --asset-type blend_mask --skeleton /Game/Characters/Mannequins/Meshes/SK_Mannequin

get_uaf_asset

Summarise a UAF asset: entries, functions, categories, compile state

Parameter	Type	Required	Description
filter	string	No	Substring of entry or function names
max_results	int	No	Maximum entries returned

example

cfa get_uaf_asset --asset-path /Game/Anim/AG_Locomotion

export_uaf_asset

Export a whole UAF asset to JSON

Parameter	Type	Required	Description
output_path	string	No	File to write. Empty = Saved/CodeFizzEditorAgent/Exports/<asset>_<stamp>.json
inline	bool	No	Return the document inline instead of writing a file

example

cfa export_uaf_asset --asset-path /Game/Anim/AG_Locomotion

add_uaf_variable

Add typed variables to a UAF asset

Parameter	Type	Required	Description
variables	json	No	Batch: [{name, type, default_value, access, category, comment}]. Pass via --json
name	string	No	Single variable: name
type	string	No	Single variable: C++ type
default_value	string	No	Single variable: default as text (1.5, true, (X=1,Y=2,Z=3), an enum value, an asset path)
access	string	No	public or private (UAF makes new variables public)
category	string	No	Category; created when missing
comment	string	No	Tooltip comment

example

cfa add_uaf_variable --asset-path /Game/Anim/AG_Locomotion --name Speed --type float --default-value 0 --category Locomotion
cfa add_uaf_variable --json '{"asset_path":"/Game/Anim/AG_Locomotion","variables":[{"name":"Speed","type":"float"},{"name":"WalkAnim","type":"TObjectPtr<UAnimSequence>"}]}'

set_uaf_variable

Rename, retype or edit a UAF variable

Parameter	Type	Required	Description
name	string	Yes	The variable to change
new_name	string	No	Rename to this
type	string	No	New C++ type
default_value	string	No	New default as text
access	string	No	public or private
category	string	No	New category; created when missing
comment	string	No	New tooltip comment

example

cfa set_uaf_variable --asset-path /Game/Anim/AG_Locomotion --name Speed --default-value 150 --access private

remove_uaf_entry

Remove variables, graphs or shared-variable references

Parameter	Type	Required	Description
names	stringlist	Yes	Entry names to remove

example

cfa remove_uaf_entry --asset-path /Game/Anim/AG_Locomotion --names Speed,OldGraph

add_uaf_graph

Add an event graph or animation graph to a UAF asset

Parameter	Type	Required	Description
name	string	Yes	New graph name
kind	string	No	event or animation
event	string	No	Event graph only: the event that runs it

example

cfa add_uaf_graph --asset-path /Game/Anim/SYS_Character --name LateUpdate --kind event --event PostPhysics

add_uaf_shared_variables

Use the variables of a Shared Variables asset or a struct

Parameter	Type	Required	Description
source	string	Yes	UAF Shared Variables asset path, or a struct path

example

cfa add_uaf_shared_variables --asset-path /Game/Anim/AG_Locomotion --source /Game/Anim/SV_Locomotion

set_uaf_category

Add, rename or remove a variable/function category

Parameter	Type	Required	Description
action	string	Yes	add, rename or remove
name	string	Yes	Category name
new_name	string	No	rename only: the new name

example

cfa set_uaf_category --asset-path /Game/Anim/AG_Locomotion --action rename --name Loco --new-name Locomotion

compile_uaf_asset

Compile a UAF asset and return its errors and warnings

example

cfa compile_uaf_asset --asset-path /Game/Anim/AG_Locomotion

validate_uaf_asset

Validate a UAF asset with a verdict

example

cfa validate_uaf_asset --asset-path /Game/Anim/AG_Locomotion

get_uaf_blend_weights

Read a UAF Blend Mask or Blend Profile's weights

Parameter	Type	Required	Description
filter	string	No	Substring matched against entry names
overridden_only	bool	No	Only entries with a weight of their own
max_results	int	No	Maximum entries; truncation is reported

example

cfa get_uaf_blend_weights --asset-path /Game/Anim/BM_UpperBody --overridden-only

set_uaf_blend_weights

Edit a UAF Blend Mask or Blend Profile's weights

Parameter	Type	Required	Description
ops	json	Yes	Operations: {"set":name,"value":n,"subtree":bool}, {"inherit":name}, {"add_curve":name,"parent":name,"value":n}, {"add_attribute":name,"parent":name}, {"remove":name}

example

cfa set_uaf_blend_weights --asset-path /Game/Anim/BM_UpperBody --json '{"ops":[{"set":"root","value":0},{"set":"spine_01","value":1,"subtree":true},{"add_curve":"Blink","parent":"head","value":0.5}]}'

search_uaf_nodes

Rank the nodes a UAF graph accepts by keyword

Parameter	Type	Required	Description
query	string	No	Words to match, e.g. 'sequence player', 'run'
kinds	stringlist	No	Only these kinds: template, unit, trait, variable, function, dispatch
max_results	int	No	Maximum results (1..200)

example

cfa search_uaf_nodes --asset-path /Game/Anim/AG_Locomotion --query "blend space" --max-results 5
cfa search_uaf_nodes --asset-path /Game/Anim/AG_Locomotion --kinds trait

describe_uaf_node_type

Describe a UAF node type before placing it

Parameter	Type	Required	Description
id	string	Yes	template:X, trait:X, unit:X, dispatch:X, trait_stack, or a bare name
max_depth	int	No	Nested struct pin depth for units

example

cfa describe_uaf_node_type --id template:SequencePlayer

add_uaf_node

Add a node to a UAF graph, set it, wire it and place it

Parameter	Type	Required	Description
id	string	Yes	Node id from search_uaf_nodes, or a template/unit name
node_name	string	No	Explicit node name
traits	stringlist	No	trait_stack only: traits in stack order, base first
properties	json	No	{name: value} set on the new node, e.g. {"PlayRate":1.2}. Pass via --json
connect_to	string	No	Input pin the new node feeds, e.g. RigUnit_AnimNextGraphRoot.Result
connect_from	string	No	Output pin that feeds the new node
pos_x	float	No	Explicit X; omit for automatic placement
pos_y	float	No	Explicit Y; omit for automatic placement

example

cfa add_uaf_node --asset-path /Game/Anim/AG_Locomotion --id template:SequencePlayer --connect-to RigUnit_AnimNextGraphRoot.Result --json '{"properties":{"AnimSequence":"/Game/Anim/Walk","PlayRate":1.2,"LoopMode":"ForceLoop"}}'
cfa add_uaf_node --asset-path /Game/Anim/AG_Locomotion --id trait_stack --traits SequencePlayer,BlendSmoother

get_uaf_node

Read a UAF node: traits, properties, pins, links, layout

Parameter	Type	Required	Description
focus	bool	No	Also select the node in an open editor and frame its graph, so the Details panel shows it

example

cfa get_uaf_node --asset-path /Game/Anim/AG_Locomotion --node SequencePlayer

set_uaf_node

Set a UAF node's properties, layout, title or colour

Parameter	Type	Required	Description
properties	json	No	{name: value}. Pass via --json
layout	json	No	{show, hide, categories, display_names}. Pass via --json
title	string	No	New title (trait stack and template nodes)
color	string	No	New colour: (R=0.3,G=0.5,B=0.3,A=1) or 0.3,0.5,0.3

example

cfa set_uaf_node --asset-path /Game/Anim/AG_Locomotion --node SequencePlayer --json '{"properties":{"PlayRate":1.5,"LoopMode":"ForceLoop"},"layout":{"show":["PlayRate"]}}'

add_uaf_trait

Add a trait to a UAF trait stack node

Parameter	Type	Required	Description
trait	string	Yes	Trait display name, struct name or trait:X id
index	int	No	Stack position, 0 = base; -1 = on top

example

cfa add_uaf_trait --asset-path /Game/Anim/AG_Locomotion --node SequencePlayer --trait BlendSmoother

remove_uaf_trait

Remove a trait from a UAF trait stack node

Parameter	Type	Required	Description
trait	string	Yes	The trait, as get_uaf_node lists it

example

cfa remove_uaf_trait --asset-path /Game/Anim/AG_Locomotion --node SequencePlayer --trait NotifyDispatcher

move_uaf_trait

Move a trait within a UAF trait stack

Parameter	Type	Required	Description
trait	string	Yes	The trait to move
index	int	Yes	New stack position, 0 = base

example

cfa move_uaf_trait --asset-path /Game/Anim/AG_Locomotion --node SequencePlayer --trait BlendSmoother --index 1

set_uaf_node_template

Change a UAF trait stack node's template

Parameter	Type	Required	Description
template	string	Yes	Template: SequencePlayer, BlendSpacePlayer, BlendByBool...

example

cfa set_uaf_node_template --asset-path /Game/Anim/AG_Locomotion --node TraitStack --template BlendSpacePlayer

list_uaf_instances

List running UAF components

Parameter	Type	Required	Description
filter	string	No	Substring matched against actor, component path and system asset
max_results	int	No	Maximum instances returned; truncation is reported

example

cfa list_uaf_instances --filter SYS_Char

get_uaf_runtime

Read live variable and pin values of a running UAF instance

Parameter	Type	Required	Description
instance	string	No	Actor label, actor name or component path from list_uaf_instances; empty = the only running one
filter	string	No	Substring matched against variable names
max_results	int	No	Maximum variables per asset instance; truncation is reported
asset_path	string	No	UAF asset of the node whose pins to read (needs node)
node	string	No	Node whose live pin values to read (needs asset_path)
registers	bool	No	Also list every live RigVM work-memory register (name, type, value), filtered by filter

example

cfa get_uaf_runtime --instance BP_Hero --filter Speed
cfa get_uaf_runtime --instance BP_Hero --asset-path /Game/Anim/AG_Locomotion --node BlendByBool

set_uaf_runtime

Pause, resume or debug-draw a running UAF component

Parameter	Type	Required	Description
instance	string	No	Actor label, actor name or component path from list_uaf_instances; empty = the only running one
active	bool	No	true resumes, false pauses
debug_drawing	bool	No	Turn the component's debug drawing on or off

example

cfa set_uaf_runtime --instance BP_Hero --active=false

Loading…

PreviousChooser Tables NextConsole Commands