mass kit

65 tools. Generated from the plugin source; do not edit by hand.

Guide

mass.* is available on UE 5.8 when Epic's MassEntity and MassGameplay plugins are enabled. It owns Mass Entity Config assets, their local traits, trait configuration, reflected Mass catalogs, and guarded world-subsystem diagnostics. It does not expose arbitrary entity-handle mutation: those handles and query lifetimes cannot be represented safely across MCP calls.

Start with mass.create_config, then mass.list_trait_classes, mass.add_trait, and mass.set_trait_property. Use mass.audit_config before mass.validate_template; validation needs a Mass-enabled editor world. mass.list_fragment_types, mass.list_processor_classes, and the crowd/navigation/representation/signal catalogs show only classes reflected by enabled Mass extension modules.

mass.spawn_config creates transient runtime entities from a valid config and is risk 3; it refuses configs whose template is invalid (for example a config with no traits). It is SmokeSkip because spawned entities cannot be removed through MCP. Runtime entity/archetype counts are only returned in builds that enable Epic's Mass debug API.

Useful recipes: create a base config then set a parent config; discover a movement or representation trait class before adding it; inspect an existing config's traits and properties; audit loaded optional MassAI extensions; validate a template and then spawn a bounded test batch in a Mass-enabled world.

UE 4.27 has no Mass Entity/MassGameplay API surface, so every tool is hidden with MinEngine="5.8" and plugin gates.

Concrete names that exist on UE 5.8 with MassGameplay: trait /Script/MassMovement.MassVelocityRandomizerTrait (properties MinSpeed, MaxSpeed, bSetZComponent), fragment /Script/MassCommon.AgentRadiusFragment, processor /Script/MassLOD.MassSimulationLODProcessor. mass.duplicate_config copies a config (traits and parent included) next to the source, which is the quickest way to get a child for mass.set_parent_config.

Tools

Legend. risk 0 = read-only, 1 = harmless editor op, 2 = modifies asset, 3 = deletes/replaces asset, 4 = project/config/build op, 5 = potentially destructive (calls above MaxAutoRisk need "_confirm": true). mutates = runs in a transaction (edit.undo reverts). requires PIE / requires world = refused without a PIE session / an open level. requires plugin = unavailable while the plugin is disabled. dryRun = honours the dryRun argument. smoke = covered by edit.self_test.

