================
CODE SNIPPETS
================
TITLE: Starting Mobile Content Installation - Python
DESCRIPTION: This method attempts to initiate the download and installation process for the mobile content represented by the `MobilePendingContent` object. It takes two callback functions as arguments: `on_succeeded` to be called upon successful installation and `on_failed` to handle installation failures.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MobilePendingContent Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def start_install(on_succeeded: OnContentInstallSucceeded,
                  on_failed: OnContentInstallFailed) -> None
```

--------------------------------

TITLE: Virtual Environment Setup
DESCRIPTION: These commands set up a virtual environment for the project, activate it, and install the project dependencies using pip.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/README_ZH.md#_snippet_1

LANGUAGE: Bash
CODE:
```
python -m venv .venv
source .venv/bin/activate  # Linux/macOS
# 或者
.venv\Scripts\activate  # Windows
pip install -e .
```

--------------------------------

TITLE: Virtual Environment Setup and Dependency Installation
DESCRIPTION: This code snippet demonstrates how to create a virtual environment, activate it, and install the project's dependencies using pip. It ensures that the project dependencies are isolated from the system's global packages.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/README.md#_snippet_0

LANGUAGE: bash
CODE:
```
python -m venv .venv
source .venv/bin/activate  # Linux/macOS
# or
.venv\Scripts\activate  # Windows
pip install -e .
```

--------------------------------

TITLE: Handling Test Suite Beginning in Python
DESCRIPTION: Executes any necessary initialization or setup work that needs to be performed once at the start of a sequence of functional tests.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/AutomationPerformaceHelper Objects.md#_snippet_7

LANGUAGE: python
CODE:
```
def on_begin_tests() -> None
```

--------------------------------

TITLE: Example Usage: Get Start Time (Python)
DESCRIPTION: Shows an example of how to call the `get_start_time` method on a `WidgetAnimation` instance, denoted by 'x'. The syntax `x.get_start_time() -> float` indicates calling the method on an object 'x' and clarifies that the method returns a float value representing the start time in seconds.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/WidgetAnimation Objects.md#_snippet_2

LANGUAGE: python
CODE:
```
x.get_start_time() -> float
```

--------------------------------

TITLE: Getting Required Disk Space - Python
DESCRIPTION: This method provides the estimated amount of free disk space, in megabytes (MB), that is needed on the device to successfully complete the installation of the pending content. This helps users or the application verify if there is enough space before starting the installation.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MobilePendingContent Objects.md#_snippet_3

LANGUAGE: python
CODE:
```
def get_required_disk_space() -> float
```

--------------------------------

TITLE: Getting Start Property (Sphere Trace) in Unreal Python
DESCRIPTION: Gets the 'start' property of the `RigUnit_SphereTraceByObjectTypes` instance. This property represents the starting location of the sphere trace in rig or global space and is a read-write property.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/RigUnit_SphereTraceByObjectTypes Objects.md#_snippet_2

LANGUAGE: python
CODE:
```
@property
def start() -> Vector
```

--------------------------------

TITLE: Getting AutoSize Start Frame Seconds Unreal Python
DESCRIPTION: Gets the start time of the 'AutoSize' data for the section in seconds. Requires the section to have a valid AutoSize start frame (checked with `GetAutoSizeHasStartFrame`), otherwise throws an exception.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MovieSceneSection Objects.md#_snippet_35

LANGUAGE: python
CODE:
```
def get_auto_size_start_frame_seconds() -> float
```

--------------------------------

TITLE: Initializing HairSimulationSetup Instance Python
DESCRIPTION: The constructor for the `HairSimulationSetup` class. It allows setting the initial values for various hair simulation properties such as reset behavior, debug visualization, local simulation space, linear and angular velocity scales, the reference bone for local simulation, and the teleport distance threshold.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/HairSimulationSetup Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__(reset_simulation: bool = False,
             debug_simulation: bool = False,
             local_simulation: bool = False,
             linear_velocity_scale: float = 0.000000,
             angular_velocity_scale: float = 0.000000,
             local_bone: str = "",
             teleport_distance: float = 0.000000) -> None
```

--------------------------------

TITLE: Starting Take Recorder Recording in Unreal Engine Python
DESCRIPTION: This method initiates a recording session using the current configuration of the Take Recorder panel. It requires the panel to be set up for recording first. It takes no arguments and returns nothing.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/TakeRecorderPanel Objects.md#_snippet_2

LANGUAGE: python
CODE:
```
def start_recording() -> None
```

--------------------------------

TITLE: Get Frustum Start Distance Property (Unreal Engine Python)
DESCRIPTION: Gets the distance from the origin where the frustum visualization starts drawing for an Unreal Engine DrawFrustumComponent.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/DrawFrustumComponent Objects.md#_snippet_9

LANGUAGE: Python
CODE:
```
@property
def frustum_start_dist() -> float
```

--------------------------------

TITLE: Initializing RigUnit_SetupShapeLibraryFromUserData (Python)
DESCRIPTION: Defines the constructor for the `RigUnit_SetupShapeLibraryFromUserData` class. It allows initializing the unit with execution context, user data namespace and path, an optional library name override, and a debug logging flag.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/RigUnit_SetupShapeLibraryFromUserData Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__(execute_context: ControlRigExecuteContext = [],\n             name_space: str = "",\n             path: str = "",\n             library_name: str = "",\n             log_shape_libraries: bool = False) -> None
```

--------------------------------

TITLE: Getting Angle Start Property (Python)
DESCRIPTION: Gets the current angle_start property of the CEClonerCircleLayout instance. This method returns the float value representing the starting angle for distribution.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/CEClonerCircleLayout Objects.md#_snippet_15

LANGUAGE: python
CODE:
```
def get_angle_start() -> float
```

--------------------------------

TITLE: Getting AutoSize Start Frame Unreal Python
DESCRIPTION: Gets the start frame of the 'AutoSize' data for the section as an integer frame number. Requires the section to have a valid AutoSize start frame (checked with `GetAutoSizeHasStartFrame`), otherwise throws an exception.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MovieSceneSection Objects.md#_snippet_36

LANGUAGE: python
CODE:
```
def get_auto_size_start_frame() -> int
```

--------------------------------

TITLE: Getting Properties: Get Start Time Offset (Python)
DESCRIPTION: Retrieves the current start time offset applied to the GeometryCache playback. Returns a float value representing the offset in seconds.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/GeometryCacheComponent Objects.md#_snippet_33

LANGUAGE: python
CODE:
```
def get_start_time_offset() -> float\n
```

--------------------------------

TITLE: Initializing Audio Output Device Info (Python)
DESCRIPTION: The constructor (`__init__`) for the `AudioOutputDeviceInfo` class. It allows creating an instance with initial values for all device properties. All parameters have default values.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/AudioOutputDeviceInfo Objects.md#_snippet_1

LANGUAGE: Python
CODE:
```
def __init__(
        name: str = "",
        device_id: str = "",
        num_channels: int = 0,
        sample_rate: int = 0,
        format: AudioMixerStreamDataFormatType = AudioMixerStreamDataFormatType
    .UNKNOWN,
        output_channel_array: Array[AudioMixerChannelType] = [],
        is_system_default: bool = False,
        is_current_device: bool = False) -> None
