Editing Builtin Namespace Guide

[[Namespace Documentation|Return to namespace list]]

= Built-Ins =
'''Status: STABLE (safe to use)'''

== Types ==

=== TpData ===
A data structure to manage teleport destinations that are set by a player positioned at the desired location.

<div class="mw-collapsible mw-collapsed" style="border:1px solid #888888; padding:7px;>
==== Fields EDIT ME (6) ====
<div class="mw-collapsible-content">
* '''Double x''' : x-coordinate of the teleport destination
* '''Double y''' : y-coordinate of the teleport destination
* '''Double z''' : z-coordinate of the teleport destination
* '''Float yaw''' : yaw of the teleport destination
* '''Float pitch''' : pitch of the teleport destination
* '''String world''' : world of the teleport destination
</div></div>

<div class="mw-collapsible mw-collapsed" style="border:1px solid #888888; padding:7px;">
==== Constructors (1) ====
<div class="mw-collapsible-content">
* '''rtp::TpData(Player setter)''' : destination fields are set to match the ''setter''<nowiki>'</nowiki>s position at the time of initialization
</div></div>

<div class="mw-collapsible mw-collapsed" style="border:1px solid #888888; padding:7px;">
==== Methods (3) ====
<div class="mw-collapsible-content">
* '''String string()''' : returns a simplified representation of the position held by the structure
* '''String tpString()''' : returns a string representation of an anonymous tp call performed by tpHere
* '''Void tpHere(Player player)''': teleports the ''player'' to the position held by the structure
</div></div>

=== Rtp ===
A TpData list selector and management tool that mimics the /rtp plugin functionality.

<div class="mw-collapsible mw-collapsed" style="border:1px solid #888888; padding:7px;">
==== Fields (3) ====
<div class="mw-collapsible-content">
* '''String name''' : custom identifier for the set of teleport locations
* '''Boolean doLogging''' : flag to enable logging of each use of teleportation
* '''rtp::TpData[] tpList''' : list of potential teleport locations
</div></div>

<div class="mw-collapsible mw-collapsed" style="border:1px solid #888888; padding:7px;">
==== Constructors (4) ====
<div class="mw-collapsible-content">
* '''rtp::Rtp()''' : initialize an empty location manager (defaults "UNNAMED", true)
* '''rtp::Rtp(String name)''' : initialize a location manager with identifier name set
* '''rtp::Rtp(Boolean doLogging)''' : initialize with logging option set
* '''rtp::Rtp(String name, Boolean doLogging)''' : initialize with name and logging set
</div></div>

<div class="mw-collapsible mw-collapsed" style="border:1px solid #888888; padding:7px;">
==== Methods (8) ====
<div class="mw-collapsible-content">
* '''String string()''' : returns a representation of name, logging status, and capacity of the structure
* '''Int count()''' : returns size of the managed location list
* '''Void setName(String name)''' : updates the name of the structure
* '''Void setLogging(Boolean doLogging)''' : updates the logging status of the structure
* '''Void addWarp(Player setter)''' : adds a location generated from ''setter''<nowiki>'</nowiki>s position at the time of the function call
* '''Void removeWarp(Int index)''' : removes a location specified by the ''index'' (between 1 and Rtp.count() inclusive)
* '''Void useWarp(Player player, Int index)''' : warps the ''player'' to the location specified by ''index'' (1 to count() inclusive), performing optional logging
* '''Void rtp(Player player)''' : Selects a location randomly and performs the actions of useWarp using the ''player''
</div></div>