mass.add_trait (risk 2, mutates, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
asset	string	required. Mass Entity Config asset object path.
traitClass	string	required. Mass trait class path.
exactMatch	boolean	Require an exact trait class match. Default false.

Returns: item, notes.

mass.audit_catalog (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: item, notes.

mass.audit_config (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
asset	string	required. Mass Entity Config asset object path.

Returns: item, notes.

mass.audit_runtime (risk 0, UE 5.8+, requires plugin MassEntity, requires world, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: item, notes.

mass.audit_trait (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
asset	string	required. Mass Entity Config asset object path.
traitClass	string	required. Mass trait class path.
exactMatch	boolean	Require an exact trait class match. Default false.

Returns: item, notes.

mass.audit_trait_requirements (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
asset	string	required. Mass Entity Config asset object path.

Returns: item, notes.

mass.clear_parent_config (risk 2, mutates, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
asset	string	required. Mass Entity Config asset object path.

Returns: item, notes.

mass.create_config (risk 2, mutates, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
folder	string	required. Destination folder below /Game.
name	string	required. Bare asset name.
parent	string	Optional parent Mass Entity Config asset.

Returns: item, notes.

mass.duplicate_config (risk 2, mutates, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

Duplicates a Mass Entity Config asset (traits and parent included) into the same folder under a new name.

Argument	Type	Description
asset	string	required. Mass Entity Config asset object path to copy.
name	string	required. New bare asset name created next to the source.

Returns: item, notes.

mass.get_archetype_count (risk 0, UE 5.8+, requires plugin MassEntity, requires world, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: values, count, notes.

mass.get_archetype_details (risk 0, UE 5.8+, requires plugin MassEntity, requires world, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: values, count, notes.

mass.get_capabilities (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: item, notes.

mass.get_command_flush_status (risk 0, UE 5.8+, requires plugin MassEntity, requires world, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: values, count, notes.

mass.get_config (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
asset	string	required. Mass Entity Config asset object path.

Returns: item, notes.

mass.get_config_guid (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
asset	string	required. Mass Entity Config asset object path.

Returns: values, count, notes.

mass.get_config_property (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
asset	string	required. Mass Entity Config asset object path.

Returns: values, count, notes.

mass.get_entity_count (risk 0, UE 5.8+, requires plugin MassEntity, requires world, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: values, count, notes.

mass.get_entity_manager_status (risk 0, UE 5.8+, requires plugin MassEntity, requires world, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: values, count, notes.

mass.get_fragment_type (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
type	string	required. Reflected class or struct path to inspect.
limit	integer	Maximum returned properties. Default 200.

Returns: values, count, notes.

mass.get_parent_config (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
asset	string	required. Mass Entity Config asset object path.

Returns: item, notes.

mass.get_processor_class (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
type	string	required. Reflected class or struct path to inspect.
limit	integer	Maximum returned properties. Default 200.

Returns: values, count, notes.

mass.get_runtime_debug_name (risk 0, UE 5.8+, requires plugin MassEntity, requires world, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: values, count, notes.

mass.get_runtime_status (risk 0, UE 5.8+, requires plugin MassEntity, requires world, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: item, notes.

mass.get_runtime_subsystem_properties (risk 0, UE 5.8+, requires plugin MassEntity, requires world, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: values, count, notes.

mass.get_spawner_status (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, requires world, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: item, notes.

mass.get_trait (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
asset	string	required. Mass Entity Config asset object path.
traitClass	string	required. Mass trait class path.
exactMatch	boolean	Require an exact trait class match. Default false.

Returns: item, notes.

mass.get_trait_class (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
type	string	required. Reflected class or struct path to inspect.
limit	integer	Maximum returned properties. Default 200.

Returns: values, count, notes.

mass.get_trait_property (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
asset	string	required. Mass Entity Config asset object path.
traitClass	string	required. Mass trait class path.
property	string	required. Reflected property name.
value	string	Unreal text value for a set operation.

Returns: values, count, notes.

mass.list_agent_trait_classes (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_chunk_fragment_types (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_config_properties (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
asset	string	required. Mass Entity Config asset object path.

Returns: values, count, notes.

mass.list_config_traits (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
asset	string	required. Mass Entity Config asset object path.

Returns: items, count, notes.

mass.list_configs (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_const_shared_fragment_types (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_crowd_classes (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_debug_classes (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_fragment_properties (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
type	string	required. Reflected class or struct path to inspect.
limit	integer	Maximum returned properties. Default 200.

Returns: values, count, notes.

mass.list_fragment_types (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_lod_trait_classes (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_look_at_trait_classes (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_movement_trait_classes (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_nav_mesh_trait_classes (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_navigation_classes (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_observer_processor_classes (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_processor_classes (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_query_classes (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_replication_trait_classes (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_representation_classes (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_shared_fragment_types (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_signal_classes (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_smart_object_trait_classes (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_spawner_classes (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_spawner_initializers (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, requires world, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_state_tree_trait_classes (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_tag_types (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_trait_classes (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_trait_net_modes (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
asset	string	required. Mass Entity Config asset object path.
traitClass	string	required. Mass trait class path.
exactMatch	boolean	Require an exact trait class match. Default false.

Returns: values, count, notes.

mass.list_trait_properties (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
type	string	required. Reflected class or struct path to inspect.
limit	integer	Maximum returned properties. Default 200.

Returns: values, count, notes.

mass.list_zone_graph_classes (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.list_zone_graph_trait_classes (risk 0, UE 5.8+, requires plugin MassEntity, smoke)

No description.

Argument	Type	Description
folder	string	Content folder to inspect. Default TEXT("/Game").
recursive	boolean	Include subfolders. Default true.
limit	integer	Maximum records from 1 through 2000. Default 200.
filter	string	Optional case-insensitive name or package filter.

Returns: items, count, notes.

mass.remove_trait (risk 2, mutates, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
asset	string	required. Mass Entity Config asset object path.
traitClass	string	required. Mass trait class path.
exactMatch	boolean	Require an exact trait class match. Default false.

Returns: item, notes.

mass.set_parent_config (risk 2, mutates, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
asset	string	required. Mass Entity Config asset to change.
parent	string	required. Parent Mass Entity Config asset.

Returns: item, notes.

mass.set_trait_property (risk 2, mutates, UE 5.8+, requires plugin MassEntity, MassGameplay, smoke)

No description.

Argument	Type	Description
asset	string	required. Mass Entity Config asset object path.
traitClass	string	required. Mass trait class path.
property	string	required. Reflected property name.
value	string	Unreal text value for a set operation.

Returns: item, notes.

mass.spawn_config (risk 3, mutates, UE 5.8+, requires plugin MassEntity, MassGameplay, requires world)

No description.

Argument	Type	Description
asset	string	required. Mass Entity Config asset object path.
count	integer	Number of entities to spawn, from 1 through 10000. Default 1.

Returns: item, notes.

mass.validate_template (risk 0, UE 5.8+, requires plugin MassEntity, MassGameplay, requires world, smoke)

No description.

Argument	Type	Description
asset	string	required. Mass Entity Config asset object path.

Returns: item, notes.