ScreenEffectComponentData

Inherits from ComponentData

Summary

Constructors

ScreenEffectComponentData()
ScreenEffectComponentData(guid: Guid)
ScreenEffectComponentData(other: ComponentData)
ScreenEffectComponentData(other: GameObjectData)
ScreenEffectComponentData(other: GameDataContainer)
ScreenEffectComponentData(other: DataContainer)

Properties

Name Type
screenEffectParams Vec4
frameType ScreenEffectFrameType
shader SurfaceShaderBaseAsset | nil
frameWidth float
outerFrameOpacity float
innerFrameOpacity float
angle float
realm Realm

Static members

Name Type
ScreenEffectComponentData.typeInfo TypeInformation

Constructors

ScreenEffectComponentData

ScreenEffectComponentData()

Creates a new ScreenEffectComponentData frostbite instance.

ScreenEffectComponentData

ScreenEffectComponentData(guid: Guid)

Creates a new ScreenEffectComponentData frostbite instance and assigns it the provided Guid.

Parameters

Name Type Description
guid Guid The Guid to assign to the newly created instance.

ScreenEffectComponentData

ScreenEffectComponentData(other: ComponentData)

Casts an instance of type ComponentData to ScreenEffectComponentData. Will throw an error when trying to cast from an unsupported type.

Parameters

Name Type Description
other ComponentData The instance to cast to ScreenEffectComponentData.

ScreenEffectComponentData

ScreenEffectComponentData(other: GameObjectData)

Casts an instance of type GameObjectData to ScreenEffectComponentData. Will throw an error when trying to cast from an unsupported type.

Parameters

Name Type Description
other GameObjectData The instance to cast to ScreenEffectComponentData.

ScreenEffectComponentData

ScreenEffectComponentData(other: GameDataContainer)

Casts an instance of type GameDataContainer to ScreenEffectComponentData. Will throw an error when trying to cast from an unsupported type.

Parameters

Name Type Description
other GameDataContainer The instance to cast to ScreenEffectComponentData.

ScreenEffectComponentData

ScreenEffectComponentData(other: DataContainer)

Casts an instance of type DataContainer to ScreenEffectComponentData. Will throw an error when trying to cast from an unsupported type.

Parameters

Name Type Description
other DataContainer The instance to cast to ScreenEffectComponentData.

Properties

screenEffectParams

Vec4

frameType

ScreenEffectFrameType

shader

SurfaceShaderBaseAsset | nil

frameWidth

float

outerFrameOpacity

float

innerFrameOpacity

float

angle

float

realm

Realm

Static members

typeInfo

TypeInformation

The type information for the ScreenEffectComponentData type.

Last modified April 26, 2020: Update frostbite type documentation (8b14351)