unreal.PlatformEventsComponent

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

Bases: unreal.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] Asset User Data: Array of user data stored with the component

  • auto_activate (bool): [Read-Write] Auto Activate: Whether the component is activated at creation or must be explicitly activated.

  • can_ever_affect_navigation (bool): [Read-Write] Can Ever Affect Navigation: Whether this component can potentially influence navigation

  • component_tags (Array(Name)): [Read-Write] Component Tags: Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

  • editable_when_inherited (bool): [Read-Write] Editable when Inherited: True if this component can be modified when it was inherited from a parent actor class

  • is_editor_only (bool): [Read-Write] Is Editor Only: If true, the component will be excluded from non-editor builds

  • on_component_activated (ActorComponentActivatedSignature): [Read-Write] On Component Activated: Called when the component has been activated, with parameter indicating if it was from a reset

  • on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] On Component Deactivated: Called when the component has been deactivated

  • platform_changed_to_laptop_mode_delegate (PlatformEventDelegate): [Read-Write] Platform Changed to Laptop Mode Delegate: This is called when a convertible laptop changed into laptop mode.

  • platform_changed_to_tablet_mode_delegate (PlatformEventDelegate): [Read-Write] Platform Changed to Tablet Mode Delegate: This is called when a convertible laptop changed into tablet mode.

  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Primary Component Tick: Main tick function for the Component

  • replicates (bool): [Read-Write] Replicates: 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

bool

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

bool

property platform_changed_to_laptop_mode_delegate

[Read-Write] Platform Changed to Laptop Mode Delegate: This is called when a convertible laptop changed into laptop mode.

Type

(PlatformEventDelegate)

property platform_changed_to_tablet_mode_delegate

[Read-Write] Platform Changed to Tablet Mode Delegate: 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

bool