Data Structures
class	BaseScriptedCameraItem

class	BaseScriptedCameraSet

class	CameraBaseClass

class	CameraHandlerComponentClass

class	CameraManagerClass

class	PlayerCameraClass

class	ScriptedCameraBaseClass

Functions
CameraBaseClass GenericEntityClass	ApplyTransform (float timeslice)
	Manually applies transformation. This is usually done in EOnPostFrame automatically. More...

proto external void	GetWorldCameraTransform (out vector mat[4])
	Get current camera world transformation. More...

proto external IEntity	GetCursorTarget ()

proto external IEntity	GetCursorTargetWithPosition (out vector outPosition)

proto external CameraType	GetProjType ()
	Get projection type. More...

proto external float	GetVerticalFOV ()

proto external float	GetNearPlane ()

proto external float	GetFarPlane ()

proto external void	SetFOVDegree (float fovDegrees)

proto external void	SetVerticalFOV (float fov)

proto external void	SetNearPlane (float nearPlane)

proto external void	SetFarPlane (float farPlane)

proto external void	SetCameraIndex (int cameraIndex)

proto external int	GetCameraIndex ()

proto external void	SetLensFlareSet (CameraLensFlareSetType type, string userName)

proto external bool	IsAABBVisible (vector mins, vector maxs)
	Test if the AABB is visible against the view frustum of the camera. More...

proto external bool	IsSphereVisible (vector origin, float radius)
	Test if the sphere is visible against the view frustum of the camera. More...

event protected void	CameraActivate ()
	Called the moment this camera is activated by CameraManager. More...

event protected void	CameraDeactivate ()
	Called the moment this camera is deactivated by CameraManager. More...

CameraHandlerComponentClass ScriptComponentClass	GetCameraSet ()

proto external bool	IsInThirdPerson ()
	Returns true if the camera is in third person mode. More...

proto external void	SetThirdPerson (bool val)
	Set the current third person camera state. More...

proto external float	GetFocusMode ()
	Returns the current value of the focus mode. More...

proto external void	SetFocusMode (float focusMode)
	Set the current value of the focus mode. More...

proto external float	GetBlendAlpha (ScriptedCameraItem forCameraItem)

proto external ScriptedCameraItem	GetCurrentCamera ()
	returns current active camera More...

proto external bool	IsCameraBlending ()
	returns true if there's more than one processing camera More...

event protected float	CalculateFovScalar (notnull CameraBase mainCamera, CameraBase overlayCamera)

event void	Init ()
	initialization More...

event void	OnCameraActivate ()
	activation More...

event void	OnCameraDeactivate ()
	deactivation More...

event int	CameraSelector ()
	selects next camera More...

event void	OnBeforeCameraUpdate (float pDt, bool pIsKeyframe)
	before camera update More...

event void	OnAfterCameraUpdate (float pDt, bool pIsKeyframe, inout vector transformMS[4], inout vector transformWS[4])
	after camera update More...

event void	CollisionSolver (float pDt, inout ScriptedCameraItemResult pOutResult, inout vector resCamTM[4], bool isKeyframe)
	collision solver More...

event void	OnThirdPersonSwitch (bool isInThirdPerson)
	when we switch between FPP and TPP More...

event float	GetCameraTransitionTime (int pFrom, int pTo)
	get how long should transition between given cameras be More...

event float	GetOverlayCameraFOVScalarWeight ()

CameraManagerClass GenericEntityClass	CurrentCamera ()
	Returns the current camera. More...

proto external bool	SetCamera (CameraBase pCam)

proto external void	SetNextCamera ()
	Set the next camera in the list as current camera. More...

proto external void	SetPreviousCamera ()
	Set the previous camera in the list as current camera. More...

proto external int	GetCamerasList (out notnull array< CameraBase > outCameras)

proto external void	SetOverlayCamera (CameraBase pCam)

proto external CameraBase	GetOverlayCamera ()

proto external void	SetFirstPersonFOV (float fieldOfView)

proto external float	GetFirstPersonFOV ()

proto external void	SetThirdPersonFOV (float fieldOfView)

proto external float	GetThirdPersonFOV ()

