Decorators¶
What are the exact signatures?
ue.uclass¶
@ue.uclass
@ue.uclass(name=None, blueprintable=True, interfaces=(), always_relevant=None, net_update_frequency=None,
min_net_update_frequency=None, net_cull_distance=None, replicate_movement=None,
net_load_on_client=None, only_relevant_to_owner=None)
Turns a Python subclass of an Unreal class into a UClass. See Classes and
Components and net options.
ue.uproperty¶
ue.uproperty(default, *, readonly=False, transient=False, replicated=False, rep_notify=None,
category=None, meta=None)
ue.uproperty(*, default_factory, ...) # same options
See Properties.
ue.ufunction¶
@ue.ufunction
@ue.ufunction(pure=False, server=False, client=False, multicast=False, reliable=False,
category=None, meta=None)
See Functions and Remote calls.
ue.udelegate¶
@ue.udelegate
def on_event(self, a: int) -> None: ...
See Delegates.
ue.component¶
ue.component(cls, parent=None, *, replicated=False, **properties)
See Components.
ue.uenum, ue.ustruct¶
@ue.uenum(name=None) # on an enum.IntEnum
@ue.ustruct(name=None) # on a ue.StructBase subclass
See Structs and enums.
ue.script, ue.scripting.bind¶
@ue.script
ue.scripting.bind(target, script_class, *, persistent=None) # returns problems
ue.scripting.unbind(script_class)
ue.scripting.create_script(class_path) # returns the source file
ue.scripting.script_base(class_path) # runtime base of a script
See Script a Blueprint.
ue.reload¶
ue.reload(module) # module name or module object; returns the modules reloaded
See Hot reload.
Event aliases¶
begin_play, end_play, tick, destroyed, actor_begin_overlap, actor_end_overlap, hit. See
Events.