```

--------------------------------

TITLE: Initializing RigVMParserASTSettings Instance (Python)
DESCRIPTION: Defines the constructor (`__init__`) for the `RigVMParserASTSettings` class. It allows creating a new instance with an optional boolean parameter `setup_traits`, which influences the setup of traits during parsing and defaults to `False` if not provided.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/RigVMParserASTSettings Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__(setup_traits: bool = False) -> None
```

--------------------------------

TITLE: Getting Random Start Time Setting (Unreal Python)
DESCRIPTION: Gets the current value of the `random_start_time` property. This boolean indicates if playback should start at a random point within the sequence's range.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MovieSceneSequencePlaybackSettings Objects.md#_snippet_12

LANGUAGE: python
CODE:
```
@property
def random_start_time() -> bool
```

--------------------------------

TITLE: Starting Unreal Engine Audio Capture (Python)
DESCRIPTION: Defines the `start_capturing_audio` method for the `AudioCapture` class. This method initiates the audio capture process using the underlying audio device handle represented by the object instance. It takes no arguments and returns `None`.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/AudioCapture Objects.md#_snippet_2

LANGUAGE: python
CODE:
```
def start_capturing_audio() -> None
```

--------------------------------

TITLE: Getting RigVMFunction_MathIntersectPlane Start Python
DESCRIPTION: Retrieves the 'start' property of the RigVMFunction_MathIntersectPlane instance. This property represents the starting point of the vector ray used for the intersection calculation.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/RigVMFunction_MathIntersectPlane Objects.md#_snippet_2

LANGUAGE: python
CODE:
```
@property
def start() -> Vector
```

--------------------------------

TITLE: Getting 'start' Property (Python)
DESCRIPTION: Retrieves the value of the `start` property using a Python property getter. This property represents the starting RigElementKey for the hierarchy chain and is read-write.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/RigUnit_HierarchyGetChainItemArray Objects.md#_snippet_2

LANGUAGE: python
CODE:
```
@property
def start() -> RigElementKey
```

--------------------------------

TITLE: Initializing Unreal Engine Delegate Instance - Python
DESCRIPTION: This snippet documents the __init__ constructor for the OnMediaPlayerMediaOpenFailed class. The signature (*args: Any, **kwargs: Any) -> None indicates it accepts variable arguments, allowing for flexible initialization, although the specific internal implementation is not shown.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/OnMediaPlayerMediaOpenFailed Objects.md#_snippet_1

LANGUAGE: Python
CODE:
```
def __init__(*args: Any, **kwargs: Any) -> None
```

--------------------------------

TITLE: Setting Up Take Recorder for Recording with Level Sequence Template in Unreal Engine Python
DESCRIPTION: This method prepares the Take Recorder panel to start recording, using the specified Level Sequence asset as a template for the recording setup (e.g., sources). It requires a `LevelSequence` object.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/TakeRecorderPanel Objects.md#_snippet_6

LANGUAGE: python
CODE:
```
def setup_for_recording_level_sequence(
        level_sequence_asset: LevelSequence) -> None
```

--------------------------------

TITLE: Initializing Ava Sequencer Display Rate (Python)
DESCRIPTION: Defines the `__init__` method, the constructor for the `AvaSequencerDisplayRate` class. This method is called when a new instance of the class is created and handles the initial setup. It is specified to take no arguments and return nothing (`-> None`).

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/AvaSequencerDisplayRate Objects.md#_snippet_1

LANGUAGE: Python
CODE:
```
def __init__() -> None
```

--------------------------------

TITLE: Get SplineMeshComponent Start Offset Python
DESCRIPTION: Retrieves the current offset applied at the start of the spline segment.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/SplineMeshComponent Objects.md#_snippet_23

LANGUAGE: Python
CODE:
```
def get_start_offset() -> Vector2D
```

--------------------------------

TITLE: Initializing InteriorSettings - Unreal Python
DESCRIPTION: This snippet shows the `__init__` method (constructor) for the `InteriorSettings` class. It allows creating an instance of `InteriorSettings` with optional initial values for all its audio-related properties.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/InteriorSettings Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__(exterior_volume: float = 0.000000,
             exterior_time: float = 0.000000,
             exterior_lpf: float = 0.000000,
             exterior_lpf_time: float = 0.000000,
             interior_volume: float = 0.000000,
             interior_time: float = 0.000000,
             interior_lpf: float = 0.000000,
             interior_lpf_time: float = 0.000000) -> None
```

--------------------------------

TITLE: Get SplineMeshComponent Start Scale Python
DESCRIPTION: Retrieves the current scaling applied at the start of the spline segment.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/SplineMeshComponent Objects.md#_snippet_20

LANGUAGE: Python
CODE:
```
def get_start_scale() -> Vector2D
```

--------------------------------

TITLE: Get SplineMeshComponent Start Position Python
DESCRIPTION: Retrieves the current start position of the spline segment in local space.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/SplineMeshComponent Objects.md#_snippet_22

LANGUAGE: Python
CODE:
```
def get_start_position() -> Vector
```

--------------------------------

TITLE: Initializing MetasoundFrontendDocument Python
DESCRIPTION: Provides the signature for the constructor of the MetasoundFrontendDocument class. It indicates that the constructor takes no arguments and returns None, suggesting a standard object initialization pattern.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MetasoundFrontendDocument Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__() -> None
```

--------------------------------

TITLE: Initializing RigVM MathBox MoveTo (Python)
DESCRIPTION: This is the `__init__` method for the `RigVMFunction_MathBoxMoveTo` class. It initializes the instance, taking optional arguments for the input `box`, the target `center` position, and the output `result` box. Default values are provided for convenience.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/RigVMFunction_MathBoxMoveTo Objects.md#_snippet_1

