VP EVENT TELEPORT: Difference between revisions

Revision as of 20:16, 24 August 2013

Event set and handler snippet

vp_event_set(instance, VP_EVENT_TELEPORT, event_teleport);


void event_teleport(VPInstance instance) { }

A request for the receiving client to teleport to a location, sent to the client from a vp_teleport call.

Attribute	Usage int VP_AVATAR_SESSION - Source session ID of the teleport request float VP_TELEPORT_X - Destination X coordinate float VP_TELEPORT_Y - Destination Y coordinate float VP_TELEPORT_Z - Destination Z coordinate float VP_TELEPORT_PITCH - Destination pitch rotation float VP_TELEPORT_YAW - Destination yaw rotation string VP_TELEPORT_WORLD - Destination world

If VP_TELEPORT_WORLD is a blank string, it should be assumed that the client teleport to the provided coordinates in its current world
This event is only broadcasted to the target session; no other sessions will see it
The teleport is not enforced by the server; the client may ignore the event

This event has no usage examples; please add at least one to this page

@@ Line 1: / Line 1: @@
-{{SDK event page|Teleport|Received by the client when a [[vp_teleport]] is fired for that client's session number.
+{{SDK event page|Teleport|A request for the receiving client to teleport to a location, sent to the client from a [[vp_teleport]] call.
 |attributes=
+* {{int}} '''[[VP_AVATAR_SESSION]]''' - Source session ID of the teleport request
+* {{float}} '''[[VP_TELEPORT_X]]''' - Destination X coordinate
+* {{float}} '''[[VP_TELEPORT_Y]]''' - Destination Y coordinate
+* {{float}} '''[[VP_TELEPORT_Z]]''' - Destination Z coordinate
+* {{float}} '''[[VP_TELEPORT_PITCH]]''' - Destination pitch rotation
+* {{float}} '''[[VP_TELEPORT_YAW]]''' - Destination yaw rotation
+* {{string}} '''[[VP_TELEPORT_WORLD]]''' - Destination world
 |behavior=
+* If VP_TELEPORT_WORLD is a blank string, it should be assumed that the client teleport to the provided coordinates in its current world
 * This event is only broadcasted to the target session; no other sessions will see it
-* The teleport is not ''enforced'' by the server; the client may ignore the event and not act upon it
+* The teleport is not enforced by the server; the client may ignore the event
 |seealso=
 }}