TeleportTargetHandlerNode Class Reference

This target handler will only return locations that the aim system detects that contain a TeleportPoint component. More...

Inheritance diagram for TeleportTargetHandlerNode:
TeleportTargetHandler TeleportSupport

Public Attributes

float LOSOffset = 1.0f
 When checking line of sight to the destination, add this value to the vertical offset for targeting collision checks. More...
 
LayerMask TeleportLayerMask
 Teleport logic will only work with TeleportPoint components that exist in the layers specified by this mask. More...
 
- Public Attributes inherited from TeleportTargetHandler
LayerMask AimCollisionLayerMask
 This bitmask controls which game object layers will be included in the targeting collision tests. More...
 

Protected Member Functions

override bool ConsiderTeleport (Vector3 start, ref Vector3 end)
 This method will be called while the LocmotionTeleport component is in the aiming state, once for each line segment that the targeting beam requires. The function should return true whenever an actual target location has been selected. More...
 
- Protected Member Functions inherited from TeleportTargetHandler
 TeleportTargetHandler ()
 
override 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...
 
override 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...
 
virtual void ResetAimData ()
 
- Protected Member Functions inherited from TeleportSupport
virtual void OnEnable ()
 OnEnable is virtual so that derived classes can set up references to objects before AddEventHandlers is called, as is required by TeleportSupport derivations. More...
 
virtual void OnDisable ()
 

Additional Inherited Members

- Public Member Functions inherited from TeleportTargetHandler
virtual Vector3 ConsiderDestination (Vector3 location)
 Adjust the provided located to account for character height and perform any checks that might invalidate the target position of the character controller, such as collision with scene geometry or other actors. More...
 
- Protected Attributes inherited from TeleportTargetHandler
readonly LocomotionTeleport.AimData AimData = new LocomotionTeleport.AimData()
 
- Properties inherited from TeleportSupport
LocomotionTeleport LocomotionTeleport [get]
 

Detailed Description

This target handler will only return locations that the aim system detects that contain a TeleportPoint component.

Member Function Documentation

◆ ConsiderTeleport()

override bool TeleportTargetHandlerNode.ConsiderTeleport ( Vector3  start,
ref Vector3  end 
)
protectedvirtual

This method will be called while the LocmotionTeleport component is in the aiming state, once for each line segment that the targeting beam requires. The function should return true whenever an actual target location has been selected.

Implements TeleportTargetHandler.

Member Data Documentation

◆ LOSOffset

float TeleportTargetHandlerNode.LOSOffset = 1.0f

When checking line of sight to the destination, add this value to the vertical offset for targeting collision checks.

◆ TeleportLayerMask

LayerMask TeleportTargetHandlerNode.TeleportLayerMask

Teleport logic will only work with TeleportPoint components that exist in the layers specified by this mask.


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