worldconditions kit
57 tools. Generated from the plugin source; do not edit by hand.
Guide
worldconditions.* is a UE 5.8-only kit for Epic's experimental WorldConditions plugin. It owns schema and context descriptor discovery, condition/type/operator catalogs, query-definition inspection, schema assignment, initialization, cache audits, and host-property discovery.
Begin with worldconditions.list_schema_classes, inspect one with list_schema_contexts, then locate a host with list_query_host_classes and inspect its FWorldConditionQueryDefinition property. Use set_query_schema, list_query_conditions, and initialize_query only for an existing editable definition. Finish with audit_query.
worldconditions.create_query_host creates a data asset of a class that declares FWorldConditionQueryDefinition properties (for example /Script/SmartObjectsModule.SmartObjectDefinition, property Preconditions), so the query tools have an editable definition. The kit does not create generic schemas: UWorldConditionSchema keeps context descriptor construction protected, and the engine does not ship a general-purpose concrete schema. It also does not evaluate conditions from JSON. Epic's evaluation API requires FWorldConditionContextData populated with exact native objects/structs and uses runtime invalidation handles whose lifetime ends with the active query context.
UE 4.27 has no World Conditions plugin. All tools declare MinEngine="5.8" and RequiresPlugin="WorldConditions".
With SmartObjects enabled, /Script/SmartObjectsModule.SmartObjectWorldConditionSchema is a concrete schema (contexts UserActor, SmartObjectActor, SmartObjectHandle, SlotHandle, Subsystem) and /Script/SmartObjectsModule.WorldCondition_SmartObjectActorTagQuery a concrete condition struct. Set the schema before initialize_query: initialization fails without one.
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
MaxAutoRiskneed"_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 thedryRunargument. smoke = covered byedit.self_test.
worldconditions.audit_catalog (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: item, notes.
worldconditions.audit_condition_type (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
type | string | required. Schema, condition, or host class path. |
limit | integer | Maximum returned properties. Default 200. |
Returns: item, notes.
worldconditions.audit_host_class (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
type | string | required. Schema, condition, or host class path. |
limit | integer | Maximum returned properties. Default 200. |
Returns: item, notes.
worldconditions.audit_query (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
object | string | required. Object containing an FWorldConditionQueryDefinition property. |
property | string | required. Reflected query-definition property name. |
Returns: item, notes.
worldconditions.audit_schema (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
schemaClass | string | required. World Condition schema class path. |
contextName | string | Optional context-data name. |
Returns: item, notes.
worldconditions.create_query_host (risk 2, mutates, UE 5.8+, requires plugin WorldConditions, smoke)
Creates a data asset of a class that hosts FWorldConditionQueryDefinition properties (for example SmartObjectDefinition), ready for query authoring.
| Argument | Type | Description |
|---|---|---|
folder | string | required. Destination folder under /Game. |
name | string | required. Bare asset name. |
class | string | required. Data asset class that declares at least one FWorldConditionQueryDefinition property, e.g. /Script/SmartObjectsModule.SmartObjectDefinition. |
Returns: item, notes.
worldconditions.find_schema_context (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
schemaClass | string | required. World Condition schema class path. |
contextName | string | Optional context-data name. |
Returns: item, notes.
worldconditions.get_capabilities (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: item, notes.
worldconditions.get_condition_struct (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
type | string | required. Schema, condition, or host class path. |
limit | integer | Maximum returned properties. Default 200. |
Returns: values, count, notes.
worldconditions.get_context_data_struct (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
schemaClass | string | required. World Condition schema class path. |
contextName | string | Optional context-data name. |
Returns: values, count, notes.
worldconditions.get_context_data_type (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
schemaClass | string | required. World Condition schema class path. |
contextName | string | Optional context-data name. |
Returns: values, count, notes.
worldconditions.get_query_cache_summary (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
object | string | required. Object containing an FWorldConditionQueryDefinition property. |
property | string | required. Reflected query-definition property name. |
Returns: values, count, notes.
worldconditions.get_query_definition (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
object | string | required. Object containing an FWorldConditionQueryDefinition property. |
property | string | required. Reflected query-definition property name. |
Returns: item, notes.
worldconditions.get_query_description (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
object | string | required. Object containing an FWorldConditionQueryDefinition property. |
property | string | required. Reflected query-definition property name. |
Returns: values, count, notes.
worldconditions.get_query_expression_text (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
object | string | required. Object containing an FWorldConditionQueryDefinition property. |
property | string | required. Reflected query-definition property name. |
Returns: values, count, notes.
worldconditions.get_query_owner (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
object | string | required. Object containing an FWorldConditionQueryDefinition property. |
property | string | required. Reflected query-definition property name. |
Returns: item, notes.
worldconditions.get_query_schema (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
object | string | required. Object containing an FWorldConditionQueryDefinition property. |
property | string | required. Reflected query-definition property name. |
Returns: values, count, notes.
worldconditions.get_query_struct_path (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: values, count, notes.
worldconditions.get_schema_class (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
type | string | required. Schema, condition, or host class path. |
limit | integer | Maximum returned properties. Default 200. |
Returns: values, count, notes.
worldconditions.get_schema_context (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
schemaClass | string | required. World Condition schema class path. |
contextName | string | Optional context-data name. |
Returns: item, notes.
worldconditions.get_schema_default_object (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
type | string | required. Schema, condition, or host class path. |
limit | integer | Maximum returned properties. Default 200. |
Returns: item, notes.
worldconditions.initialize_query (risk 2, mutates, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
object | string | required. Object containing an FWorldConditionQueryDefinition property. |
property | string | required. Reflected query-definition property name. |
Returns: item, notes.
worldconditions.list_actor_condition_structs (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: items, count, notes.
worldconditions.list_cache_structs (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: items, count, notes.
worldconditions.list_common_condition_structs (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: items, count, notes.
worldconditions.list_condition_base_fields (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: values, count, notes.
worldconditions.list_condition_context_refs (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
type | string | required. Schema, condition, or host class path. |
limit | integer | Maximum returned properties. Default 200. |
Returns: items, count, notes.
worldconditions.list_condition_properties (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
type | string | required. Schema, condition, or host class path. |
limit | integer | Maximum returned properties. Default 200. |
Returns: values, count, notes.
worldconditions.list_condition_structs (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: items, count, notes.
worldconditions.list_context_data_descriptors (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
schemaClass | string | required. World Condition schema class path. |
contextName | string | Optional context-data name. |
Returns: values, count, notes.
worldconditions.list_context_data_types (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: values, count, notes.
worldconditions.list_context_descriptor_fields (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: values, count, notes.
worldconditions.list_context_ref_properties (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: values, count, notes.
worldconditions.list_context_structs (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: items, count, notes.
worldconditions.list_dynamic_contexts (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
schemaClass | string | required. World Condition schema class path. |
contextName | string | Optional context-data name. |
Returns: items, count, notes.
worldconditions.list_editable_condition_fields (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: values, count, notes.
worldconditions.list_host_properties (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
type | string | required. Schema, condition, or host class path. |
limit | integer | Maximum returned properties. Default 200. |
Returns: items, count, notes.
worldconditions.list_invalidation_handle_fields (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: values, count, notes.
worldconditions.list_operators (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: values, count, notes.
worldconditions.list_persistent_contexts (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
schemaClass | string | required. World Condition schema class path. |
contextName | string | Optional context-data name. |
Returns: items, count, notes.
worldconditions.list_query_cache_fields (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: values, count, notes.
worldconditions.list_query_conditions (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
object | string | required. Object containing an FWorldConditionQueryDefinition property. |
property | string | required. Reflected query-definition property name. |
Returns: items, count, notes.
worldconditions.list_query_definition_properties (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: values, count, notes.
worldconditions.list_query_host_classes (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: items, count, notes.
worldconditions.list_query_operator_fields (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: values, count, notes.
worldconditions.list_query_properties (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
type | string | required. Schema, condition, or host class path. |
limit | integer | Maximum returned properties. Default 200. |
Returns: items, count, notes.
worldconditions.list_query_state_fields (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: values, count, notes.
worldconditions.list_query_structs (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: items, count, notes.
worldconditions.list_result_invalidation_contract (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: values, count, notes.
worldconditions.list_result_values (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: values, count, notes.
worldconditions.list_schema_classes (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
filter | string | Optional reflected-name filter. |
limit | integer | Maximum records from 1 through 2000. Default 200. |
Returns: items, count, notes.
worldconditions.list_schema_condition_candidates (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
schemaClass | string | required. World Condition schema class path. |
contextName | string | Optional context-data name. |
Returns: items, count, notes.
worldconditions.list_schema_contexts (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
schemaClass | string | required. World Condition schema class path. |
contextName | string | Optional context-data name. |
Returns: items, count, notes.
worldconditions.list_schema_properties (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
type | string | required. Schema, condition, or host class path. |
limit | integer | Maximum returned properties. Default 200. |
Returns: values, count, notes.
worldconditions.preflight_query_context (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
object | string | required. Object containing an FWorldConditionQueryDefinition property. |
property | string | required. Reflected query-definition property name. |
Returns: item, notes.
worldconditions.query_is_valid (risk 0, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
object | string | required. Object containing an FWorldConditionQueryDefinition property. |
property | string | required. Reflected query-definition property name. |
Returns: values, count, notes.
worldconditions.set_query_schema (risk 2, mutates, UE 5.8+, requires plugin WorldConditions, smoke)
No description.
| Argument | Type | Description |
|---|---|---|
object | string | required. Object containing an FWorldConditionQueryDefinition property. |
property | string | required. Reflected query-definition property name. |
schemaClass | string | required. World Condition schema class path. |
Returns: item, notes.