Skip to content

PathTool

Extends: Tool < Object

Description

The tool used to edit paths.

Accessed by Global.Editor.Tools["PathTool"].

Properties

int Sorting
float Smoothness
bool fadeIn
bool fadeOut
bool grow
bool shrink
Texture Texture
OptionButton LayerMenu
int ActiveLayer
float Width
bool isDrawing
Pathway ActivePath
bool BlockLight
Dictionary LibraryMemory

Methods

void SetLayer ( int index )
void StartPath ( )
void UpdatePath ( )
void Confirm ( )
void EndPath ( bool loop )
void SetSorting ( int sorting )
void SetFadeIn ( bool value )
void SetFadeOut ( bool value )
void SetTransitionIn ( int value )
void SetTransitionOut ( int value )
void SetBlockLight ( bool value )

Property Descriptions

  • int Sorting:
    Where the next path will be sorted. Underlying type is an enum. 0 = Over, 1 = Under. Read only. Set with SetSorting() instead.
  • float Smoothness:
    Gets or sets the next path's smoothness. 0 to 1.
  • bool fadeIn:
    Gets or sets the next path's fade in. Better to use SetFadeIn() to set.
  • bool fadeOut:
    Gets or sets the next path's fade in. Better to use SetFadeOut() to set.
  • bool grow:
    Gets or sets the next path's fade in. Better to use SetTransitionIn()/SetTransitionOut() to set.
  • bool shrink:
    Gets or sets the next path's fade in. Better to use SetTransitionIn()/SetTransitionOut() to set.
  • Texture Texture:
    Gets and sets the texture used for the next path drawn.
  • OptionButton LayerMenu:
    The reference to the layer menu in the Path Tool when it is active.
  • int ActiveLayer:
    Gets and sets whether the tool's layer.
  • float Width:
    Gets and sets the width used for the next path drawn.
  • bool isDrawing:
    Whether the user is actively drawing.
  • Pathway ActivePath:
    Gets the current unfinished Pathway (path).
  • bool BlockLight:
    Allows the user to adjust blocking light.
  • Dictionary LibraryMemory:
    The data that represents the last loaded state of the library panel.

Method Descriptions

  • void SetLayer ( int index ):
    Set layer option and update the active link:Pathway` to reflect it.
  • void StartPath ( ):
    Create a new path with zero points and sets it as the ActivePath.
  • void UpdatePath ( ):
    Updates the visuals of the current unfinished path.
  • void Confirm ( ):
    Finishes any path started and closes loops if possible. Calls EndPath() internally.
  • void EndPath ( bool loop ):
    Called by Confirm(). Better to not call directly.
  • void SetSorting ( int sorting ):
    Sets the sorting of the tool, and updates the preview Prop to reflect it. 0 = Over, 1 = Under.
  • void SetTransitionIn ( int value ):
    Sets the type of transition for the fade. 0 is disable, 1 is fade in, 2 is grow/shrink.
  • void SetTransitionOut ( int value ):
    Sets the type of transition for the fade. 0 is disable, 1 is fade in, 2 is grow/shrink.
  • void SetBlockLight ( bool value ):
    Updates whether the current unfinished path should block light.