LANGUAGE: Python
CODE:
```
def __init__(
    box: Box = [[0.000000, 0.000000, 0.000000], [0.000000, 0.000000, 0.000000],
                False],
    center: Vector = [0.000000, 0.000000, 0.000000],
    result: Box = [[0.000000, 0.000000, 0.000000],
                   [0.000000, 0.000000, 0.000000], False]
) -> None
```

--------------------------------

TITLE: Getting Guid Attribute from Unreal Engine InterchangeBaseNode Python
DESCRIPTION: Retrieves a Guid attribute from the node using its key. Returns the Guid value if found, otherwise returns None.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/InterchangeBaseNode Objects.md#_snippet_18

LANGUAGE: python
CODE:
```
def get_guid_attribute(node_attribute_key: str) -> Optional[Guid]
```

--------------------------------

TITLE: Start Synth Component Python
DESCRIPTION: Starts the synth component generating and playing audio. Use this to begin playback.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/SynthComponent Objects.md#_snippet_30

LANGUAGE: python
CODE:
```
def start() -> None
```

--------------------------------

TITLE: Getting Start Time Offset Property (Python)
DESCRIPTION: Retrieves the current start time offset for the Geometry Cache playback. This float property allows starting the animation from a time other than zero.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/GeometryCacheComponent Objects.md#_snippet_6

LANGUAGE: Python
CODE:
```
@property
def start_time_offset() -> float
```

--------------------------------

TITLE: Initializing RigVMTrait_OptimusVariableBase Instance (Python)
DESCRIPTION: This snippet defines the default constructor (`__init__`) for the RigVMTrait_OptimusVariableBase class. It specifies that the constructor takes no arguments and has a return type hint of None, indicating that it performs no specific initialization logic.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/RigVMTrait_OptimusVariableBase Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__() -> None
```

--------------------------------

TITLE: Getting start Property UnrealEngine Python
DESCRIPTION: Provides read access to the `start` property of the `AvaSequencePlayParams` object. This property represents the desired start time for sequence playback and returns an object of type `AvaSequenceTime`.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/AvaSequencePlayParams Objects.md#_snippet_2

LANGUAGE: python
CODE:
```
@property
def start() -> AvaSequenceTime
```

--------------------------------

TITLE: Getting Start Frame Python
DESCRIPTION: Retrieves the starting frame for the range, if a start is defined. It returns the first valid frame included in the range. This method should ideally only be called if has_start() is true.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/SequencerScriptingRange Objects.md#_snippet_19

LANGUAGE: python
CODE:
```
def get_start_frame() -> int
```

--------------------------------

TITLE: Initializing AnimationSetup Class (Python)
DESCRIPTION: Provides the default constructor for the `AnimationSetup` class. This method is called when a new instance of `AnimationSetup` is created, although in this stub definition, it appears to perform no specific initialization. It takes no arguments and returns `None`.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/AnimationSetup Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__() -> None
```

--------------------------------

TITLE: Getting MovieSceneSection Start Frame Python
DESCRIPTION: Retrieves the start frame of the section as an integer frame number. Requires checking if the section has a start frame first using 'has_start_frame'.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MovieSceneSection Objects.md#_snippet_30

LANGUAGE: python
CODE:
```
def get_start_frame() -> int
```

--------------------------------

TITLE: Initializing OnSubmixRecordedFileDone Delegate (Python)
DESCRIPTION: This snippet shows the standard `__init__` method signature for the `OnSubmixRecordedFileDone` class. It accepts arbitrary positional and keyword arguments (`*args`, `**kwargs`) and has a type hint indicating it returns `None`, which is typical for constructor methods that set up object state.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/OnSubmixRecordedFileDone Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__(*args: Any, **kwargs: Any) -> None
```

--------------------------------

TITLE: Get SplineMeshComponent Start Roll Radians Python
DESCRIPTION: Retrieves the current rotation (roll) in radians at the start of the spline segment.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/SplineMeshComponent Objects.md#_snippet_21

LANGUAGE: Python
CODE:
```
def get_start_roll() -> float
```

--------------------------------

TITLE: Starting Performance Snapshots - Python
DESCRIPTION: Defines the `start_performance_snapshots` class method. It begins capturing performance data (like FPS charts) to be included in health snapshots. If already running, it clears previously accumulated performance data. It takes no arguments.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/HealthSnapshotBlueprintLibrary Objects.md#_snippet_2

LANGUAGE: python
CODE:
```
@classmethod
def start_performance_snapshots(cls) -> None
```

--------------------------------

TITLE: Get SplineMeshComponent Start Tangent Python
DESCRIPTION: Retrieves the current start tangent vector of the spline segment in local space.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/SplineMeshComponent Objects.md#_snippet_19

LANGUAGE: Python
CODE:
```
def get_start_tangent() -> Vector
```

--------------------------------

TITLE: Starting Sequence Recording Method (Python)
DESCRIPTION: Defines the `start_recording_sequence` class method. This method initiates a sequence recording process for a specified list of actors. It takes an array of `Actor` objects as input and returns nothing.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/SequenceRecorderLibrary Objects.md#_snippet_2

LANGUAGE: Python
CODE:
```
@classmethod
def start_recording_sequence(cls, actors_to_record: Array[Actor]) -> None
```

--------------------------------

TITLE: Get Auto Start Property in Python
DESCRIPTION: Retrieves whether the component should automatically start when created. This is a read-write property.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/CameraShakeSourceComponent Objects.md#_snippet_9

LANGUAGE: python
CODE:
```
@property
def auto_start() -> bool
```

--------------------------------

TITLE: Setting Up Take Recorder for Recording with Preset in Unreal Engine Python
DESCRIPTION: This method configures the Take Recorder panel to start recording using the settings and sources defined within a specified Take Preset asset as a template. It requires a `TakePreset` object.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/TakeRecorderPanel Objects.md#_snippet_5

LANGUAGE: python
CODE:
```
def setup_for_recording_take_preset(take_preset_asset: TakePreset) -> None
```

--------------------------------

TITLE: Defining SoundWaveTimecodeInfo Constructor - Python
DESCRIPTION: Defines the `__init__` method (constructor) for the `SoundWaveTimecodeInfo` class. This method initializes an instance of the class. According to the signature, it takes no arguments and returns nothing.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/SoundWaveTimecodeInfo Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__() -> None
```

--------------------------------

