Class Warp

Main class for dream warping the player to a new scene

Inheritance

object

Warp

Namespace: WeaverCore

Assembly: WeaverCore.dll

Syntax

public static class Warp

Properties

DreamWarpDefaults

The default customization options when warping the player

Declaration

public static Warp.DreamWarpOptions DreamWarpDefaults { get; }

Property Value

Type	Description
Warp.DreamWarpOptions

Warping

Is the player currently dream warping?

Declaration

public static bool Warping { get; }

Property Value

Type	Description
bool

Methods

DoDreamnailWarp(Vector3, string, string, string, float, bool, DreamWarpOptions)

Warps the player to a new scene and plays the dream nail effects when doing so

Declaration

public static void DoDreamnailWarp(Vector3 position, string destinationScene, string returnScene, string gateName = "door1", float warpDelay = 1.75, bool noCharms = false, Warp.DreamWarpOptions options = null)

Parameters

Type	Name	Description
Vector3	position	The position the effects should take place at
string	destinationScene	The destination scene the player should be warped to
string	returnScene	The scene the player should return to when leaving the destination scene
string	gateName	The name of the TransitionPoint the player should spawn at when entering the destinationScene
float	warpDelay	The delay before the player is transported to the new scene
bool	noCharms	Should the player have no access to charms in the destination scene?
Warp.DreamWarpOptions	options	The customization options for the warp sequence