VP EVENT TELEPORT: Difference between revisions

From Virtual Paradise Wiki
Jump to navigation Jump to search
(commit test, minor rewrite, +attr)
(using attribute and function helpers)
Line 1: Line 1:
{{SDK event page|Teleport|A request for the receiving client to teleport to a location, sent to the client from a [[vp_teleport]] call.
{{SDK event page|Teleport|A request for the receiving client to teleport to a location, sent to the client from a {{sdk function|teleport}} call.
|attributes=
|attributes=
* {{int}} '''[[VP_AVATAR_SESSION]]''' - Source session ID of the teleport request
* {{sdk attribute|int   |avatar_session}} - Source session ID of the teleport request
* {{float}} '''[[VP_TELEPORT_X]]''' - Destination X coordinate
* {{sdk attribute|float |teleport_x}} - Destination X coordinate
* {{float}} '''[[VP_TELEPORT_Y]]''' - Destination Y coordinate
* {{sdk attribute|float |teleport_y}} - Destination Y coordinate
* {{float}} '''[[VP_TELEPORT_Z]]''' - Destination Z coordinate
* {{sdk attribute|float |teleport_z}} - Destination Z coordinate
* {{float}} '''[[VP_TELEPORT_PITCH]]''' - Destination pitch rotation
* {{sdk attribute|float |teleport_pitch}} - Destination pitch rotation
* {{float}} '''[[VP_TELEPORT_YAW]]''' - Destination yaw rotation
* {{sdk attribute|float |teleport_yaw}} - Destination yaw rotation
* {{string}} '''[[VP_TELEPORT_WORLD]]''' - Destination world
* {{sdk attribute|string|teleport_world}} - Destination world


|behavior=
|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
* If {{sdk attribute|string|teleport_world|tag=}} is a blank string, it should be assumed that the client use its current world
* This event is only broadcasted to the target session; no other sessions will see it
* 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
* The teleport is not enforced by the server; the client may ignore the event
|seealso=
|seealso=
}}
}}

Revision as of 22:09, 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.

Attributes

Attribute Usage

Behavior

  • If VP_TELEPORT_WORLD is a blank string, it should be assumed that the client use 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

Examples

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