Small World Engine API Reference - v0.78.00
    Preparing search index...

    Class FlashEffect

    A post-processing screen flash for the camera (e.g. an explosion or impact hit-flash). Drives flashIntensity/flashColor, which the engine forwards each frame into the renderer's post-processing FlashElement -- this is a real full-screen overlay, not a camera-position jolt.

    Hierarchy (View Summary)

    Index
    flashColor: Color = ...

    Tint color for this effect's flash contribution.

    flashIntensity: number = 0

    This effect's contribution to the post-processing screen flash, in [0, 1].

    isFinished: boolean = false

    Whether the effect has finished its duration and should be removed.

    offset: Vector3D = ...

    The current position offset generated by this effect.

    pitchOffset: number = 0

    Pitch (X-axis) rotation offset in radians, applied to the view direction.

    targetOffset: Vector3D = ...

    The current target offset generated by this effect.

    type: CameraEffectType = CameraEffectType.FLASH

    The unique type identifier of the effect.

    yawOffset: number = 0

    Yaw (Y-axis) rotation offset in radians, applied to the view direction.