unreal.GameFrameworkComponentManager

class unreal.GameFrameworkComponentManager(outer=None, name='None')

Bases: unreal.GameInstanceSubsystem

A manager to handle putting components on actors as they come and go. Put in a request to instantiate components of a given class on actors of a given class and they will automatically be made for them as the actors are spawned. Actors must opt-in to this behavior by calling AddReceiver/RemoveReceiver for themselves when they are ready to receive the components and when they want to remove them. Any actors that are in memory when a request is made will automatically get the components, and any in memory when a request is removed will lose the components immediately. Requests are reference counted, so if multiple requests are made for the same actor class and component class, only one component will be added and that component wont be removed until all requests are removed.

C++ Source:

  • Plugin: ModularGameplay

  • Module: ModularGameplay

  • File: GameFrameworkComponentManager.h

add_receiver(receiver, add_only_in_game_worlds=True) → None

Adds an actor as a receiver for components. If it passes the actorclass filter on requests it will get the components.

Parameters

  • receiver (Actor) –

  • add_only_in_game_worlds (bool) –

remove_receiver(receiver) → None

Removes an actor as a receiver for components.

Parameters

receiver (Actor) –