unreal.PixelStreamingInput
¶
- class unreal.PixelStreamingInput(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
ActorComponent
This component may be attached to an actor to allow UI interactions to be handled as the delegate will be notified about the interaction and will be supplied with a generic descriptor string containing, for example, JSON data. Responses back to the source of the UI interactions may also be sent.
C++ Source:
Plugin: PixelStreaming
Module: PixelStreaming
File: PixelStreamingInputComponent.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 deactivatedon_input_event
(OnInput): [Read-Write]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!
- add_json_string_value(descriptor, field_name, string_value) -> (new_descriptor=str, success=bool)¶
Helper function to add a string field to a JSON descriptor. This produces a new descriptor which may then be chained to add further string fields.
- Parameters:
- Returns:
new_descriptor (str): The JSON descriptor with the string field added.
success (bool): True if the string field could be added successfully.
- Return type:
tuple
- get_json_string_value(descriptor, field_name) -> (string_value=str, success=bool)¶
Helper function to extract a string field from a JSON descriptor of a UI interaction given its field name. The field name may be hierarchical, delimited by a period. For example, to access the Width value of a Resolution command above you should use “Resolution.Width” to get the width value.
- property on_input_event: OnInput¶
[Read-Write]
- Type:
(OnInput)