Difference between revisions of "Namespace Guide rtp"

From MINR.ORG WIKI
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 +
[[Namespace Documentation|Return to namespace list]]
 +
 
= rtp =
 
= rtp =
 
'''Status: STABLE (safe to use)'''
 
'''Status: STABLE (safe to use)'''
Line 4: Line 6:
 
== Types ==
 
== Types ==
  
 
+
=== TpData===
 
A data structure to manage teleport destinations that are set by a player positioned at the desired location.
 
A data structure to manage teleport destinations that are set by a player positioned at the desired location.
  

Latest revision as of 02:21, 30 April 2020

Return to namespace list

rtp[edit]

Status: STABLE (safe to use)

Types[edit]

TpData[edit]

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

Fields (6)[edit]

  • 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

Constructors (1)[edit]

  • rtp::TpData(Player setter) : destination fields are set to match the setter's position at the time of initialization

Methods (3)[edit]

  • 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

Rtp[edit]

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

Fields (3)[edit]

  • 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

Constructors (4)[edit]

  • 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

Methods (8)[edit]

  • 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'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