unreal.GameplayCueNotify_CameraShakeInfo

class unreal.GameplayCueNotify_CameraShakeInfo(spawn_condition_override=[GameplayCueNotify_LocallyControlledSource.INSTIGATOR_ACTOR, GameplayCueNotify_LocallyControlledPolicy.ALWAYS, 1.0, [], []], placement_info_override=['None', GameplayCueNotify_AttachPolicy.DO_NOT_ATTACH, AttachmentRule.KEEP_WORLD, False, True, [0.0, 0.0, 0.0], [1.0, 1.0, 1.0]], camera_shake=None, shake_scale=1.0, play_space=GameplayCueNotify_EffectPlaySpace.CAMERA_SPACE, override_spawn_condition=False, override_placement_info=False, play_in_world=False, world_inner_radius=0.0, world_outer_radius=0.0, world_falloff_exponent=1.0)

Bases: unreal.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: Camera shake to play.

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

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

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

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

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

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

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

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

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

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

property camera_shake

[Read-Only] Camera Shake: Camera shake to play.

Type

(type(Class))

property override_placement_info

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

Type

(bool)

property override_spawn_condition

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

Type

(bool)

property placement_info_override

[Read-Only] Placement Info Override: Defines how the camera shake will be placed.

Type

(GameplayCueNotify_PlacementInfo)

property play_in_world

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

Type

(bool)

property play_space

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

Type

(GameplayCueNotify_EffectPlaySpace)

property shake_scale

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

Type

(float)

property spawn_condition_override

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

Type

(GameplayCueNotify_SpawnCondition)

property world_falloff_exponent

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

Type

(float)

property world_inner_radius

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

Type

(float)

property world_outer_radius

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

Type

(float)