WarpInfo Class Reference

Detailed Description

This class remembers the warp the player last entered, and if the player is currently being warped.

Documentation updated 9/15/2024

Author

Roy Pascual

Note

This class does not inhert from monobehavior, so it does not have access to unity functions such as Start() or Update().

Properties
static string	WarpName = "NONE" [get, set]
	This is the name of the warp to spawn the player at. When a StageWarp's exit zone is triggered, this is set to the name of the corresponding StageWarp.
static bool	CurrentlyWarping = false [get, set]
	True if the player is currently warping (typically true during the fade-to-black animation the StageLoader plays).

Property Documentation

CurrentlyWarping

bool WarpInfo.CurrentlyWarping = false

staticgetset

True if the player is currently warping (typically true during the fade-to-black animation the StageLoader plays).

WarpName

string WarpInfo.WarpName = "NONE"

staticgetset

This is the name of the warp to spawn the player at. When a StageWarp's exit zone is triggered, this is set to the name of the corresponding StageWarp.

---

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

• Assets/Scripts/Stage/WarpInfo.cs