Builtin Namespace Guide - Revision history

Yeroc424: /* Boolean */

2020-04-30T20:02:52Z

Boolean

← Older revision		Revision as of 20:02, 30 April 2020
Line 15:		Line 15:

	=== Boolean ===		=== Boolean ===
			A simple type with two values [true, false] used for conditional scripts (e.g. those including @if)
	<div class="mw-collapsible mw-collapsed" style="border:1px solid #888888; padding:7px;>		<div class="mw-collapsible mw-collapsed" style="border:1px solid #888888; padding:7px;>
	==== Constructors (2) ====		==== Constructors (2) ====

Yeroc424: /* Operators TODO */

2020-04-30T20:01:08Z

Operators TODO

← Older revision		Revision as of 20:01, 30 April 2020
Line 25:		Line 25:
	<div class="mw-collapsible-content">		<div class="mw-collapsible-content">
	'''Unary Operators (always before the Boolean)'''		'''Unary Operators (always before the Boolean)'''
	* Boolean !<Boolean>		* '''Boolean ! <Boolean>''' : Returns the opposite value of the Boolean (if true, returns false; and vice versa)
	'''Type-Preserving Binary Operators'''		'''Type-Preserving Binary Operators'''
	* '''Boolean <Boolean> && <Boolean>''' : Returns the AND of two Booleans (e.g. returns true if both operands are true, otherwise returns false).		* '''Boolean <Boolean> && <Boolean>''' : Returns the AND of two Booleans (e.g. returns true if both operands are true, otherwise returns false).

Yeroc424: /* Operators TODO */

2020-04-30T20:00:11Z

Operators TODO

← Older revision		Revision as of 20:00, 30 April 2020
Line 26:		Line 26:
	'''Unary Operators (always before the Boolean)'''		'''Unary Operators (always before the Boolean)'''
	* Boolean !<Boolean>		* Boolean !<Boolean>
	'''~~Same~~-~~Type~~ Binary Operators'''		'''Type-Preserving Binary Operators'''
	* Boolean <Boolean>&&<Boolean>		* '''Boolean <Boolean> && <Boolean>''' : Returns the AND of two Booleans (e.g. returns true if both operands are true, otherwise returns false).
	* Boolean <Boolean>\|\|<Boolean>		* '''Boolean <Boolean> \|\| <Boolean>''' : Returns the OR of two Booleans (e.g. returns false if both operands are false, otherwise returns true).
	* Boolean <Boolean>==<Boolean>		* '''Boolean <Boolean> == <Boolean>''' : Returns true if two Booleans have the same value, otherwise returns false.
	* Boolean <Boolean>!=<Boolean>		* '''Boolean <Boolean> != <Boolean>''' : Returns false if two Booleans have the same value, otherwise returns true.
	'''Type-~~Alter~~		'''Type-Casting Binary Operators'''
			* '''String <Boolean> + <String>''' : Casts the Boolean to a String, then returns the strings joined in order (also accepts <String> + <Boolean>).
	</div></div>		</div></div>
	<div class="mw-collapsible mw-collapsed" style="border:1px solid #888888; padding:7px;>		<div class="mw-collapsible mw-collapsed" style="border:1px solid #888888; padding:7px;>

	==== Methods TODO ====		==== Methods TODO ====
	<div class="mw-collapsible-content">		<div class="mw-collapsible-content">

Yeroc424 at 02:29, 30 April 2020

2020-04-30T02:29:35Z

@@ Line 9: / Line 9: @@
 == Types ==
 === Boolean ===
 === Int ===
 === Long ===
@@ Line 20: / Line 47: @@
 === Entity ===
 === Player ===
 === TpData ===

Yeroc424: /* Built-Ins (page is not ready yet) */

2020-04-30T01:47:55Z

Built-Ins (page is not ready yet)

← Older revision		Revision as of 01:47, 30 April 2020
Line 2:		Line 2:

	= Built-Ins (page is not ready yet) =		= Built-Ins (page is not ready yet) =
	'''Status: STABLE (safe to use)'''		'''Status: STABLE (safe to use - but not the documentation!)'''

	== Variables ==		== Variables ==

Yeroc424 at 01:47, 30 April 2020

2020-04-30T01:47:34Z

← Older revision		Revision as of 01:47, 30 April 2020
Line 1:		Line 1:
	[[Namespace Documentation\|Return to namespace list]]		[[Namespace Documentation\|Return to namespace list]]

	= Built-Ins =		= Built-Ins (page is not ready yet) =
	'''Status: STABLE (safe to use)'''		'''Status: STABLE (safe to use)'''

			== Variables ==

			* constant Double pi

	== Types ==		== Types ==

			=== Boolean ===
			=== Int ===
			=== Long ===
			=== Float ===
			=== Double ===
			=== String ===
			=== Block ===
			=== Item ===
			=== Entity ===
			=== Player ===

	=== TpData ===		=== TpData ===

Yeroc424: Created page with "Return to namespace list = Built-Ins = '''Status: STABLE (safe to use)''' == Types == === TpData === A data structure to manage teleport destina..."

2020-04-30T01:33:21Z

Created page with "Return to namespace list = Built-Ins = '''Status: STABLE (safe to use)''' == Types == === TpData === A data structure to manage teleport destina..."

New page

[[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>