VP EVENT TELEPORT: Difference between revisions

From Virtual Paradise Wiki
Jump to navigation Jump to search
Roy Curtis (talk | contribs)
m -subpaging
Roy Curtis (talk | contribs)
m template rename
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 {{sdk function|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=
   {{sdk attribute row|int  |avatar_session|Source session ID of the teleport request}}
   {{sdk attribute row|int  |avatar_session|Source session ID of the teleport request}}

Revision as of 01:07, 25 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
VP_AVATAR_SESSION Source session ID of the teleport request
VP_TELEPORT_X Destination X coordinate
VP_TELEPORT_Y Destination Y coordinate
VP_TELEPORT_Z Destination Z coordinate
VP_TELEPORT_PITCH Destination pitch rotation
VP_TELEPORT_YAW Destination yaw rotation
VP_TELEPORT_WORLD Destination world

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