Platformer Pro  2.3.2
A platform game kit for Unity.
PlatformerPro.CameraTransitionPoint Class Reference

An area which triggers a transition of the camera. More...

Inheritance diagram for PlatformerPro.CameraTransitionPoint:
PlatformerPro.CameraZone PlatformerPro.PlatformerProMonoBehaviour

Protected Member Functions

override void Init ()
 Initialise this instance. More...
 

Protected Attributes

CameraZone parentZone
 The parent camera zone. More...
 
- Protected Attributes inherited from PlatformerPro.CameraZone
Vector2 min
 
Vector2 max
 
bool initialised
 

Properties

override CameraZone ActualZone [get]
 Gets the actual zone that the camera should be in (i.e. the parent zone). More...
 
- Properties inherited from PlatformerPro.CameraZone
bool ZoneSmallerThanView [get, protected set]
 Track if the zone is smaller than camera viewport. If it is we wont snap to bounds. More...
 
virtual Vector3 CameraPosition [get]
 Gets the position the camera should transition to. More...
 
virtual CameraZone ActualZone [get]
 Gets the actual zone that the camera should be in. Could be different to this for example in the case of a Transition Point. More...
 
- Properties inherited from PlatformerPro.PlatformerProMonoBehaviour
virtual string Header [get]
 Gets the header string used to describe the component. More...
 
virtual string DocLink [get]
 Gets a link to documentation site. More...
 
virtual string VideoLink [get]
 Gets a link to a youtube video. More...
 
virtual string Deprecated [get]
 If non-null this component is deprecated. The string shows a message indicating how it should be replaced. More...
 

Additional Inherited Members

- Public Member Functions inherited from PlatformerPro.CameraZone
bool IsInZone (Transform t)
 Returns true if transform is in zone. More...
 
virtual Vector2 Max (Camera camera)
 Gets the maximum bounds. More...
 
virtual Vector2 Min (Camera camera)
 Gets the minimum bounds. More...
 
Vector3 GetBestPositionForCharacter (Camera camera, Character character)
 
- Public Member Functions inherited from PlatformerPro.PlatformerProMonoBehaviour
virtual void Validate (PlatformerProMonoBehaviour myTarget)
 Override this method if you want to provide custom validation. The actual code should be surrounded by the if UNITY_EDITOR / endif directive. More...
 
- Public Attributes inherited from PlatformerPro.CameraZone
float cameraZOffset
 The cameras Z offset from this zones transform. More...
 
float width
 Width of the zone in world units. More...
 
float height
 Height of the zone in world units. More...
 
bool updateDynamically
 
Color zoneColor = new Color(0,0,1,0.05f)
 
Color outlineColor = new Color(0,0,1,0.25f)
 
- Static Public Attributes inherited from PlatformerPro.CameraZone
static List< CameraZonecameraZones = new List<CameraZone>()
 Static list of all camera zones. More...
 

Detailed Description

An area which triggers a transition of the camera.

Member Function Documentation

◆ Init()

override void PlatformerPro.CameraTransitionPoint.Init ( )
protectedvirtual

Initialise this instance.

Reimplemented from PlatformerPro.CameraZone.

Member Data Documentation

◆ parentZone

CameraZone PlatformerPro.CameraTransitionPoint.parentZone
protected

The parent camera zone.

Property Documentation

◆ ActualZone

override CameraZone PlatformerPro.CameraTransitionPoint.ActualZone
get

Gets the actual zone that the camera should be in (i.e. the parent zone).

The actual zone.


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