unreal.SceneStateBlueprintableTask

class unreal.SceneStateBlueprintableTask(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

Base class for Blueprint Tasks. Following the design of blueprints, unlike C++ Tasks that have Logic and Instance Data separated, Blueprint Tasks holds the logic and mutable instance data together and so get allocated when the task starts. see: FSceneStateBlueprintableTaskWrapper

C++ Source:

  • Plugin: SceneState

  • Module: SceneState

  • File: SceneStateBlueprintableTask.h

finish_task() None

Called to indicate the task has completed

get_context_object() Object

Gets the context object of the scene state object

Return type:

Object

get_event_stream() SceneStateEventStream

Gets the scene state object’s event stream

Return type:

SceneStateEventStream

get_root_state() SceneStateObject

Gets the scene state object that owns this blueprint task

Return type:

SceneStateObject

receive_start() None

Called once when the Task starts

receive_stop(stop_reason) None

Called once when the Task ends

Parameters:

stop_reason (SceneStateTaskStopReason)

receive_tick(delta_seconds) None

Called every frame after the Task has started Must have bCanTick set to true see: USceneStateTask::CanTick

Parameters:

delta_seconds (float)