unreal.PlatformEventsComponent
¶
- class unreal.PlatformEventsComponent(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
ActorComponent
Component to handle receiving notifications from the OS about platform events.
C++ Source:
Module: Engine
File: PlatformEventsComponent.h
Editor Properties: (see get_editor_property/set_editor_property)
asset_user_data
(Array[AssetUserData]): [Read-Write] Array of user data stored with the componentauto_activate
(bool): [Read-Write] Whether the component is activated at creation or must be explicitly activated.can_ever_affect_navigation
(bool): [Read-Write] Whether this component can potentially influence navigationcomponent_tags
(Array[Name]): [Read-Write] Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.editable_when_inherited
(bool): [Read-Write] True if this component can be modified when it was inherited from a parent actor classis_editor_only
(bool): [Read-Write] If true, the component will be excluded from non-editor buildson_component_activated
(ActorComponentActivatedSignature): [Read-Write] Called when the component has been activated, with parameter indicating if it was from a reseton_component_deactivated
(ActorComponentDeactivateSignature): [Read-Write] Called when the component has been deactivatedplatform_changed_to_laptop_mode_delegate
(PlatformEventDelegate): [Read-Write] This is called when a convertible laptop changed into laptop mode.platform_changed_to_tablet_mode_delegate
(PlatformEventDelegate): [Read-Write] This is called when a convertible laptop changed into tablet mode.primary_component_tick
(ActorComponentTickFunction): [Read-Write] Main tick function for the Componentreplicate_using_registered_sub_object_list
(bool): [Read-Write] When true the replication system will only replicate the registered subobjects list When false the replication system will instead call the virtual ReplicateSubObjects() function where the subobjects need to be manually replicated.replicates
(bool): [Read-Write] Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!
- is_in_laptop_mode() bool ¶
Check whether a convertible laptop is laptop mode. see: IsInTabletMode, SupportsConvertibleLaptops
- Returns:
true if in laptop mode, false otherwise or if not a convertible laptop.
- Return type:
- is_in_tablet_mode() bool ¶
Check whether a convertible laptop is laptop mode. see: IsInLaptopMode, SupportsConvertibleLaptops
- Returns:
true if in tablet mode, false otherwise or if not a convertible laptop.
- Return type:
- property platform_changed_to_laptop_mode_delegate: PlatformEventDelegate¶
[Read-Write] This is called when a convertible laptop changed into laptop mode.
- Type:
(PlatformEventDelegate)
- property platform_changed_to_tablet_mode_delegate: PlatformEventDelegate¶
[Read-Write] This is called when a convertible laptop changed into tablet mode.
- Type:
(PlatformEventDelegate)
- supports_convertible_laptops() bool ¶
Check whether the platform supports convertible laptops.
Note: This does not necessarily mean that the platform is a convertible laptop. For example, convertible laptops running Windows 7 or older will return false, and regular laptops running Windows 8 or newer will return true. see: IsInLaptopMode, IsInTabletMode
- Returns:
true for convertible laptop platforms, false otherwise.
- Return type: