Class: USystemsSceneComponent

class SYSTEMS_API USystemsSceneComponent
    : public USceneComponent;

Reflection-enabled

Specifiers:

  • BlueprintType
  • Blueprintable
  • Abstract

Meta Specifiers:

  • BlueprintSpawnableComponent

Base class for systems scene components.

This is scene component equivalent to USystemsActorComponent - scene components are useful where given component should have transformation relative to actor.

Properties

  • SystemsWorlds

    public:
TSet<FName> SystemsWorlds;

    Reflection-enabled

    Specifiers:

    • EditAnywhere
    • Category = Systems|Component|Scene

    List of subsystem's systems worlds where this component should be registered.

    If list is empty, it means this component will be added to every registered systems world.

Methods

  • CanBeRegisteredToSystemsWorld

    public:
virtual bool CanBeRegisteredToSystemsWorld() const;

    Tells if given component can be automatically registered into systems worlds.

    Useful to override when component has to meet certain conditions to get considered for automatic registration, conditions such as for example being owned by server game instance, or actor being a pawn.

    By default this method always returns true.

  • IsRegistered

    public:
bool IsRegistered() const;

    Tells if this component is registered to subsystem's systems world.

  • SetRegistered

    public:
void SetRegistered(
    bool bMode,
    bool bForced = false
);

    Registers this component to subsystem's systems worlds listed in USystemsSceneComponent::SystemsWorlds.

    Arguments

    • bMode

      bool bMode

      If true, component gets registered, otherwise it gets unregistered.

    • bForced

      bool bForced = false

      Forces registration change.

      Note

      Be careful, when bMode is true, this will not unregister this component from systems worlds where this component is already registered - this is useful mainly when get called in UActorComponent::BeginPlay to enforce initial registration when internal bRegister gets set to true in editor.

Documentation built with Unreal-Doc v1.0.8 tool by PsichiX