proto external void	SetVehicleFOV (float fieldOfView)

proto external float	GetVehicleFOV ()

proto external float	GetClampedFOV (float fieldOfView)

proto external float	GetMinFOV ()

proto external float	GetMaxFOV ()

event protected void	OnInit ()

proto external float	GetFocusFOV ()
	Returns the focus field of view in degrees. More...

proto external float	GetFocusFOVScale (float baseFOV, float scalar)
	Returns interpolated value from baseFOV to focusFOV based on the input scalar value. More...

Detailed Description

Function Documentation

◆ ApplyTransform()

CameraBaseClass GenericEntityClass ApplyTransform ( float timeslice )

Manually applies transformation. This is usually done in EOnPostFrame automatically.

◆ CalculateFovScalar()

event protected float CalculateFovScalar	(	notnull CameraBase	mainCamera,
		CameraBase	overlayCamera
	)

Calculate and return desired fov scalar. 1.0 = normal

Parameters

mainCamera	Main camera used, usually player camera
overlayCamera	Overlay camera, usually PiP camera or null

Definition at line 46 of file CameraHandlerComponent.c.

◆ CameraActivate()

event protected void CameraActivate ( )

Called the moment this camera is activated by CameraManager.

◆ CameraDeactivate()

event protected void CameraDeactivate ( )

Called the moment this camera is deactivated by CameraManager.

◆ CameraSelector()

event int CameraSelector ( )

selects next camera

game camera selection

we need to stabilize camera before roll action is complete, so by that time player is ready to aim at target

Setup here all conditions where we want to use camera transformation from bone directly Roll case

Definition at line 161 of file CharacterCameraHandlerComponent.c.

◆ CollisionSolver()

event void CollisionSolver	(	float	pDt,
		inout ScriptedCameraItemResult	pOutResult,
		inout vector	resCamTM[4],
		bool	isKeyframe
	)

collision solver

Definition at line 601 of file CharacterCameraHandlerComponent.c.

◆ CurrentCamera()

CameraManagerClass GenericEntityClass CurrentCamera ( )

Returns the current camera.

◆ GetBlendAlpha()

proto external float GetBlendAlpha ( ScriptedCameraItem forCameraItem )

◆ GetCameraIndex()

proto external int GetCameraIndex ( )

Get the current camera index.

Returns: Returns the camera index.

◆ GetCameraSet()

CameraHandlerComponentClass ScriptComponentClass GetCameraSet ( )

◆ GetCamerasList()

proto external int GetCamerasList ( out notnull array< CameraBase > outCameras )

Return the list of all cameras

Parameters

outCameras List where all cameras will be inserted.

Returns: The number of camera in the list

◆ GetCameraTransitionTime()

event float GetCameraTransitionTime	(	int	pFrom,
		int	pTo
	)

get how long should transition between given cameras be

Definition at line 325 of file CharacterCameraHandlerComponent.c.

◆ GetClampedFOV()

proto external float GetClampedFOV ( float fieldOfView )

Returns value clamped between min and max settings.

◆ GetCurrentCamera()

proto external ScriptedCameraItem GetCurrentCamera ( )

returns current active camera

◆ GetCursorTarget()

proto external IEntity GetCursorTarget ( )

Performs a raycast from the center of this camera in the forward direction. (result is cached within single frame and reused if called multiple times)

Returns: Reference to an entity if it was hit by the trace or null otherwise.

◆ GetCursorTargetWithPosition()

proto external IEntity GetCursorTargetWithPosition ( out vector outPosition )

Performs a raycast from the center of this camera in the forward direction. (result is cached within single frame and reused if called multiple times)

Parameters

outPosition Position of the ray and target intersect point.

Returns: Reference to an entity if it was hit by the trace or null otherwise.

◆ GetFarPlane()

proto external float GetFarPlane ( )

Get the current far plane clipping value.

Returns: Returns the far plane value in meters.

◆ GetFirstPersonFOV()

proto external float GetFirstPersonFOV ( )

Returns default first person field of view.

◆ GetFocusFOV()

proto external float GetFocusFOV ( )