TITLE: Getting RigUnit_SphereTraceWorld Start Property Python
DESCRIPTION: Defines the getter for the `start` property of the `RigUnit_SphereTraceWorld` class. This property represents the starting point of the sphere trace in rig or global space and returns a `Vector`.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/RigUnit_SphereTraceWorld Objects.md#_snippet_2

LANGUAGE: python
CODE:
```
@property
def start() -> Vector
```

--------------------------------

TITLE: Initializing TakeRecorderPreInitialize Python
DESCRIPTION: Defines the `__init__` method (constructor) for the `TakeRecorderPreInitialize` class in Python. It is a standard constructor accepting arbitrary positional and keyword arguments.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/TakeRecorderPreInitialize Objects.md#_snippet_1

LANGUAGE: Python
CODE:
```
def __init__(*args: Any, **kwargs: Any) -> None
```

--------------------------------

TITLE: Getting MovieSceneSection Start Time in Seconds Python
DESCRIPTION: Retrieves the start time of the section as a floating-point value in seconds. Requires checking if the section has a start frame first using 'has_start_frame'.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MovieSceneSection Objects.md#_snippet_29

LANGUAGE: python
CODE:
```
def get_start_frame_seconds() -> float
```

--------------------------------

TITLE: Getting Start in Seconds Python
DESCRIPTION: Retrieves the starting time for the range in seconds, if a start is defined. It returns the first valid time point included in the range. This method should ideally only be called if has_start() is true.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/SequencerScriptingRange Objects.md#_snippet_18

LANGUAGE: python
CODE:
```
def get_start_seconds() -> float
```

--------------------------------

TITLE: Initializing RigModuleDescription Instance Python
DESCRIPTION: This shows the constructor (`__init__`) for the `RigModuleDescription` class. It accepts optional `path` and `settings` arguments with default values, used to initialize the instance.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/RigModuleDescription Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__(
    path: SoftObjectPath = [""],
    settings: RigModuleSettings = [["", "Module"], [""], "", "", "",
                                   []]) -> None
```

--------------------------------

TITLE: Getting Start Position of Sequence Player - Python
DESCRIPTION: Retrieves the configured start position for a sequence player animation node. Takes a `SequencePlayerReference`. Returns a float representing the start position.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/SequencePlayerLibrary Objects.md#_snippet_6

LANGUAGE: python
CODE:
```
@classmethod
def get_start_position(cls, sequence_player: SequencePlayerReference) -> float
```

--------------------------------

TITLE: Getting RigVM String StartsWith Start Property - Python
DESCRIPTION: Implements the getter for the `start` property of the `RigVMFunction_StringStartsWith` class using the `@property` decorator. It returns the string value used for comparison, which is the prefix to check for.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/RigVMFunction_StringStartsWith Objects.md#_snippet_4

LANGUAGE: python
CODE:
```
@property\ndef start() -> str
```

--------------------------------

TITLE: Getting RigUnit_SphereTraceByTraceChannel Start Property (Python)
DESCRIPTION: Defines the getter for the `start` property of the `RigUnit_SphereTraceByTraceChannel` class. This property represents the starting point of the sphere trace in rig or global space and returns a `Vector`.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/RigUnit_SphereTraceByTraceChannel Objects.md#_snippet_2

LANGUAGE: python
CODE:
```
@property
def start() -> Vector
```

--------------------------------

TITLE: Initializing Unreal Engine InputDevicePropertyHandle Python
DESCRIPTION: Defines the `__init__` constructor method for the `InputDevicePropertyHandle` class. This method initializes an instance of the handle. It takes no arguments and returns `None`.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/InputDevicePropertyHandle Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__() -> None
```

--------------------------------

TITLE: Get Playback Start in Seconds - Unreal MovieScene - Python
DESCRIPTION: Retrieves the playback start time of a `MovieSceneSequence` in seconds. It takes the sequence object as input and returns a float representing the start time.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MovieSceneSequenceExtensions Objects.md#_snippet_38

LANGUAGE: python
CODE:
```
@classmethod
def get_playback_start_seconds(cls, sequence: MovieSceneSequence) -> float
```

--------------------------------

TITLE: Initializing Unreal Engine Python Delegate
DESCRIPTION: This snippet defines the `__init__` method for the `SystemLibrary_OnAssetLoaded` class. It accepts arbitrary positional and keyword arguments (`*args`, `**kwargs`) and has a type hint indicating it returns `None`, serving as the standard constructor definition for this delegate class.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/SystemLibrary_OnAssetLoaded Objects.md#_snippet_1

LANGUAGE: Python
CODE:
```
def __init__(*args: Any, **kwargs: Any) -> None
```

--------------------------------

TITLE: Initializing TakeRecorderStopped Class Python
DESCRIPTION: This snippet shows the `__init__` method for the `TakeRecorderStopped` class in Python. It's the constructor for the delegate object. The method signature indicates it can accept variable positional (`*args`) and keyword arguments (`**kwargs`), typical for Python wrappers around C++ objects.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/TakeRecorderStopped Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__(*args: Any, **kwargs: Any) -> None
```

--------------------------------

TITLE: Getting Custom Bone Tracks Range Start (Python)
DESCRIPTION: Retrieves the custom start time (in seconds) for importing bone tracks. Returns the start time as a float if set, otherwise None.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/InterchangeAnimSequenceFactoryNode Objects.md#_snippet_33

LANGUAGE: python
CODE:
```
def get_custom_import_bone_tracks_range_start() -> Optional[float]
```

--------------------------------

TITLE: Handling Setup Event in User Defined Capture Protocol Python
DESCRIPTION: This method is called once at the very beginning of the capture process, prior to any warmup frames. It should perform necessary initialization and return True if setup was successful, False otherwise.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/UserDefinedCaptureProtocol Objects.md#_snippet_8

LANGUAGE: Python
CODE:
```
def on_setup() -> bool
```

--------------------------------

TITLE: Starting AvaPlaybackGraph Playback Python
DESCRIPTION: Defines the `play` method for the `AvaPlaybackGraph`. This method starts the playback controlled by the graph. It takes no arguments and returns nothing.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/AvaPlaybackGraph Objects.md#_snippet_3

LANGUAGE: python
CODE:
```
def play() -> None
```

--------------------------------

TITLE: Get 'start' Property RigVMFunction_StartsWith Python
DESCRIPTION: Provides the getter for the 'start' property of the `RigVMFunction_StartsWith` class. This property represents the prefix Name object to test against.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/RigVMFunction_StartsWith Objects.md#_snippet_4

LANGUAGE: python
CODE:
```
@property
def start() -> Name
```

--------------------------------

TITLE: Getting Binding ID Python
DESCRIPTION: Retrieves the unique identifier (GUID) for a binding. Takes a `MovieSceneBindingProxy` and returns its `Guid`.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MovieSceneBindingExtensions Objects.md#_snippet_16

LANGUAGE: python
CODE:
```
@classmethod
def get_id(cls, binding: MovieSceneBindingProxy) -> Guid
```

--------------------------------

TITLE: Initialize MetasoundFrontendClassInterface (Python)
DESCRIPTION: Defines the `__init__` method, the constructor for the `MetasoundFrontendClassInterface` class. This method initializes an instance of the class. It does not take any arguments and returns `None`.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MetasoundFrontendClassInterface Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__() -> None
```

