Class TeleportTask
Task for handle logic during player teleport
Properties
Duration
Teleport takes this frames long to finish
Declaration
public int Duration { get; set; }TeleportFrom
Teleport from this position in global space
Declaration
public Int2 TeleportFrom { get; set; }TeleportTo
Teleport to this position in global space
Declaration
public Int3 TeleportTo { get; set; }UseParallax
True if use the map layer parallax effect during teleport
Declaration
public bool UseParallax { get; set; }UseVignette
True if use the vignette effect during teleport
Declaration
public bool UseVignette { get; set; }WaitDuration
Teleport actually start after wait this frames long
Declaration
public int WaitDuration { get; set; }Methods
FrameUpdate()
This function is used to handle the internal logic.
Declaration
public override TaskResult FrameUpdate()Returns
| Type | Description |
|---|---|
| TaskResult | "Continue" if the task should keep on after this frame. "End" if the task should end. |
Overrides
OnStart()
This function is called when this task start
Declaration
public override void OnStart()Overrides
TeleportFromDoor(int, int, int, int, int)
Make a teleport for selecting player by using a door
Declaration
public static TeleportTask TeleportFromDoor(int fromX, int fromY, int toX, int toY, int toZ)Parameters
| Type | Name | Description |
|---|---|---|
| int | fromX | (in global space) |
| int | fromY | (in global space) |
| int | toX | (in global space) |
| int | toY | (in global space) |
Returns
| Type | Description |
|---|---|
| TeleportTask | Global single instance of the task unit |
TeleportFromPortal(int, int, int, int, int, bool)
Make a teleport for selecting player by using a portal
Declaration
public static TeleportTask TeleportFromPortal(int fromX, int fromY, int toX, int toY, int toZ, bool samePosition)Parameters
| Type | Name | Description |
|---|---|---|
| int | fromX | (in global space) |
| int | fromY | (in global space) |
| int | toX | (in global space) |
| int | toY | (in global space) |
| bool | samePosition | True if the X and Y position are the same |
Returns
| Type | Description |
|---|---|
| TeleportTask | Global single instance of the task unit |