Plugin channels/WorldEditCUI - Revision history

imported>Pokechu22: Pokechu22 moved page User:Pokechu22/WorldEditCUI to Plugin channels/WorldEditCUI: Move to mainspace

2016-04-09T21:00:32Z

Pokechu22 moved page User:Pokechu22/WorldEditCUI to Plugin channels/WorldEditCUI: Move to mainspace

← Older revision	Revision as of 21:00, 9 April 2016
(No difference)

imported>Pokechu22: Add samples for each type of selection

2016-03-03T16:22:15Z

Add samples for each type of selection

@@ Line 40: / Line 40: @@
 An ellipsoid point with id 0 is sent for the center, and an ellipsoid point with id 1 is sent to set the radii (these are distances, not coordinates).
 ; Legacy versions
@@ Line 56: / Line 74: @@
 A cylinder packet is sent with the center and radius, and then a min/max packet is sent to set the bottom and top of the selection.
 ; Legacy versions
@@ Line 72: / Line 100: @@
 For all of the points in the selection, a Point 2D packet is sent with the point's x and z coordinates.  Then, a min/max packet is sent to set the bottom and top of the selection.
 === 3D Polyhedron ===
@@ Line 85: / Line 126: @@
 For each point in the polyhedron, a Point packet is sent with the x, y, and z coordinates.  Then, for each triangle in the selection, a Polygon packet is sent with vertices set to the index of each point that makes up the triangle.
 ; Legacy versions

imported>Pokechu22: /* Cuboid */ Add example of the creating it

2016-03-03T15:57:47Z

Cuboid: Add example of the creating it

← Older revision		Revision as of 15:57, 3 March 2016
Line 18:		Line 18:

	If the selection has a position one (left click), it is sent with as a Point with an id of 0. If the selection has a position two (right click), it is sent with as a Point with an id of 1.		If the selection has a position one (left click), it is sent with as a Point with an id of 0. If the selection has a position two (right click), it is sent with as a Point with an id of 1.

			; Current version example

			Creating a cuboid from (9, 25, 32) to (19, 26, 45):

			<pre>
			s\|cuboid
			p\|0\|9\|25\|32\|1
			p\|1\|19\|26\|45\|308
			</pre>

	=== Ellipsoid ===		=== Ellipsoid ===

imported>Pokechu22: Clean up structure of each channel

2016-03-03T15:42:59Z

Clean up structure of each channel

Show changes

imported>Pokechu22: Selection type documentation

2016-03-02T20:53:58Z

Selection type documentation

@@ Line 1: / Line 1: @@
-[http://www.enginehub.org/worldedit/ WorldEdit] uses [[plugin channel]]s to communicate with the clientside [http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/1292886-worldeditcui/ WorldEditCUI] mod to display selections.
+[http://www.enginehub.org/worldedit/ WorldEdit] uses [[plugin channel]]s to communicate with the clientside [http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/1292886-worldeditcui/ WorldEditCUI] mod to display selections.  Client-side source code: https://github.com/Mumfrey/WorldEditCUI/
 This is a (very) rough documentation of those channels that I'll improve.
 == Structure ==

imported>Pokechu22: Rough draft of WECUI documentation

2016-03-01T22:27:42Z

Rough draft of WECUI documentation

New page

[http://www.enginehub.org/worldedit/ WorldEdit] uses [[plugin channel]]s to communicate with the clientside [http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/1292886-worldeditcui/ WorldEditCUI] mod to display selections.

This is a (very) rough documentation of those channels that I'll improve.

== Structure ==

All communication is performed over the <code>WECUI</code> plugin channel, and is made up of a single UTF8 string with each value separated by <code>|</code>. The client, aside from [[Plugin Channel#REGISTER|<code>REGISTER</code>]]ing the channel, must also send an initialization packet. All other data is sent from the server (on the same channel).

== Version ==

[https://github.com/sk89q/WorldEdit/blob/935de4c93db215d5573916899a5cc8eefe159bab/worldedit-core/src/main/java/com/sk89q/worldedit/LocalSession.java#L776-L784 Parsed in LocalSession.java]

The <code>v</code> packet is sent from the client to the server to tell it that WorldEditCUI is installed. It has one parameter, the version of WorldEditCUI's protocol (an integer). This value is used to decide which types of selections can be sent - if a type of selection is not supported it will be sent as a different structure that is known to be supported.

<code>v|(version)</code>

== Shape ==

The <code>s</code> packet does something with shapes. It has one field, the shape of the selection (?).

<code>s|(shape)</code>

== Point ==

The <code>p</code> packet sets the location of one of the points in the current selection. It has 5 fields: the id, the block x, y, and z, and the total area.

<code>p|(id)|(x)|(y)|(z)|(area)</code>

== Point 2D ==

The <code>p2</code> packet sets the location of one of the points in the current selection, two-dimensionally. It has 4 fields: the id, the block x and z, and the total area.

<code>p2|(id)|(x)|(z)|(area)</code>

== Cylinder ==

The <code>cyl</code> packet sets info about a cylindrical selection (?). It has 5 fields: the x, y, and z of the center and then the radius x and z.

<code>cyl|(x)|(y)|(z)|(radX)|(radZ)</code>

== Ellipsoid Point ==

The <code>e</code> packet does... I don't know. It has 4 fields: the id, and x, y, and z coordinates.

<code>e|(id)|(x)|(y)|(z)</code>

== Min/Max ==

The <code>mm</code> packet does something else. It has two fields, the minimum and the maximum. What these are the minimum and maximum of, I know not.

<code>mm|(min)|(max)</code>

== Polygon ==

The <code>poly</code> packet sets verticies of a polygonal selection. It has an array of 3 (although it may be possible to add more) values, which seem to be indexes in the points list?

<code>poly|(vertex1)|(vertex2)|(vertex3)</code>