CameraStack

Back to reference

Holds camera states and allows for the last camera state to be retrieved.

Also initializes an impulse and default camera as the bottom of the stack. Is a singleton.

Members

Functions

Returns Functions Description
nil PrintCameraStack ( ) Outputs the camera stack
SummedCamera GetDefaultCamera ( ) Returns the default camera
ImpulseCamera GetImpulseCamera ( ) Returns the impulse camera.
DefaultCamera GetRawDefaultCamera ( ) Returns the default camera without any impulse cameras
CameraState nil GetTopState ( ) Retrieves the top state off the stack
CustomCameraEffect NewStateToUse GetNewStateBelow ( ) Returns a new camera state that retrieves the state below its set state
number nil GetIndex ( CameraState state ) Retrieves the index of a state
nil Remove ( CameraState state ) Removes the state from the stack
nil Add ( CameraState state ) Adds a state to the stack

Functions Descriptions

nil PrintCameraStack ( )

Outputs the camera stack

Returns

SummedCamera GetDefaultCamera ( )

Returns the default camera

Returns

ImpulseCamera GetImpulseCamera ( )

Returns the impulse camera. Useful for adding camera shake

Returns

DefaultCamera GetRawDefaultCamera ( )

Returns the default camera without any impulse cameras

Returns

CameraState nil GetTopState ( )

Retrieves the top state off the stack

Returns

CustomCameraEffect NewStateToUse GetNewStateBelow ( )

Returns a new camera state that retrieves the state below its set state

Returns

number nil GetIndex ( CameraState state )

Retrieves the index of a state

Parameters

Returns

  • number: Index of state
  • nil: If non on stack

nil Remove ( CameraState state )

Removes the state from the stack

Parameters

Returns

nil Add ( CameraState state )

Adds a state to the stack

Parameters

Returns