TeleportAimHandler Class Referenceabstract

TeleportAimHandler will provide a series of points in the world that represent the series of line segments (as few as one for a laser) which the player uses to determine where they are aiming for a teleport. This is not the visualization of the aiming, it is merely the set of points representing the line, arc, or whatever shape makes sense for the teleport aiming mechanism which is then used to perform collision detection with the world in order to determine the final teleport target location. More...

Inheritance diagram for TeleportAimHandler:
TeleportSupport TeleportAimHandlerLaser TeleportAimHandlerParabolic

Public Member Functions

abstract void GetPoints (List< Vector3 > points)
 GetPoints provides the core purpose of this class: Return a sequence of points that represents the line segment or segments that should be collision tested against the world. More...
 

Protected Member Functions

override void OnEnable ()
 The LocomotionTeleport supports one aim handler at a time. Call the base OnEnable to make sure LocomotionTeleport is valid, then assign the current aim handler to this object. More...
 
override void OnDisable ()
 When this component is disabled, make sure to clear the LocomotionTeleport's aim handler but only if this is still the active handler. It's an unlikely edge case but it's more robust to make sure a different aim handler wasn't enabled before this was disabled. More...
 
- Protected Member Functions inherited from TeleportSupport
virtual void AddEventHandlers ()
 Derived classes that need to use event handlers need to override this method and call the base class to ensure all event handlers are added as intended. More...
 
virtual void RemoveEventHandlers ()
 Derived classes that need to use event handlers need to override this method and call the base class to ensure all event handlers are removed as intended. More...
 

Additional Inherited Members

- Properties inherited from TeleportSupport
LocomotionTeleport LocomotionTeleport [get]
 

Detailed Description

TeleportAimHandler will provide a series of points in the world that represent the series of line segments (as few as one for a laser) which the player uses to determine where they are aiming for a teleport. This is not the visualization of the aiming, it is merely the set of points representing the line, arc, or whatever shape makes sense for the teleport aiming mechanism which is then used to perform collision detection with the world in order to determine the final teleport target location.

Member Function Documentation

◆ GetPoints()

abstract void TeleportAimHandler.GetPoints ( List< Vector3 >  points)
pure virtual

GetPoints provides the core purpose of this class: Return a sequence of points that represents the line segment or segments that should be collision tested against the world.

Returns

Implemented in TeleportAimHandlerParabolic, and TeleportAimHandlerLaser.

◆ OnDisable()

override void TeleportAimHandler.OnDisable ( )
protectedvirtual

When this component is disabled, make sure to clear the LocomotionTeleport's aim handler but only if this is still the active handler. It's an unlikely edge case but it's more robust to make sure a different aim handler wasn't enabled before this was disabled.

Reimplemented from TeleportSupport.

◆ OnEnable()

override void TeleportAimHandler.OnEnable ( )
protectedvirtual

The LocomotionTeleport supports one aim handler at a time. Call the base OnEnable to make sure LocomotionTeleport is valid, then assign the current aim handler to this object.

Reimplemented from TeleportSupport.


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