PortalCursor Class

Summary

PortalCursor is a class that allows a user to create and manage Portals with a visual cursor interface. The cursor can be toggled to enable or disable controls.
Namespace
ASL.PortalSystem
Base Types
  • MonoBehaviour
graph TD Base0["MonoBehaviour"]-->Type Type["PortalCursor"] class Type type-node

Syntax

public class PortalCursor : MonoBehaviour

Remarks

To use the PortalCursor with your own controls/buttons you can extend this class and override the PlayerPortalControls method. Make sure that the new method calls UpdateCursorTransform to update the position and orientation of the cursor.

Methods

Name Value Summary
PlayerPortalControls() void
This method is called from the Update function ensuring that the portal cursor updates for each frame. It provides the user controls for interacting with portals, but these can be overriden in a class that extends PortalCursor.