unreal.RemoteControlFunctionLibrary
¶
- class unreal.RemoteControlFunctionLibrary(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
BlueprintFunctionLibrary
Remote Control Function Library
C++ Source:
Plugin: RemoteControl
Module: RemoteControl
File: RemoteControlFunctionLibrary.h
- classmethod apply_color_grading_wheel_delta(target_object, property_name, delta_value, reference_color, is_interactive, min_value=0.000000, max_value=2.000000) bool ¶
Add/subtract from the value of an FVector4 property interpreted as RGBV using a delta value based on color wheel coordinates.
- Parameters:
target_object (Object) – the object that contains the property to modify.
property_name (str) – the name of the property to modify.
delta_value (ColorGradingWheelColor) – the amount to change the color by.
reference_color (ColorGradingWheelColor) – if the color’s current position on the wheel is ambiguous as calculated from RGB values (e.g. black), use this reference color’s position instead.
is_interactive (bool) – if true, this is treated as an interactive change. If false, it will be treated as the final value set change.
min_value (float) –
max_value (float) –
- Returns:
Whether the operation was successful.
- Return type:
- classmethod apply_color_wheel_delta(target_object, property_name, delta_value, reference_color, is_interactive) bool ¶
Add/subtract from the value of an FLinearColor property using a delta value based on color wheel coordinates.
- Parameters:
target_object (Object) – the object that contains the property to modify.
property_name (str) – the name of the property to modify.
delta_value (ColorWheelColor) – the amount to change the color by.
reference_color (ColorWheelColor) – if the color’s current position on the wheel is ambiguous as calculated from RGB values (e.g. black), use this reference color’s position instead.
is_interactive (bool) – if true, this is treated as an interactive change. If false, it will be treated as the final value set change.
- Returns:
Whether the operation was successful.
- Return type:
- classmethod expose_actor(preset, actor, args) bool ¶
Expose an actor in a remote control preset.
- Parameters:
preset (RemoteControlPreset) – the preset to expose the property in.
actor (Actor) – the actor to expose.
args (RemoteControlOptionalExposeArgs) – optional arguments.
- Returns:
Whether the operation was successful.
- Return type:
- classmethod expose_function(preset, source_object, function, args) bool ¶
Expose a function in a remote control preset.
- Parameters:
preset (RemoteControlPreset) – the preset to expose the property in.
source_object (Object) – the object that contains the property to expose.
function (str) – the name of the function to expose.
args (RemoteControlOptionalExposeArgs) – optional arguments.
- Returns:
Whether the operation was successful.
- Return type:
- classmethod expose_property(preset, source_object, property_, args) bool ¶
Expose a property in a remote control preset.
- Parameters:
preset (RemoteControlPreset) – the preset to expose the property in.
source_object (Object) – the object that contains the property to expose.
property (str) – the name or path of the property to expose.
args (RemoteControlOptionalExposeArgs) – optional arguments.
- Returns:
Whether the operation was successful.
- Return type: