CameraShakeParameters Class Reference

Parameters to give listeners of the camera shake event. More...

Inheritance diagram for CameraShakeParameters:

Collaboration diagram for CameraShakeParameters:

Public Types
enum	CameraShakeIntensity { CameraShakeIntensity.EXTRA_LIGHT, CameraShakeIntensity.LIGHT, CameraShakeIntensity.MEDIUM, CameraShakeIntensity.HEAVY }

Public Member Functions
	CameraShakeParameters (CameraShakeIntensity shakeIntensity, bool compoundingShake)

Static Public Attributes
static readonly CameraShakeParameters	EXTRA_LIGHT_SHAKE_COMPOUNDING = new CameraShakeParameters(CameraShakeIntensity.EXTRA_LIGHT, true)
static readonly CameraShakeParameters	LIGHT_SHAKE_COMPOUNDING = new CameraShakeParameters(CameraShakeIntensity.LIGHT, true)
static readonly CameraShakeParameters	MEDIUM_SHAKE_COMPOUNDING = new CameraShakeParameters(CameraShakeIntensity.MEDIUM, true)
static readonly CameraShakeParameters	HEAVY_SHAKE_COMPOUNDING = new CameraShakeParameters(CameraShakeIntensity.HEAVY, true)
static readonly CameraShakeParameters	EXTRA_LIGHT_SHAKE_NONCOMPOUNDING = new CameraShakeParameters(CameraShakeIntensity.EXTRA_LIGHT, false)
static readonly CameraShakeParameters	LIGHT_SHAKE_NONCOMPOUNDING = new CameraShakeParameters(CameraShakeIntensity.LIGHT, false)
static readonly CameraShakeParameters	MEDIUM_SHAKE_NONCOMPOUNDING = new CameraShakeParameters(CameraShakeIntensity.MEDIUM, false)
static readonly CameraShakeParameters	HEAVY_SHAKE_NONCOMPOUNDING = new CameraShakeParameters(CameraShakeIntensity.HEAVY, false)
Static Public Attributes inherited from EventParameters
static readonly EventParameters	GLOBAL_EVENT_PARAMETER = new EventParameters()

Properties
CameraShakeIntensity	ShakeIntensity [get]
bool	CompoundingShake [get]

Detailed Description

Parameters to give listeners of the camera shake event.

A hand full of preconfigured parameters are stored as static variables for event publishers to use.

Member Enumeration Documentation

CameraShakeIntensity

enum CameraShakeParameters.CameraShakeIntensity

strong

Enumerator
EXTRA_LIGHT
LIGHT
MEDIUM
HEAVY

Constructor & Destructor Documentation

CameraShakeParameters()

CameraShakeParameters.CameraShakeParameters	(	CameraShakeIntensity	shakeIntensity,
		bool	compoundingShake
	)

Member Data Documentation

EXTRA_LIGHT_SHAKE_COMPOUNDING

readonly CameraShakeParameters CameraShakeParameters.EXTRA_LIGHT_SHAKE_COMPOUNDING = new CameraShakeParameters(CameraShakeIntensity.EXTRA_LIGHT, true)

static

EXTRA_LIGHT_SHAKE_NONCOMPOUNDING

readonly CameraShakeParameters CameraShakeParameters.EXTRA_LIGHT_SHAKE_NONCOMPOUNDING = new CameraShakeParameters(CameraShakeIntensity.EXTRA_LIGHT, false)

static

HEAVY_SHAKE_COMPOUNDING

readonly CameraShakeParameters CameraShakeParameters.HEAVY_SHAKE_COMPOUNDING = new CameraShakeParameters(CameraShakeIntensity.HEAVY, true)

static

HEAVY_SHAKE_NONCOMPOUNDING

readonly CameraShakeParameters CameraShakeParameters.HEAVY_SHAKE_NONCOMPOUNDING = new CameraShakeParameters(CameraShakeIntensity.HEAVY, false)

static

LIGHT_SHAKE_COMPOUNDING

readonly CameraShakeParameters CameraShakeParameters.LIGHT_SHAKE_COMPOUNDING = new CameraShakeParameters(CameraShakeIntensity.LIGHT, true)

static

LIGHT_SHAKE_NONCOMPOUNDING

readonly CameraShakeParameters CameraShakeParameters.LIGHT_SHAKE_NONCOMPOUNDING = new CameraShakeParameters(CameraShakeIntensity.LIGHT, false)

static

MEDIUM_SHAKE_COMPOUNDING

readonly CameraShakeParameters CameraShakeParameters.MEDIUM_SHAKE_COMPOUNDING = new CameraShakeParameters(CameraShakeIntensity.MEDIUM, true)

static

MEDIUM_SHAKE_NONCOMPOUNDING

readonly CameraShakeParameters CameraShakeParameters.MEDIUM_SHAKE_NONCOMPOUNDING = new CameraShakeParameters(CameraShakeIntensity.MEDIUM, false)

static

Property Documentation

CompoundingShake

bool CameraShakeParameters.CompoundingShake

get

Returns

Tells the camera shake algorithm how to add the new intensity to the existing intensity value.

ShakeIntensity

CameraShakeIntensity CameraShakeParameters.ShakeIntensity

get

Returns

How much the screen shake should increase.

---

The documentation for this class was generated from the following file:

• Assets/Scripts/Events/CameraShakeParameters.cs