ULimenCameraShakeSetting
Overview
ULimenCameraShakeSetting is a subclass of ULimenSelectionSetting designed to control whether camera shakes are played in the game. It handles the formatting and unformatting of the setting value, as well as applying the current setting to all actors in the world when changed.
Properties
Type | Name | Access | Description |
|---|---|---|---|
FString | EnabledString | Private | The string representation for enabling camera shakes. |
FString | DisabledString | Private | The string representation for disabling camera shakes. |
Functions
Return Type | Signature | Description |
|---|---|---|
void | SetDefaults() | Initializes the default values for the setting, including possible selections and the default selection. It also sets up a delegate to apply the current setting when new actors are spawned. |
void | ApplyCurrentSetting(bool bUserRequest) | Applies the current camera shake setting to all actors in the world. If |
FString | FormatCameraShakeSetting(const bool bEnabled) | Formats a boolean value indicating whether camera shakes are enabled into a string representation. |
bool | UnFormatCameraShakeSetting(const FString& Selection) | Converts a string representation of the camera shake setting back into a boolean value. |
void | ApplyCurrentSettingInternal(AActor* Actor) const | Applies the current camera shake setting to a specific actor by enabling or disabling its |
Usage & Implementation Notes
Threading Constraints: This class does not have any specific threading constraints.
Replication Requirements: The class does not require replication as it operates on local actors.
Memory Lifetime Management: The delegate handle for applying settings to spawned actors is managed within the class. It ensures that the setting is applied to all existing and future actors in the world.
Initialization Dependencies: The
SetDefaultsfunction initializes necessary properties and sets up a delegate to ensure that camera shake settings are applied to new actors as they spawn.