Class: Paths

rune.util.Paths()

The rune.util.Paths class represents a stack of Path objects and provides a programmable interface for adding and removing objects from the stack. For example, the class is used by rune.tilemap.TilemapLayer to render paths on layers, for the purpose of debugging.

Constructor

new Paths()

Instantiates a new object of the class.
Source:
See:

Members

(readonly) length :number

The length property returns the number of paths in the stack.
Type:
  • number
Source:

m_paths :Array.<rune.util.Path>

Represents the stack of path objects.
Type:
Source:

Methods

add(path) → {undefined}

Adds a Path object to the stack.
Parameters:
Name Type Description
path rune.util.Path Path to add.
Source:
Returns:
Type
undefined

clear() → {undefined}

Removes all Path objects from the stack.
Source:
Returns:
Type
undefined

get(index) → {rune.util.Path}

Gets a Path object from the stack based on the object's index.
Parameters:
Name Type Description
index number Index of the Path object to retrieve.
Source:
Returns:
Type
rune.util.Path

remove(path) → {rune.util.Path}

Removes a Path object from the stack via active reference.
Parameters:
Name Type Description
path rune.util.Path Reference to the Path object to be removed.
Source:
Returns:
Type
rune.util.Path

removeAt(index) → {rune.util.Path}

Removes a Path object from the stack based on the specified index.
Parameters:
Name Type Description
index number Index of the Path object to be removed.
Source:
Returns:
Type
rune.util.Path