Returns the focus field of view in degrees.

◆ GetFocusFOVScale()

proto external float GetFocusFOVScale	(	float	baseFOV,
		float	scalar
	)

Returns interpolated value from baseFOV to focusFOV based on the input scalar value.

◆ GetFocusMode()

PlayerCameraClass CameraBaseClass GetFocusMode ( )

Returns the current value of the focus mode.

Returns the current value of focus mode in the <0,1> range.

◆ GetMaxFOV()

proto external float GetMaxFOV ( )

Returns maximum allowed field of view value.

◆ GetMinFOV()

proto external float GetMinFOV ( )

Returns minimum allowed field of view value.

◆ GetNearPlane()

proto external float GetNearPlane ( )

Get the current near plane clipping value.

Returns: Returns the near plane value in meters.

◆ GetOverlayCamera()

proto external CameraBase GetOverlayCamera ( )

Get the current overlay camera

Returns: Returns the current overlay canera or null if none.

◆ GetOverlayCameraFOVScalarWeight()

event float GetOverlayCameraFOVScalarWeight ( )

Weight in the <0, 1> range of how much input sensitivity should be modulated if an overlay camera is active. (0 = main camera, 1 = overlay camera).

Definition at line 1100 of file CharacterCameraHandlerComponent.c.

◆ GetProjType()

proto external CameraType GetProjType ( )

Get projection type.

◆ GetThirdPersonFOV()

proto external float GetThirdPersonFOV ( )

Returns default third person field of view.

◆ GetVehicleFOV()

proto external float GetVehicleFOV ( )

Returns default vehicle field of view.

◆ GetVerticalFOV()

proto external float GetVerticalFOV ( )

Get the vertical FOV.

Returns: Returns the vertical FOV in degrees.

◆ GetWorldCameraTransform()

proto external void GetWorldCameraTransform ( out vector mat[4] )

Get current camera world transformation.

◆ Init()

event void Init ( )

initialization

Init black list, this will get all items that should be blacklisted and adds it to one unified set (Server only)

Returns: Returns true if init is successfull, returns false if not

Definition at line 35 of file CharacterCameraHandlerComponent.c.

◆ IsAABBVisible()

proto external bool IsAABBVisible	(	vector	mins,
		vector	maxs
	)

Test if the AABB is visible against the view frustum of the camera.

◆ IsCameraBlending()

proto external bool IsCameraBlending ( )

returns true if there's more than one processing camera

◆ IsInThirdPerson()

proto external bool IsInThirdPerson ( )

Returns true if the camera is in third person mode.

◆ IsSphereVisible()

proto external bool IsSphereVisible	(	vector	origin,
		float	radius
	)

Test if the sphere is visible against the view frustum of the camera.

◆ OnAfterCameraUpdate()

event void OnAfterCameraUpdate	(	float	pDt,
		bool	pIsKeyframe,
		inout vector	transformMS[4],
		inout vector	transformWS[4]
	)

after camera update

aiming update

update recoil and generic camera shake

Definition at line 535 of file CharacterCameraHandlerComponent.c.

◆ OnBeforeCameraUpdate()

event void OnBeforeCameraUpdate	(	float	pDt,
		bool	pIsKeyframe
	)

before camera update

Definition at line 436 of file CharacterCameraHandlerComponent.c.

◆ OnCameraActivate()

event void OnCameraActivate ( )

activation

Definition at line 29 of file SCR_PostProcessCameraComponent.c.

◆ OnCameraDeactivate()

event void OnCameraDeactivate ( )

deactivation

Definition at line 38 of file SCR_PostProcessCameraComponent.c.

◆ OnInit()

event protected void OnInit ( )

Called on initialization.

◆ OnThirdPersonSwitch()

event void OnThirdPersonSwitch ( bool isInThirdPerson )

when we switch between FPP and TPP

Definition at line 399 of file CharacterCameraHandlerComponent.c.

◆ SetCamera()

proto external bool SetCamera ( CameraBase pCam )

Set the current camera, it should be alreday registered in this Camera Manager.

Parameters

cam	Camera which will be the new camera used.

◆ SetCameraIndex()