--------------------------------

TITLE: Getting Sequencer Range Start Time Python
DESCRIPTION: This snippet documents the `@classmethod` `get_start_seconds`. If the `SequencerScriptingRange` has a defined start, this method retrieves the start time in seconds. The start time is the first valid time inside the range. It takes the range object and returns a float.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/SequencerScriptingRangeExtensions Objects.md#_snippet_9

LANGUAGE: python
CODE:
```
@classmethod
def get_start_seconds(cls, range: SequencerScriptingRange) -> float
```

--------------------------------

TITLE: Initializing AudioTextBoxStyle Instance in Python
DESCRIPTION: The constructor method (`__init__`) for the `AudioTextBoxStyle` class. It allows creating an instance of the style with specific values for `background_image` and `background_color`, providing default values if none are supplied. It takes `SlateBrush` and `SlateColor` objects as parameters.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/AudioTextBoxStyle Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__(
    background_image: SlateBrush = [
        [[1.000000, 1.000000, 1.000000, 1.000000],
         SlateColorStylingMode.USE_COLOR_SPECIFIED], SlateBrushDrawType.IMAGE,
        SlateBrushTileType.NO_TILE, SlateBrushMirrorType.NO_MIRROR,
        [0.000000, 0.000000], [0.000000, 0.000000, 0.000000, 0.000000], None,
        [[0.000000, 0.000000, 0.000000, 0.000000],
         [[0.000000, 0.000000, 0.000000, 0.000000],
          SlateColorStylingMode.USE_COLOR_SPECIFIED], 0.000000,
         SlateBrushRoundingType.HALF_HEIGHT_RADIUS, False]
    ],
    background_color: SlateColor = [[1.000000, 0.000000, 1.000000, 1.000000],
                                    SlateColorStylingMode.USE_COLOR_SPECIFIED]
) -> None
```

--------------------------------

TITLE: Getting Playback Start (Seconds) - Python (Unreal Engine)
DESCRIPTION: Retrieves the start time of the sequence's playback range in seconds. This method takes no arguments. Returns a float representing the playback start time.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MovieSceneSequence Objects.md#_snippet_41

LANGUAGE: python
CODE:
```
def get_playback_start_seconds() -> float
```

--------------------------------

TITLE: Initializing MediaPlateResource Instance (Python)
DESCRIPTION: Defines the default initializer method (`__init__`) for the `MediaPlateResource` Python class. It has no parameters and is typed to return `None`, indicating it performs internal setup without requiring external input upon instantiation. This is the standard way to create a new instance of the struct in Python.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MediaPlateResource Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__() -> None
```

--------------------------------

TITLE: Getting AutoSize Start Frame (Python)
DESCRIPTION: Retrieves the start frame of the auto-size data for a `MovieSceneSection`. It requires the section and will throw an exception if auto-size start is not bounded; use a check like `GetAutoSizeHasStartFrame` first.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MovieSceneSectionExtensions Objects.md#_snippet_19

LANGUAGE: python
CODE:
```
@classmethod
def get_auto_size_start_frame(cls, section: MovieSceneSection) -> int
```

--------------------------------

TITLE: Initializing TakeRecorderParameters in Python
DESCRIPTION: Initializes a new instance of the `TakeRecorderParameters` class. It takes optional arguments for user parameters, project parameters, recording mode, and start frame, providing default values for each. This sets up the initial state for recording configuration.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/TakeRecorderParameters Objects.md#_snippet_1

LANGUAGE: Python
CODE:
```
def __init__(user: TakeRecorderUserParameters = [
    False, 0.000000, 1.000000, True, False, True, 0.000100, False, True, False
],
             project: TakeRecorderProjectParameters = [[
                 ""
             ], "", "", UpdateClockSource.RELATIVE_TIMECODE, True, False,
                                                       False, False, True],
             take_recorder_mode: TakeRecorderMode = TakeRecorderMode.
             RECORD_NEW_SEQUENCE,
             start_frame: FrameNumber = [0]) -> None
```

--------------------------------

TITLE: Initializing Unreal Engine Delegate Python
DESCRIPTION: Defines the `__init__` method (constructor) for the `OnSubmixSpectralAnalysisBP` class in Python. This method is part of the standard Python object initialization process and is typically handled internally by the Unreal Engine Python wrapper when instantiating this delegate class.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/OnSubmixSpectralAnalysisBP Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__(*args: Any, **kwargs: Any) -> None
```

--------------------------------

TITLE: Initializing PBIKSolverSettings Python
DESCRIPTION: Provides the constructor for creating a PBIKSolverSettings object with optional initial values for its key properties. Allows configuring solver behavior, iterations, mass, stretch, and root settings upon instantiation.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/PBIKSolverSettings Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__(iterations: int = 0,
             sub_iterations: int = 0,
             mass_multiplier: float = 0.000000,
             allow_stretch: bool = False,
             root_behavior: PBIKRootBehavior = PBIKRootBehavior.PRE_PULL,
             pre_pull_root_settings: RootPrePullSettings = [
                 0.000000, 1.000000, 1.000000, 1.000000, 1.000000, 1.000000,
                 1.000000, 1.000000
             ],
             global_pull_chain_alpha: float = 0.000000,
             max_angle: float = 0.000000,
             over_relaxation: float = 0.000000) -> None
```

--------------------------------

TITLE: Getting Sequencer Range Start Frame Python
DESCRIPTION: This snippet documents the `@classmethod` `get_start_frame`. If the `SequencerScriptingRange` has a defined start, this method retrieves the start frame number. The start frame is the first valid frame inside the range. It takes the range object and returns an integer (int32).

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/SequencerScriptingRangeExtensions Objects.md#_snippet_10

