unreal.GameplayCueNotify_CameraShakeInfo

class unreal.GameplayCueNotify_CameraShakeInfo(spawn_condition_override: GameplayCueNotify_SpawnCondition = Ellipsis, placement_info_override: GameplayCueNotify_PlacementInfo = Ellipsis, camera_shake: Class = Ellipsis, shake_scale: float = 0.0, play_space: GameplayCueNotify_EffectPlaySpace = Ellipsis, override_spawn_condition: bool = False, override_placement_info: bool = False, play_in_world: bool = False, world_inner_radius: float = 0.0, world_outer_radius: float = 0.0, world_falloff_exponent: float = 0.0)

Bases: StructBase

FGameplayCueNotify_CameraShakeInfo

Properties that specify how to play a camera shake.

C++ Source:

  • Plugin: GameplayAbilities

  • Module: GameplayAbilities

  • File: GameplayCueNotifyTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

  • camera_shake (type(Class)): [Read-Write] Camera shake to play.

  • override_placement_info (bool): [Read-Write] If enabled, use the placement info override and not the default one.

  • override_spawn_condition (bool): [Read-Write] If enabled, use the spawn condition override and not the default one.

  • placement_info_override (GameplayCueNotify_PlacementInfo): [Read-Write] Defines how the camera shake will be placed.

  • play_in_world (bool): [Read-Write] If enabled, the camera shake will be played in the world and affect all players.

  • play_space (GameplayCueNotify_EffectPlaySpace): [Read-Write] What coordinate space to play the camera shake relative to.

  • shake_scale (float): [Read-Write] Scale applied to the camera shake.

  • spawn_condition_override (GameplayCueNotify_SpawnCondition): [Read-Write] Condition to check before playing the camera shake.

  • world_falloff_exponent (float): [Read-Write] Exponent that describes the shake intensity falloff curve between the inner and outer radii. (1.0 is linear)

  • world_inner_radius (float): [Read-Write] Players inside this radius get the full intensity camera shake.

  • world_outer_radius (float): [Read-Write] Players outside this radius do not get the camera shake applied.

property camera_shake: Class

[Read-Only] Camera shake to play.

Type:

(type(Class))

property override_placement_info: bool

[Read-Only] If enabled, use the placement info override and not the default one.

Type:

(bool)

property override_spawn_condition: bool

[Read-Only] If enabled, use the spawn condition override and not the default one.

Type:

(bool)

property placement_info_override: GameplayCueNotify_PlacementInfo

[Read-Only] Defines how the camera shake will be placed.

Type:

(GameplayCueNotify_PlacementInfo)

property play_in_world: bool

[Read-Only] If enabled, the camera shake will be played in the world and affect all players.

Type:

(bool)

property play_space: GameplayCueNotify_EffectPlaySpace

[Read-Only] What coordinate space to play the camera shake relative to.

Type:

(GameplayCueNotify_EffectPlaySpace)

property shake_scale: float

[Read-Only] Scale applied to the camera shake.

Type:

(float)

property spawn_condition_override: GameplayCueNotify_SpawnCondition

[Read-Only] Condition to check before playing the camera shake.

Type:

(GameplayCueNotify_SpawnCondition)

property world_falloff_exponent: float

[Read-Only] Exponent that describes the shake intensity falloff curve between the inner and outer radii. (1.0 is linear)

Type:

(float)

property world_inner_radius: float

[Read-Only] Players inside this radius get the full intensity camera shake.

Type:

(float)

property world_outer_radius: float

[Read-Only] Players outside this radius do not get the camera shake applied.

Type:

(float)