StageWarp Class Reference

Detailed Description

Basic component of StageWarp.prefab that stores basic information about the it, including the warp name, destination name, and warp type.

Documentation updated 9/15/2024

Author

Roy Pascual

Public Attributes
string	srcWarpName = "DEFAULT_SOURCE"
	Name of this warp. Used to identify it when connecting another warp to this one as its destination.
string	destWarpName = "DEFAULT_DESTINATION"
	Name of the destination warp. This is the warp the player will be teleported to after traveling through this one.
StageWarpType	warpType = StageWarpType.DirectExit
	The type of warp functionality this warp will have. A DirectExit will immediately warp the player upon entering the warp zone, while DoorExit requires the player to give upwards input.
string	sceneToWarpTo
	Name of the scene the destination warp is in. If it's in the same scene, use "this".

Protected Attributes
Transform	entryPoint
	Reference to the StageWarp's entry point, which is a transform and a child of StageWarp.prefab. It's the position the player will spawn at when it warps to this StageWarp (the "spawnpoint").

Properties
Vector2	EntryPos [get]
	The coordinates of this StageWarp's entry point, which is just entryPoint.position.

Private Member Functions
void	Awake ()
	Set refernce to the entry point.

Member Function Documentation

Awake()

void StageWarp.Awake ( )

private

Set refernce to the entry point.

Member Data Documentation

destWarpName

string StageWarp.destWarpName = "DEFAULT_DESTINATION"

Name of the destination warp. This is the warp the player will be teleported to after traveling through this one.

entryPoint

Transform StageWarp.entryPoint

protected

Reference to the StageWarp's entry point, which is a transform and a child of StageWarp.prefab. It's the position the player will spawn at when it warps to this StageWarp (the "spawnpoint").

sceneToWarpTo

string StageWarp.sceneToWarpTo

Name of the scene the destination warp is in. If it's in the same scene, use "this".

srcWarpName

string StageWarp.srcWarpName = "DEFAULT_SOURCE"

Name of this warp. Used to identify it when connecting another warp to this one as its destination.

warpType

StageWarpType StageWarp.warpType = StageWarpType.DirectExit

The type of warp functionality this warp will have. A DirectExit will immediately warp the player upon entering the warp zone, while DoorExit requires the player to give upwards input.

Property Documentation

EntryPos

Vector2 StageWarp.EntryPos

get

The coordinates of this StageWarp's entry point, which is just entryPoint.position.

---

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

• Assets/Scripts/Stage/StageWarp.cs