LANGUAGE: python
CODE:
```
@classmethod
def get_start_frame(cls, range: SequencerScriptingRange) -> int
```

--------------------------------

TITLE: Get Retarget Chain Start Bone - Python
DESCRIPTION: Retrieves the name of the start bone assigned to the specified retargeting chain within the IK Rig asset.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/IKRigController Objects.md#_snippet_26

LANGUAGE: python
CODE:
```
def get_retarget_chain_start_bone(chain_name: Name) -> Name
```

--------------------------------

TITLE: Initializing RigVMFunction_MathDoubleUnaryOp Python
DESCRIPTION: The constructor for the `RigVMFunction_MathDoubleUnaryOp` class. It initializes the instance with optional `value` and `result` parameters, mapping to the node's corresponding properties for initial state setup.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/RigVMFunction_MathDoubleUnaryOp Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__(value: float = 0.000000, result: float = 0.000000) -> None
```

--------------------------------

TITLE: Initializing InterpToMovementComponent Delegate - Python
DESCRIPTION: This is the standard Python constructor (`__init__`) for the InterpToMovementComponent_OnInterpToResetDelegate class. It is likely a stub definition that allows instantiation and passes arguments through to the base class or handles minimal setup.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/InterpToMovementComponent_OnInterpToResetDelegate Objects.md#_snippet_1

LANGUAGE: Python
CODE:
```
def __init__(*args: Any, **kwargs: Any) -> None
```

--------------------------------

TITLE: Getting MovieSceneSection Start Time in Seconds (Python)
DESCRIPTION: Retrieves the start time of a `MovieSceneSection` in seconds. It requires the section object and will throw an exception if the section does not have a bounded start frame; use `has_start_frame` to check first.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MovieSceneSectionExtensions Objects.md#_snippet_11

LANGUAGE: python
CODE:
```
@classmethod
def get_start_frame_seconds(cls, section: MovieSceneSection) -> float
```

--------------------------------

TITLE: Getting Installation Progress - Python
DESCRIPTION: This method returns the current progress of the content installation as a floating-point number. The value is typically between 0.0 and 1.0 for known progress, indicating the completion percentage. A value less than 0 indicates that the installation progress is currently unknown or cannot be determined.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MobilePendingContent Objects.md#_snippet_4

LANGUAGE: python
CODE:
```
def get_install_progress() -> float
```

--------------------------------

TITLE: Getting RigVMVariant GUID Python
DESCRIPTION: Defines a read-only property in Python to access the 'guid' attribute of a RigVMVariant object. The GUID is a unique identifier that is shared across all variants representing the same element within the RigVM and is not intended to be modified after creation.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/RigVMVariant Objects.md#_snippet_2

LANGUAGE: python
CODE:
```
@property
def guid() -> Guid
```

--------------------------------

TITLE: Initializing GeometryScriptCopyMeshFromAssetOptions in Python
DESCRIPTION: Provides the constructor (`__init__`) for the `GeometryScriptCopyMeshFromAssetOptions` class. It initializes instance variables with default boolean values (False) for `apply_build_settings`, `request_tangents`, `ignore_remove_degenerates`, and `use_build_scale`, configuring the initial state of the mesh copy options.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/GeometryScriptCopyMeshFromAssetOptions Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__(apply_build_settings: bool = False,
             request_tangents: bool = False,
             ignore_remove_degenerates: bool = False,
             use_build_scale: bool = False) -> None
```

--------------------------------

TITLE: Get Playback Start in Frames - Unreal MovieScene - Python
DESCRIPTION: Retrieves the playback start time of a `MovieSceneSequence` in display rate resolution (frames). It takes the sequence object as input and returns an integer representing the start frame.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MovieSceneSequenceExtensions Objects.md#_snippet_39

LANGUAGE: python
CODE:
```
@classmethod
def get_playback_start(cls, sequence: MovieSceneSequence) -> int
```

--------------------------------

TITLE: Initializing Unreal AudioCaptureDeviceInfo Struct Python
DESCRIPTION: The constructor (__init__) for the AudioCaptureDeviceInfo struct. It allows initializing the struct with optional parameters for device name, number of input channels, and sample rate.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/AudioCaptureDeviceInfo Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__(device_name: Name = "None",
             num_input_channels: int = 0,
             sample_rate: int = 0) -> None
```

--------------------------------

TITLE: Starting Trace to File Unreal Python
DESCRIPTION: Initiates an Unreal Engine trace session and directs the output to a specified file path. Allows selecting specific channels to include in the trace.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/TraceUtilLibrary Objects.md#_snippet_7

LANGUAGE: python
CODE:
```
@classmethod
def start_trace_to_file(cls, file_name: str, channels: Array[str]) -> bool
```

--------------------------------

TITLE: Getting Work Range Start (Seconds) - Python (Unreal Engine)
DESCRIPTION: Retrieves the start time of the sequence's work range in seconds. This method takes no arguments. Returns a float representing the work range start time.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MovieSceneSequence Objects.md#_snippet_31

LANGUAGE: python
CODE:
```
def get_work_range_start() -> float
```

--------------------------------

TITLE: Initializing PerPlatformBool (Python)
DESCRIPTION: This snippet defines the `__init__` method for the `PerPlatformBool` class. This is the constructor used to create new instances of the `PerPlatformBool` object. As shown, it takes no arguments and returns nothing.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/PerPlatformBool Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__() -> None
```

--------------------------------

TITLE: Getting AutoSize Start Time in Seconds (Python)
DESCRIPTION: Retrieves the start time of the auto-size data for a `MovieSceneSection` in seconds. It requires the section and will throw an exception if auto-size start is not bounded; use a check like `GetAutoSizeHasStartFrame` first.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MovieSceneSectionExtensions Objects.md#_snippet_18

LANGUAGE: python
CODE:
```
@classmethod
def get_auto_size_start_frame_seconds(cls,
                                      section: MovieSceneSection) -> float
```

--------------------------------

