Skip to main content

Component Properties

This page summarizes inspector-facing properties by component.

Use it when you know the concept but need to remember which field controls the behavior.

SaveFlowNodeSource

PropertyDefaultNotes
save_key""Empty derives the key from the target node name.
targetnullEmpty usually means the parent/nearby object is the target.
property_selection_modeExported + additionalDefault works for most gameplay nodes.
additional_properties[]Use sparingly for non-exported saved properties.
ignored_properties[]Use when exported editor fields should not persist.
include_target_built_instrueSaves built-in engine state where supported.
included_target_builtin_ids[]Usually managed through preview UI.
target_builtin_field_overrides{}Advanced field whitelist.
included_paths[]Child participants in the same saved object.
excluded_paths[]Excludes reachable children.
participant_discovery_modeRecursiveUse Direct for simpler prefab shapes.
warn_on_missing_targettrueKeep on except for temporary authoring states.
warn_on_missing_participantstrueCatches stale child paths.
warn_on_missing_propertytrueCatches renamed or removed properties.

SaveFlowTypedDataSource

PropertyDefaultNotes
datanullDirect typed Resource provider.
targetnullNode provider or owner.
data_property""Property on target containing the provider.
data_version1Inherited from SaveFlowDataSource.

SaveFlowEntityCollectionSource

PropertyDefaultNotes
target_containernullEmpty means resolve the authored container shape.
failure_policyFail On Missing Or InvalidUse Report Only during iteration.
restore_policyCreate MissingGood default for runtime collections.
include_direct_children_onlytrueKeep true unless entities live deeper.
entity_factorynullRequired for create/restore workflows.
auto_register_factorytrueStandard scene-owned workflow.

The Entity Collection inspector preview includes a Last Restore row after a gather or restore has produced a report.

SaveFlowPrefabEntityFactory

PropertyDefaultNotes
target_containernullContainer for restored instances.
auto_create_containerfalseUseful in simple demos, be explicit in real scenes.
container_nameRuntimeEntitiesUsed only when auto-creating.
type_key""Must match entity descriptor type keys.
entity_scenenullPrefab to instantiate.

SaveFlowSlotWorkflow

PropertyDefaultNotes
active_slot_index0Project-owned selected slot index.
slot_id_templateslot_{index}Converts index to storage key.
empty_display_name_templateSlot {index}Used for empty save cards.
metadata_scriptSaveFlowSlotMetadataCan create a subclassed metadata type.

SaveFlowPipelineSignals

PropertyDefaultNotes
enabledtrueDisables signal bridge when false.
listen_modeOwner OnlyOwner, owner descendants, or all events.
targetemptyOptional target node path.