proto external void SetCameraIndex ( int cameraIndex )

Set the current camera index.

Parameters

cameraIndex The new camera index.

◆ SetFarPlane()

proto external void SetFarPlane ( float farPlane )

Set the current far plane value.

Parameters

farPlane The new far plane value in meters.

◆ SetFirstPersonFOV()

proto external void SetFirstPersonFOV ( float fieldOfView )

Sets default first person field of view.

◆ SetFocusMode()

proto external void SetFocusMode ( float focusMode )

Set the current value of the focus mode.

◆ SetFOVDegree()

proto external void SetFOVDegree ( float fovDegrees )

Set full symmetrical vertical FOV in degrees.

Parameters

fovDegrees Vertical FOV in degrees.

◆ SetLensFlareSet()

proto external void SetLensFlareSet	(	CameraLensFlareSetType	type,
		string	userName
	)

Sets camera lens flare set

Parameters

type	type of the lens flare set
userSetName	user name of the lens flare set (used only when type is set to User)

◆ SetNearPlane()

proto external void SetNearPlane ( float nearPlane )

Set the current near plane clipping value.

Parameters

nearPlane The new near plane value in meters.

◆ SetNextCamera()

proto external void SetNextCamera ( )

Set the next camera in the list as current camera.

◆ SetOverlayCamera()

proto external void SetOverlayCamera ( CameraBase pCam )

Set the current overlay camera

Parameters

pCamera Camera which will be the new overlay camera.

◆ SetPreviousCamera()

proto external void SetPreviousCamera ( )

Set the previous camera in the list as current camera.

◆ SetThirdPerson()

proto external void SetThirdPerson ( bool val )

Set the current third person camera state.

◆ SetThirdPersonFOV()

proto external void SetThirdPersonFOV ( float fieldOfView )

Sets default first person field of view.

◆ SetVehicleFOV()

proto external void SetVehicleFOV ( float fieldOfView )

Sets default vehicle field of view.

◆ SetVerticalFOV()

proto external void SetVerticalFOV ( float fov )

Set the vertical FOV.

Parameters

fov	FOV in degrees.

Data Structures

Functions

Detailed Description

Function Documentation

◆ ApplyTransform()

◆ CalculateFovScalar()

◆ CameraActivate()

◆ CameraDeactivate()

◆ CameraSelector()

◆ CollisionSolver()

◆ CurrentCamera()

◆ GetBlendAlpha()

◆ GetCameraIndex()

◆ GetCameraSet()

◆ GetCamerasList()

◆ GetCameraTransitionTime()

◆ GetClampedFOV()

◆ GetCurrentCamera()

◆ GetCursorTarget()

◆ GetCursorTargetWithPosition()

◆ GetFarPlane()

◆ GetFirstPersonFOV()

◆ GetFocusFOV()

◆ GetFocusFOVScale()

◆ GetFocusMode()

◆ GetMaxFOV()

◆ GetMinFOV()

◆ GetNearPlane()

◆ GetOverlayCamera()

◆ GetOverlayCameraFOVScalarWeight()

◆ GetProjType()

◆ GetThirdPersonFOV()

◆ GetVehicleFOV()

◆ GetVerticalFOV()

◆ GetWorldCameraTransform()

◆ Init()

◆ IsAABBVisible()

◆ IsCameraBlending()

◆ IsInThirdPerson()

◆ IsSphereVisible()

◆ OnAfterCameraUpdate()

◆ OnBeforeCameraUpdate()

◆ OnCameraActivate()

◆ OnCameraDeactivate()

◆ OnInit()

◆ OnThirdPersonSwitch()

◆ SetCamera()

◆ SetCameraIndex()

◆ SetFarPlane()

◆ SetFirstPersonFOV()

◆ SetFocusMode()

◆ SetFOVDegree()

◆ SetLensFlareSet()

◆ SetNearPlane()

◆ SetNextCamera()

◆ SetOverlayCamera()

◆ SetPreviousCamera()

◆ SetThirdPerson()

◆ SetThirdPersonFOV()

◆ SetVehicleFOV()

◆ SetVerticalFOV()