TITLE: Setting up Control Rig Editor Menus Python
DESCRIPTION: A class method to set up all editor menus related to Control Rig. This function takes no arguments and returns None, typically used to initialize or configure UI elements for the Control Rig editor.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/ControlRigBlueprintLibrary Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
@classmethod
def setup_all_editor_menus(cls) -> None
```

--------------------------------

TITLE: Getting MovieSceneSection Start Frame (Python)
DESCRIPTION: Retrieves the start frame of a `MovieSceneSection` using frame numbers. It requires the section object and will throw an exception if the section does not have a bounded start frame; use `has_start_frame` to check first.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MovieSceneSectionExtensions Objects.md#_snippet_12

LANGUAGE: python
CODE:
```
@classmethod
def get_start_frame(cls, section: MovieSceneSection) -> int
```

--------------------------------

TITLE: Defining MetasoundFrontendClassInputDefault Constructor (Python)
DESCRIPTION: Defines the `__init__` method, which serves as the constructor for the `MetasoundFrontendClassInputDefault` class. It is shown without parameters and with a type hint indicating it returns nothing.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MetasoundFrontendClassInputDefault Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__() -> None
```

--------------------------------

TITLE: Getting Start Offset Unreal Engine Python
DESCRIPTION: Gets the current offset into the beginning of the audio clip played by this section. It returns a `FrameNumber`.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MovieSceneAudioSection Objects.md#_snippet_10

LANGUAGE: python
CODE:
```
def get_start_offset() -> FrameNumber
```

--------------------------------

TITLE: Get notify_filter_lod Property Unreal/Python
DESCRIPTION: Gets the `notify_filter_lod` property of the `AnimNotifyEvent`. This read-write property indicates the Level of Detail (LOD) threshold at which this notify event will start being filtered out.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/AnimNotifyEvent Objects.md#_snippet_15

LANGUAGE: python
CODE:
```
@property
def notify_filter_lod() -> int
```

--------------------------------

TITLE: Initializing AudioMaterialMeterStyle Instance (Python)
DESCRIPTION: Defines the constructor for the AudioMaterialMeterStyle class. It allows creating an instance with numerous optional parameters to set the style properties such as material, size, colors, padding, scale visibility, and font upon initialization.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/AudioMaterialMeterStyle Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__(
    material: MaterialInterface = None,
    desired_size: Vector2f = [0.000000, 0.000000],
    meter_fill_min_color: LinearColor = [
        0.000000, 0.000000, 0.000000, 0.000000
    ],
    meter_fill_mid_color: LinearColor = [
        0.000000, 0.000000, 0.000000, 0.000000
    ],
    meter_fill_max_color: LinearColor = [
        0.000000, 0.000000, 0.000000, 0.000000
    ],
    meter_fill_background_color: LinearColor = [
        0.000000, 0.000000, 0.000000, 0.000000
    ],
    meter_padding: Vector2D = [0.000000, 0.000000],
    value_range_db: Vector2D = [0.000000, 0.000000],
    show_scale: bool = False,
    scale_side: bool = False,
    scale_hash_offset: float = 0.000000,
    scale_hash_width: float = 0.000000,
    scale_hash_height: float = 0.000000,
    decibels_per_hash: int = 0,
    font: SlateFontInfo = [
        None, None,
        [
            0, False, False, False, None,
            [0.000000, 0.000000, 0.000000, 1.000000]
        ], "None", 24.000000, 0, 0.000000, False, False, 1.000000
    ]
) -> None
```

--------------------------------

TITLE: Getting Setup Material (Unreal Python)
DESCRIPTION: This method retrieves the currently assigned setup post-process material for the `ComposurePostProcessPass`. It returns a `MaterialInterface` object.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/ComposurePostProcessPass Objects.md#_snippet_3

LANGUAGE: python
CODE:
```
def get_setup_material() -> MaterialInterface
```

--------------------------------

TITLE: Initializing SmartReduceParams Python
DESCRIPTION: Provides the constructor (`__init__`) for the `SmartReduceParams` class. It initializes the `tolerance_percentage` and `sample_rate` properties with default values.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/SmartReduceParams Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__(tolerance_percentage: float = 0.000000,
             sample_rate: FrameRate = [60000, 1]) -> None
```

--------------------------------

TITLE: Getting Playback Start (Display Rate) - Python (Unreal Engine)
DESCRIPTION: Retrieves the start frame of the sequence's playback range in display rate resolution. This method takes no arguments. Returns an int32 representing the playback start frame.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MovieSceneSequence Objects.md#_snippet_42

LANGUAGE: python
CODE:
```
def get_playback_start() -> int
```

--------------------------------

TITLE: Initializing DisplayClusterConfigurationMedia - Unreal Engine Python
DESCRIPTION: This is the constructor method for the DisplayClusterConfigurationMedia class. It initializes an instance with optional parameters for enabling media, providing media input configurations, and listing media output configurations.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/DisplayClusterConfigurationMedia Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__(
        enable: bool = False,
        media_input: DisplayClusterConfigurationMediaInput = [None],
        media_outputs: Array[DisplayClusterConfigurationMediaOutput] = []
) -> None
```

--------------------------------

TITLE: Getting Unreal Engine Python MovieGraphMember GUID
DESCRIPTION: Retrieves the unique identifier (GUID) associated with the MovieGraphMember object. This method takes no parameters and returns a Guid object, which uniquely identifies this specific member within the Movie Graph.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MovieGraphMember Objects.md#_snippet_3

LANGUAGE: python
CODE:
```
def get_guid() -> Guid
```

LANGUAGE: python
CODE:
```
x.get_guid() -> Guid
```

--------------------------------

TITLE: Initializing AudioMaterialKnobStyle Instance - Python
DESCRIPTION: The constructor for the `AudioMaterialKnobStyle` class. It allows instantiation with detailed parameters for various visual properties, including material, desired size, and multiple color settings for different parts of the knob and its bar. All parameters have default values.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/AudioMaterialKnobStyle Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__(
    material: MaterialInterface = None,
    desired_size: Vector2f = [0.000000, 0.000000],
    knob_main_color: LinearColor = [0.000000, 0.000000, 0.000000, 0.000000],
    knob_accent_color: LinearColor = [0.000000, 0.000000, 0.000000, 0.000000],
    knob_shadow_color: LinearColor = [0.000000, 0.000000, 0.000000, 0.000000],
    knob_smooth_bevel_color: LinearColor = [
        0.000000, 0.000000, 0.000000, 0.000000
    ],
    knob_indicator_dot_color: LinearColor = [
        0.000000, 0.000000, 0.000000, 0.000000
    ],
    knob_edge_fill_color: LinearColor = [
        0.000000, 0.000000, 0.000000, 0.000000
    ],
    knob_bar_color: LinearColor = [0.000000, 0.000000, 0.000000, 0.000000],
    knob_bar_shadow_color: LinearColor = [
        0.000000, 0.000000, 0.000000, 0.000000
    ],
    knob_bar_fill_min_color: LinearColor = [
        0.000000, 0.000000, 0.000000, 0.000000
    ],
    knob_bar_fill_mid_color: LinearColor = [
        0.000000, 0.000000, 0.000000, 0.000000
    ],
    knob_bar_fill_max_color: LinearColor = [
        0.000000, 0.000000, 0.000000, 0.000000
    ],
    knob_bar_fill_tint_color: LinearColor = [
        0.000000, 0.000000, 0.000000, 0.000000
    ],
    text_box_style: AudioTextBoxStyle = [
        [[[0.000000, 0.000000, 0.000000, 0.000000],
          0], SlateBrushDrawType.ROUNDED_BOX, SlateBrushTileType.NO_TILE,
         SlateBrushMirrorType.NO_MIRROR, [0.000000, 0.000000],
         [0.000000, 0.000000, 0.000000, 0.000000], None,
         [[4.000000, 4.000000, 4.000000, 4.000000],
          [[0.000000, 0.000000, 0.000000, 0.000000],
           SlateColorStylingMode.USE_COLOR_SPECIFIED], 0.000000,
          SlateBrushRoundingType.FIXED_RADIUS, False]],
        [[0.000000, 0.000000, 0.000000, 0.000000], 0]
    ]
) -> None
```

