Highroad Engine v1.3
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
MoreMountains.HighroadEngine.CameraController Class Referenceabstract

Camera controller base class. Meant to be extended. More...

Inheritance diagram for MoreMountains.HighroadEngine.CameraController:
MoreMountains.HighroadEngine.IsometricCameraController MoreMountains.HighroadEngine.ParallelCamera MoreMountains.HighroadEngine.ThirdPersonCameraController

Public Types

enum  UpdateType { FixedUpdate , LateUpdate , Update }
 Define when camera movement is done. More...
 

Public Member Functions

abstract void RefreshTargets ()
 Override this method to refresh the list of targets. More...
 

Public Attributes

UpdateType UpdateMode
 
Transform[] HumanPlayers
 List of human players. More...
 
Transform[] BotPlayers
 List of bot players. More...
 

Protected Member Functions

virtual void Awake ()
 Initializes the camera gameobject More...
 
abstract void CameraUpdate ()
 Override this method to implement camera movement. More...
 
virtual void Update ()
 Unity Update More...
 
virtual void LateUpdate ()
 Unity LateUpdate More...
 
virtual void FixedUpdate ()
 Unity FixedUpdate More...
 

Protected Attributes

Camera _camera
 

Properties

abstract bool IsSinglePlayerCamera [get]
 
bool GameHasStarted [getset]
 Gets or sets a value indicating whether this game has started. More...
 

Detailed Description

Camera controller base class. Meant to be extended.

Member Enumeration Documentation

◆ UpdateType

Define when camera movement is done.

Enumerator
FixedUpdate 
LateUpdate 
Update 

Member Function Documentation

◆ Awake()

virtual void MoreMountains.HighroadEngine.CameraController.Awake ( )
protectedvirtual

Initializes the camera gameobject

◆ CameraUpdate()

abstract void MoreMountains.HighroadEngine.CameraController.CameraUpdate ( )
protectedpure virtual

◆ FixedUpdate()

virtual void MoreMountains.HighroadEngine.CameraController.FixedUpdate ( )
protectedvirtual

Unity FixedUpdate

◆ LateUpdate()

virtual void MoreMountains.HighroadEngine.CameraController.LateUpdate ( )
protectedvirtual

Unity LateUpdate

◆ RefreshTargets()

abstract void MoreMountains.HighroadEngine.CameraController.RefreshTargets ( )
pure virtual

◆ Update()

virtual void MoreMountains.HighroadEngine.CameraController.Update ( )
protectedvirtual

Unity Update

Member Data Documentation

◆ _camera

Camera MoreMountains.HighroadEngine.CameraController._camera
protected

◆ BotPlayers

Transform [] MoreMountains.HighroadEngine.CameraController.BotPlayers

List of bot players.

◆ HumanPlayers

Transform [] MoreMountains.HighroadEngine.CameraController.HumanPlayers

List of human players.

◆ UpdateMode

UpdateType MoreMountains.HighroadEngine.CameraController.UpdateMode

Property Documentation

◆ GameHasStarted

bool MoreMountains.HighroadEngine.CameraController.GameHasStarted
getset

Gets or sets a value indicating whether this game has started.

true if game has started; otherwise, false.

◆ IsSinglePlayerCamera

abstract bool MoreMountains.HighroadEngine.CameraController.IsSinglePlayerCamera
get

If set to true, means this camera can only follow one vehicle. This value must be overrided by subclasses


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