--------------------------------

TITLE: Initializing Unreal Metasound Frontend Class Output (Python)
DESCRIPTION: Provides the signature for the default constructor (__init__) of the MetasoundFrontendClassOutput class. It takes no arguments and is used to initialize an instance of the class, indicating it does not return a value.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MetasoundFrontendClassOutput Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__() -> None
```

--------------------------------

TITLE: Getting Inner Start Offset Property in Python
DESCRIPTION: Retrieves the inner start offset value in frames. This offset is applied to the beginning of the inner range for all loops.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MovieSceneSectionTimingParametersFrames Objects.md#_snippet_4

LANGUAGE: python
CODE:
```
@property
def inner_start_offset() -> FrameNumber
```

--------------------------------

TITLE: Get Progress Start from AvaSplineSweepModifier Python
DESCRIPTION: Retrieves the current normalized starting point (0.0 to 1.0) along the spline for the sweep. Returns a float value.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/AvaSplineSweepModifier Objects.md#_snippet_18

LANGUAGE: python
CODE:
```
def get_progress_start() -> float
```

--------------------------------

TITLE: Initializing MetasoundFrontendVertexHandle Instance - Python
DESCRIPTION: Defines the default constructor (`__init__`) for the `MetasoundFrontendVertexHandle` class in Python. This method initializes a new instance of the handle object. It takes no arguments and returns `None`.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MetasoundFrontendVertexHandle Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__() -> None
```

--------------------------------

TITLE: Getting Start Angle Method Python
DESCRIPTION: This method retrieves the current start angle (in degrees) configured for the radial arrangement. It returns a float value.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/AvaRadialArrangeModifier Objects.md#_snippet_24

LANGUAGE: Python
CODE:
```
def get_start_angle() -> float
```

--------------------------------

TITLE: Call setup_component Method Python
DESCRIPTION: Sets up all necessary components for the VREditorInteractor. This method typically initializes and attaches the various parts of the interactor, such as the motion controller component and hand mesh.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/VREditorInteractor Objects.md#_snippet_5

LANGUAGE: python
CODE:
```
def setup_component(owning_actor: Actor) -> None
```

--------------------------------

TITLE: Getting Start Corner from AvaGridArrangeModifier (Python)
DESCRIPTION: Defines a Python method to retrieve the current starting corner for the grid arrangement. It returns an `AvaCorner2D` enum value.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/AvaGridArrangeModifier Objects.md#_snippet_8

LANGUAGE: python
CODE:
```
def get_start_corner() -> AvaCorner2D
```

--------------------------------

TITLE: Initializing SystemLibrary_OnAssetClassLoaded (Python)
DESCRIPTION: This is the standard Python constructor method (`__init__`) for the `SystemLibrary_OnAssetClassLoaded` delegate class. It allows the class to be instantiated, accepting arbitrary positional and keyword arguments as defined by the type hints.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/SystemLibrary_OnAssetClassLoaded Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__(*args: Any, **kwargs: Any) -> None
```

--------------------------------

TITLE: Getting Start Direction from AvaGridArrangeModifier (Python)
DESCRIPTION: Defines a Python method to retrieve the current starting direction for the grid arrangement. It returns an `AvaGridArrangeDirection` enum value.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/AvaGridArrangeModifier Objects.md#_snippet_7

LANGUAGE: python
CODE:
```
def get_start_direction() -> AvaGridArrangeDirection
```

--------------------------------

TITLE: Initializing PlatformInterfaceDelegate (Python)
DESCRIPTION: Defines the `__init__` constructor for the `PlatformInterfaceDelegate` class. It accepts arbitrary positional (`*args: Any`) and keyword arguments (`**kwargs: Any`) and returns `None`, following a common pattern for Python constructors wrapping C++ objects.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/PlatformInterfaceDelegate Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__(*args: Any, **kwargs: Any) -> None
```

--------------------------------

TITLE: Getting RigVM String Count Property (Python)
DESCRIPTION: Provides the getter for the `count` property. This property specifies the maximum number of characters to extract starting from the 'start' index. If set to -1, all characters from the start index to the end of the string are returned.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/RigVMFunction_StringMiddle Objects.md#_snippet_6

LANGUAGE: python
CODE:
```
@property
def count() -> int
```

--------------------------------

TITLE: Initializing AudioMeter Delegate Class - Python
DESCRIPTION: Defines the `__init__` method (constructor) for the `AudioMeter_GetMeterChannelInfo` class. It accepts any number of positional (`*args`) and keyword (`**kwargs`) arguments, typically used for initializing instances of this delegate type.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/AudioMeter_GetMeterChannelInfo Objects.md#_snippet_1

LANGUAGE: python
CODE:
```
def __init__(*args: Any, **kwargs: Any) -> None
```

--------------------------------

TITLE: Implementing Pipeline Setup - Python
DESCRIPTION: Implements the setup logic for the movie render pipeline. This method is called when the pipeline is being initialized. It takes a `MoviePipeline` object as input and returns nothing.

SOURCE: https://github.com/radial-hks/unreal-python-stubhub/blob/main/docs/api/MoviePipelineSetting_BlueprintBase Objects.md#_snippet_2

LANGUAGE: python
CODE:
```
def receive_setup_for_pipeline_impl(pipeline: MoviePipeline) -> None
```