Virtual Paradise Wiki - User contributions [en]

List of action commands

2023-03-12T11:46:28Z

Sleepy E: Added in some new commands

[[File:Scripting.png|frame|150px]]

== A-Z ==
* [[animate]]
* [[animation]]
* [[ambient]]
* [[astart]]
* [[astop]]
* [[camera]]
* [[color]]
* [[diffuse]]
* [[frame]]
* [[framerate]]
* [[group]]
* [[light]]
* [[lock]]
* [[makeconvex]]
* [[move]]
* [[name]]
* [[noise]]
* [[normalmap]]
* [[opacity]]
* [[path]]
* [[picture]]
* [[rotate]]
* [[say]]
* [[seq]]
* [[shear]]
* [[scale]]
* [[sign]]
* [[solid]]
* [[sound]]
* [[specular]]
* [[specularmap]]
* [[tag]]
* [[teleport]]
* [[teleportx]]
* [[teleportxyz]]
* [[texture]]
* [[url]]
* [[visible]]
* [[web]]
* [[Playsound]]

== Categories by functions (INCOMPLETE) ==
=== Visual modifications - Textures and texture mapping ===
* [[texture]]
* [[picture]]
* [[normalmap]]
* [[specularmap]]

=== Visual modifications - Lighting and surface lighting ===
* [[light]]
* [[ambient]]
* [[diffuse]]
* [[specular]]

=== Visual modifications - Shape/size modifications ===
* [[shear]]
* [[scale]]

=== Visual modifications - Assorted ===
* [[animate]]
* [[animation]]
* [[color]]
* [[opacity]]
* [[sign]]

=== Audio ===
* [[noise]]
* [[sound]]

=== Movement ===
* [[move]]
* [[rotate]]
* [[path]]

=== Transportation ===
* [[teleport]]
* [[teleportx]]
* [[teleportxyz]]

=== Utility ===
* [[astart]]
* [[astop]]
* [[group]]
* [[name]]
* [[tag]]
* [[web]]

=== Assorted ===
* [[camera]]
* [[frame]]
* [[framerate]]
* [[say]]
* [[solid]]
* [[url]]

[[Category: Script commands| ]]
[[Category: Building]]
[[Category: Lists]]

Vp wait

2018-08-20T21:58:09Z

Sleepy E:

{{sdk method page|wait|Pumps incoming and outgoing network traffic and fires any registered callbacks and events.
|paramex=1000
|parameters=
{{sdk parameter row|int|milliseconds|Maximum amount of time to pump (in milliseconds)}}
|returncodes=
{{sdk return code row|not_supported |vp_wait is not supported by this instance, for example a custom vp_net_config was passed to {{sdk method|create}}}}
{{sdk return code row|recursive_wait |vp_wait was called recursively on the same instance (calling it from within an event/callback handler)}}
{{sdk return code row|connection_error |Waiting for data failed or there are no connections to wait for events on}}
|behavior=
* This method will attempt to send all pending messages and receive all pending data within the given time limit
** It will wait for the full number of milliseconds if no network messages are received (or are already waiting to be processed)
** If one or more messages are received while waiting (or were received since the last call to vp_wait), then it will return after processing them and firing any registered event/callback handler functions.
** If a value of {{code|0}} milliseconds is passed, it will process any messages that have been received since the last call to vp_wait (i.e. "polling")

* All [[:Category:SDK events|SDK events]] and [[:Category:SDK callbacks|SDK callbacks]] are fired from this method call. Consequently, they are fired on the same thread as the caller
|caveats=
This method should never be called inside an event handler originating from a previous {{sdk method|wait}} call. Note: The current SDK will simply return {{code|VP_RC_RECURSIVE_WAIT}}. For example:
<syntaxhighlight lang="c">
...
vp_event_set(instance, VP_EVENT_AVATAR_ADD, event_avatar_add);
while(vp_wait(instance, 1000) == 0){}
...
void event_avatar_add(VPInstance instance)
{
char message[300];
sprintf((char*)&message, "Hello, %s!", vp_string(sdk, VP_AVATAR_NAME));
vp_say(instance, (char*)&message);
vp_wait(instance, 1000); // Undefined behavior
}
</syntaxhighlight>

The millisecond parameter should not be used for any sort of timekeeping,

<syntaxhighlight lang="c">
while (vp_wait(instance, 5000)) {
vp_say(instance, "5 seconds have passed!"); // this is not guaranteed to occur every 5 seconds (if any message is received while waiting)
}
</syntaxhighlight>
|seealso=
* {{sdk method|event_set}}
}}

Vp wait

2018-08-20T21:40:05Z

Sleepy E:

{{sdk method page|wait|Pumps incoming and outgoing network traffic and fires any registered callbacks and events.
|paramex=1000
|parameters=
{{sdk parameter row|int|milliseconds|Maximum amount of time to pump (in milliseconds)}}
|returncodes=
{{sdk return code row|not_supported |vp_wait is not supported by this instance, for example a custom vp_net_config was passed to {{sdk method|create}}}}
{{sdk return code row|recursive_wait |vp_wait was called recursively on the same instance (calling it from within an event/callback handler)}}
{{sdk return code row|connection_error |Waiting for data failed or there are no connections to wait for events on}}
|behavior=
* This will attempt to send all pending messages and receive all pending data within the given time limit

* It will wait for the full number of milliseconds if no network messages are received for the whole duration.
* If one or more messages are received while waiting, then it will return after processing them (and firing any registered event/callback handler functions).

* If a value of {{code|0}} is passed, it could still fire a number of different events

* All [[:Category:SDK events|SDK events]] and [[:Category:SDK callbacks|SDK callbacks]] are fired from this method call. Consequently, they are fired on the same thread as the caller
* If there is nothing to handle, it will wait until the time limit (or until one or more events or callbacks callback is fired). Else, it will return immediately after handling all pending data.
|caveats=
This method should never be called inside an event handler originating from a previous {{sdk method|wait}} call. The current SDK will return {{code|VP_RC_RECURSIVE_WAIT}}. For example:
<syntaxhighlight lang="c">
...
vp_event_set(instance, VP_EVENT_AVATAR_ADD, event_avatar_add);
while(vp_wait(instance, 1000) == 0){}
...
void event_avatar_add(VPInstance sdk)
{
char message[300];
sprintf((char*)&message, "Hello, %s!", vp_string(sdk, VP_AVATAR_NAME));
vp_say(sdk, (char*)&message);
vp_wait(instance, 1000); // Undefined behavior
}
</syntaxhighlight>
|seealso=
* {{sdk method|event_set}}
}}

List of SDK attributes

2018-08-20T20:59:48Z

Sleepy E: Added "APPLICATION" attributes

A list of [[attribute]]s available in the C [[SDK]]. For the category, see [[:Category:SDK attributes]].

* {{sdk attribute|int|AVATAR_SESSION}}
* {{sdk attribute|int|AVATAR_TYPE}}
* {{sdk attribute|int|MY_TYPE}}
* {{sdk attribute|int|OBJECT_ID}}
* {{sdk attribute|int|OBJECT_TYPE}}
* {{sdk attribute|int|OBJECT_TIME}}
* {{sdk attribute|int|OBJECT_USER_ID}}
* {{sdk attribute|int|WORLD_STATE}}
* {{sdk attribute|int|WORLD_USERS}}
* {{sdk attribute|int|REFERENCE_NUMBER}}
* {{sdk attribute|int|CALLBACK}}
* {{sdk attribute|int|USER_ID}}
* {{sdk attribute|int|USER_REGISTRATION_TIME}}
* {{sdk attribute|int|USER_ONLINE_TIME}}
* {{sdk attribute|int|USER_LAST_LOGIN}}
* {{sdk attribute|int|FRIEND_ID}}
* {{sdk attribute|int|FRIEND_USER_ID}}
* {{sdk attribute|int|FRIEND_ONLINE}}
* {{sdk attribute|int|MY_USER_ID}}
* {{sdk attribute|int|PROXY_TYPE}}
* {{sdk attribute|int|PROXY_PORT}}
* {{sdk attribute|int|CELL_X}}
* {{sdk attribute|int|CELL_Z}}
* {{sdk attribute|int|TERRAIN_TILE_X}}
* {{sdk attribute|int|TERRAIN_TILE_Z}}
* {{sdk attribute|int|TERRAIN_NODE_X}}
* {{sdk attribute|int|TERRAIN_NODE_Z}}
* {{sdk attribute|int|TERRAIN_NODE_REVISION}}
* {{sdk attribute|int|CLICKED_SESSION}}
* {{sdk attribute|int|CHAT_TYPE}}
* {{sdk attribute|int|CHAT_COLOR_RED}}
* {{sdk attribute|int|CHAT_COLOR_GREEN}}
* {{sdk attribute|int|CHAT_COLOR_BLUE}}
* {{sdk attribute|int|CHAT_EFFECTS}}
* {{sdk attribute|int|DISCONNECT_ERROR_CODE}}
* {{sdk attribute|int|URL_TARGET}}
* {{sdk attribute|int|CURRENT_EVENT}}
* {{sdk attribute|int|CURRENT_CALLBACK}}
* {{sdk attribute|int|CELL_REVISION}}
* {{sdk attribute|int|CELL_STATUS}}
* {{sdk attribute|int|JOIN_ID}}
* {{sdk attribute|int|INVITE_ID}}
* {{sdk attribute|int|INVITE_USER_ID}}
* {{sdk attribute|float|AVATAR_X}}
* {{sdk attribute|float|AVATAR_Y}}
* {{sdk attribute|float|AVATAR_Z}}
* {{sdk attribute|float|AVATAR_YAW}}
* {{sdk attribute|float|AVATAR_PITCH}}
* {{sdk attribute|float|MY_X}}
* {{sdk attribute|float|MY_Y}}
* {{sdk attribute|float|MY_Z}}
* {{sdk attribute|float|MY_YAW}}
* {{sdk attribute|float|MY_PITCH}}
* {{sdk attribute|float|OBJECT_X}}
* {{sdk attribute|float|OBJECT_Y}}
* {{sdk attribute|float|OBJECT_Z}}
* {{sdk attribute|float|OBJECT_ROTATION_X}}
* {{sdk attribute|float|OBJECT_ROTATION_Y}}
* {{sdk attribute|float|OBJECT_ROTATION_Z}}
* {{sdk attribute|float|OBJECT_YAW}}
* {{sdk attribute|float|OBJECT_PITCH}}
* {{sdk attribute|float|OBJECT_ROLL}}
* {{sdk attribute|float|OBJECT_ROTATION_ANGLE}}
* {{sdk attribute|float|TELEPORT_X}}
* {{sdk attribute|float|TELEPORT_Y}}
* {{sdk attribute|float|TELEPORT_Z}}
* {{sdk attribute|float|TELEPORT_YAW}}
* {{sdk attribute|float|TELEPORT_PITCH}}
* {{sdk attribute|float|CLICK_HIT_X}}
* {{sdk attribute|float|CLICK_HIT_Y}}
* {{sdk attribute|float|CLICK_HIT_Z}}
* {{sdk attribute|float|JOIN_X}}
* {{sdk attribute|float|JOIN_Y}}
* {{sdk attribute|float|JOIN_Z}}
* {{sdk attribute|float|JOIN_YAW}}
* {{sdk attribute|float|JOIN_PITCH}}
* {{sdk attribute|float|INVITE_X}}
* {{sdk attribute|float|INVITE_Y}}
* {{sdk attribute|float|INVITE_Z}}
* {{sdk attribute|float|INVITE_YAW}}
* {{sdk attribute|float|INVITE_PITCH}}
* {{sdk attribute|string|AVATAR_NAME}}
* {{sdk attribute|string|CHAT_MESSAGE}}
* {{sdk attribute|string|OBJECT_MODEL}}
* {{sdk attribute|string|OBJECT_ACTION}}
* {{sdk attribute|string|OBJECT_DESCRIPTION}}
* {{sdk attribute|string|WORLD_NAME}}
* {{sdk attribute|string|USER_NAME}}
* {{sdk attribute|string|USER_EMAIL}}
* {{sdk attribute|string|WORLD_SETTING_KEY}}
* {{sdk attribute|string|WORLD_SETTING_VALUE}}
* {{sdk attribute|string|FRIEND_NAME}}
* {{sdk attribute|string|PROXY_HOST}}
* {{sdk attribute|string|TELEPORT_WORLD}}
* {{sdk attribute|string|URL}}
* {{sdk attribute|string|JOIN_WORLD}}
* {{sdk attribute|string|JOIN_NAME}}
* {{sdk attribute|string|START_WORLD}}
* {{sdk attribute|string|INVITE_NAME}}
* {{sdk attribute|string|INVITE_WORLD}}
* {{sdk attribute|string|APPLICATION_NAME}}
* {{sdk attribute|string|APPLICATION_VERSION}}
* {{sdk attribute|data|OBJECT_DATA}}
* {{sdk attribute|data|TERRAIN_NODE_DATA}}

[[Category: SDK]]
[[Category: Lists]]
[[Category: SDK attributes|*]]

Template:Build

2018-08-04T15:01:09Z

Sleepy E: Typo

<table class="toccolours" style=" clear: both; width: 100%; margin: 1em auto; text-align: left; padding: 0em 0em 0em 0em">
<tr>
<td colspan=2 style="padding: 0.2em 0.2em 0.5em; background: #A8C0FF; color:black">
<center>'''[[Object Scripting]]'''</center>
</td>
</tr>
<tr>
<td align="left" style="font-size: 95%; width:5%; padding-left:0.6em;">
<p style="margin: 0px;"><b>Triggers:</b></p>
</td>
<td>
<p style="margin: 0px;">[[Activate]] • [[Adone]] • [[Bump]] • [[Bumpend]] • [[Create]]</p>
</td>
</tr>
<tr>
<td align="left" style="font-size: 95%; width:5%; padding-left:0.6em;" valign=top>
<p style="margin: 0px;"><b>Commands:</b></p>
</td>
<td>
<p style="margin: 0px;">[[Animate]] • [[Animation]] • [[Ambient]] • [[Camera]] • [[Color]] • [[Diffuse]] • [[Frame]] • [[Framerate]] • [[Group]] • [[Light]] • [[Move]] • [[Name]] • [[Noise]] • [[Normalmap]] • [[Opacity]] • [[Path]] • [[Picture]] • [[Rotate]] • [[Say]] • [[Shear]] • [[Scale]] • [[Sign]] • [[Solid]] • [[Sound]] • [[Specular]] • [[Specularmap]] • [[Teleport]] • [[Teleportx]] • [[Teleportxyz]] • [[Texture]] • [[Url]] • [[Visible]] • [[Web]]</p>
</td>
</tr>
<noinclude>[[Category: Templates]]</noinclude>

Template:Sdk parameter table

2018-08-01T22:08:54Z

Sleepy E: Align headers to the left

{|
! style="min-width: 200px" align="left" | Parameter
! align="left" | Usage
{{{1|}}}
|}

Template:Sdk attribute table

2018-08-01T22:08:02Z

Sleepy E: Align headers to the left

{|
! style="min-width: 250px" align="left" | Attribute
! align="left" | Usage
{{{1|}}}
|}

Template:Sdk return attribute table

2018-08-01T22:07:21Z

Sleepy E: Align headers to the left

{|
! style="min-width: 250px" align="left" | Attribute
! align="left" | Usage
! Also returned for
{{{1|}}}
|}

Template:Sdk return code table

2018-08-01T22:06:38Z

Sleepy E: Align headers to the left

{|
! style="min-width: 200px" align="left" | Return code
! align="left" | Cause
{{sdk return code row}}
{{{1|}}}
|}

Template:Sdk return code row

2018-08-01T22:03:18Z

Sleepy E:

|-
| {{code|VP_RC_{{uc:{{{1|SUCCESS}}}}}}} || {{{2|Successful call (for methods that have a registered callback, it only means the request has been sent)}}}

Template:Sdk return code row

2018-08-01T22:02:06Z

Sleepy E:

|-
| {{code|VP_RC_{{uc:{{{1|SUCCESS}}}}}}} || {{{2|Successful call (for methods that have a registered callback, it only means the request has been sent}}}

Template:Sdk method page

2018-08-01T22:00:28Z

Sleepy E:

<div style="float: right; width: 400px; {{box-sizing}} {{bg linearfade|color={{{color|204,100%,90%}}}}}; padding: 32px 16px 16px 16px; border-radius: 0px 0px 16px 16px;">'''Method call snippet'''
<code style="display: block; padding: 8px; margin: 8px 0px; border: 1px dashed hsl(204,100%,70%);">vp_{{lc:{{{1|unknown}}}}}({{{customparamex|instance{{#if:{{{paramex|}}}|, {{{paramex}}}|}}}}});</code></div>
{{{2}}}__NOTOC__
== Parameters ==__NOEDITSECTION__
These are the parameters that this method requires:
{{sdk parameter table|{{#if:{{{noinstanceparam}}}|{{sdk parameter row|VPInstance|instance|Pointer to the instance this method call is intended for}}|}}
{{{parameters|}}}}}
{{#if: {{{attributes|}}} |== Used attributes ==__NOEDITSECTION__
This method uses data set in these attributes when called:
{{sdk attribute table|{{{attributes}}}}} |}}
== Returns ==__NOEDITSECTION__
{{{returns|This method returns a [[return code]] integer, which indicates whether the call was successful or errored for any reason:
{{sdk return code table|{{{returncodes|}}}}}
{{#if: {{{returnattributes|}}} |The following attributes will be returned in {{Sdk callback|{{{1}}}}} if the operation was successful:
{{sdk return attribute table|{{{returnattributes}}}}} |}} }}}
== Behavior ==__NOEDITSECTION__
{{#if: {{{behavior|}}} | {{{behavior}}} |:''There is no special behavior for this method''}}
{{#if: {{{caveats|}}} |== Caveats ==__NOEDITSECTION__
{{{caveats}}} |}}
== Examples ==__NOEDITSECTION__
{{#if: {{{examples|}}} | {{{examples}}} |:''This method has no usage examples; please add at least one to [{{canonicalurl:{{FULLPAGENAMEE}}|action=edit}} this page]''}}
{{#if: {{{seealso|}}} |== See also ==__NOEDITSECTION__
{{{seealso}}}
|}}{{{extra|}}}
<includeonly>{{DEFAULTSORT:{{{1}}}}} {{DISPLAYTITLE:vp_{{lc:{{{1}}}}}}} {{{category|[[Category:SDK methods]]}}}</includeonly><noinclude>

== Usage ==
<pre>{{sdk event page|Event name|Event description
|returntype=
|paramex=
|parameters=
{{sdk parameter row|type|name|description}}
|attributes=
{{sdk attribute row|type|name|description}}
|returncodes=
{{sdk return code row|name|cause}}
|returnattributes=
{{sdk attribute row|type|name|description}}
|behavior=
|caveats=
|examples=
|seealso=
}}</pre>

[[Category:Subpage templates]]
</noinclude>

Vp login

2018-08-01T21:55:00Z

Sleepy E:

{{sdk method page|login| Login to the universe server; using the credentials of an existing user account.
|paramex=username, password, botname
|parameters=
{{sdk parameter row|string|username|Use credentials of the account with this name}}
{{sdk parameter row|string|password|Password associated with the account}}
{{sdk parameter row|string|botname |Name that the bot will appear with in a world. There are no restrictions on what characters can be used.}}
|returncodes=
{{sdk return code row|STRING_TOO_LONG |If any of the given string parameters exceed 255 bytes in length (when using UTF-8 encoded characters they can each be multiple bytes long)}}
{{sdk return code row|INVALID_LOGIN |The login credentials are incorrect}}
{{sdk return code row|TIMEOUT |Timeout}}
{{sdk return code row|NOT_IN_UNIVERSE |Universe request made while not connected to a universe server}}
|returnattributes=
{{sdk attribute row|int|my_user_id|User id of account used to log in}}
|behavior=
*If a {{sdk callback|login}} callback is set this function will return immediately and return the result using the callback, otherwise it will call {{sdk method|wait}} in a loop until done.
* When successfully logged in, bots will have square brackets around their name. For example, providing "Samantha" as the {{code|botname}} parameter will identify the bot as "[Samantha]".
* The user ID of the account used to log in will be exposed to other users.
* Bot names that contain [https://wikipedia.org/wiki/UTF-8 UTF-8] encoded characters (e.g. "\xE2\x98\xAF" is the "Yin and Yang" symbol ☯) will display correctly in a browser.
|caveats=
* To log out from a universe, {{sdk method|destroy}} must be called which will also disconnect the bot from the world.
* If calling this while already logged in and entered into a world, then it will not update the identity of the bot inside the world (nor will it disconnect). Need to call {{sdk method|enter}} for the identity in world to update.
|examples=
<syntaxhighlight lang="c">
int rc;

rc = vp_login(sdk, "myname", "mypassword", "botname");
if (rc)
printf("Couldn't login (reason %d)\n", rc);
</syntaxhighlight>
|seealso=
* {{sdk callback|login}}
* {{sdk method|destroy}}
* {{sdk method|enter}}
}}

Vp login

2018-08-01T21:54:20Z

Sleepy E:

{{sdk method page|login| Login to the universe server; using the credentials of an existing user account.
|paramex=username, password, botname
|parameters=
{{sdk parameter row|string|username|Use credentials of the account with this username}}
{{sdk parameter row|string|password|Password associated with the account}}
{{sdk parameter row|string|botname |Name that the bot will appear with in a world. There are no restrictions on what characters can be used.}}
|returncodes=
{{sdk return code row|STRING_TOO_LONG |If any of the given string parameters exceed 255 bytes in length (when using UTF-8 encoded characters they can each be multiple bytes long)}}
{{sdk return code row|INVALID_LOGIN |The login credentials are incorrect}}
{{sdk return code row|TIMEOUT |Timeout}}
{{sdk return code row|NOT_IN_UNIVERSE |Universe request made while not connected to a universe server}}
|returnattributes=
{{sdk attribute row|int|my_user_id|User id of account used to log in}}
|behavior=
*If a {{sdk callback|login}} callback is set this function will return immediately and return the result using the callback, otherwise it will call {{sdk method|wait}} in a loop until done.
* When successfully logged in, bots will have square brackets around their name. For example, providing "Samantha" as the {{code|botname}} parameter will identify the bot as "[Samantha]".
* The user ID of the account used to log in will be exposed to other users.
* Bot names that contain [https://wikipedia.org/wiki/UTF-8 UTF-8] encoded characters (e.g. "\xE2\x98\xAF" is the "Yin and Yang" symbol ☯) will display correctly in a browser.
|caveats=
* To log out from a universe, {{sdk method|destroy}} must be called which will also disconnect the bot from the world.
* If calling this while already logged in and entered into a world, then it will not update the identity of the bot inside the world (nor will it disconnect). Need to call {{sdk method|enter}} for the identity in world to update.
|examples=
<syntaxhighlight lang="c">
int rc;

rc = vp_login(sdk, "myname", "mypassword", "botname");
if (rc)
printf("Couldn't login (reason %d)\n", rc);
</syntaxhighlight>
|seealso=
* {{sdk callback|login}}
* {{sdk method|destroy}}
* {{sdk method|enter}}
}}

Vp connect universe

2018-08-01T20:16:00Z

Sleepy E:

{{Sdk method page|connect_universe|Connects an instance to a [[universe]] server. Required before an instance log in with user credentials and entering a world.
|paramex="universe.virtualparadise.org", 57000
|parameters=
{{sdk parameter row|string|host|Host address of server to connect to; currently {{code|"universe.virtualparadise.org"}}. IP addresses in dotted quad are also valid (e.g. the string "10.0.0.1").}}
{{sdk parameter row|int |port|TCP port of remote server; currently {{code|57000}}}}
|returncodes=
{{sdk return code row|CONNECTION_ERROR|Error connecting to the universe server}}
{{sdk return code row|TIMEOUT |It took too long to connect or get a response from the server}}
|behavior=
* If a {{sdk callback|connect_universe}} callback is set this function will return immediately and return the result using the callback, otherwise it will call {{sdk method|wait}} in a loop until done.
|caveats=
* To disconnect from a universe, {{sdk method|destroy}} must be called.
* Passing a NULL pointer for the host parameter will cause a memory access violation. It will not cause a default host address to be used. Passing port number 0 will also not cause a default port to be used.
* {{code|VP_RC_CONNECTION_ERROR}} could be returned for many issues, such as invalid host, unable to resolve IP address, wrong or invalid port, etc.
|examples=
<syntaxhighlight lang="c">
int rc;

rc = vp_connect_universe(instance, "universe.virtualparadise.org", 57000);
if (rc)
printf("Couldn't connect to universe (reason %d)", rc);
</syntaxhighlight>
|seealso=
* {{sdk callback|CONNECT_UNIVERSE}}
* {{sdk method|destroy}}
* {{sdk method|login}}
}}

Vp destroy

2018-08-01T19:32:38Z

Sleepy E: Added caveats

{{sdk method page|destroy|Destroys an existing SDK instance.
|behavior=If the destroyed instance was connected to a [[world]] and/or a [[universe]], it will be disconnected from both. This is the only way to disconnect a bot from a universe.
|caveats=
This method will '''always''' return {{code|VP_RC_SUCCESS}} even when passed a NULL pointer. However, passing an invalid instance pointer will crash the bot due to a memory access violation.
|seealso=
* {{sdk method|create}}
}}

Vp create

2018-08-01T19:18:38Z

Sleepy E:

{{sdk method page|create|Creates a new SDK instance in memory for connecting to a universe and world.
|parameters=
{{sdk parameter row|vp_net_config*|net_config|Network configuration for the instance or NULL to use the default select-based implementation. The contents of the structure will be copied.}}
|customparamex=net_config
|noinstanceparam=
|returns=A pointer to the newly created instance, or {{code|NULL}} if something went wrong whilst trying to create one.
|examples=
<syntaxhighlight lang="c">
VPInstance instance;

instance = vp_create(NULL);
if (!instance)
printf("Unable to create instance\n");
</syntaxhighlight>
|seealso=
* {{sdk method|connect_universe}}
* {{sdk method|destroy}}
* {{sdk method|login}}
}}

Vp init

2018-08-01T19:14:05Z

Sleepy E:

{{sdk method page|init|Check if the version of the VPSDK used to build the application matches the version that is currently loaded.
|customparam={{sdk parameter|int|version}}
|customparamex=VPSDK_VERSION
|noinstanceparam=
|parameters=
{{sdk parameter row|int|version|{{code|VPSDK_VERSION}} in VP.h defines the version of the SDK library}}
|behavior=
There is no longer a requirement to call this function. It is used to check if the version used to build the application is compatible with the version used at runtime.
|returncodes=
{{sdk return code row|version_mismatch|VP.h and the SDK library are from different builds}}
|examples=
<syntaxhighlight lang="c">
int rc;

if (rc = vp_init(VPSDK_VERSION))
printf("Incorrect VPSDK.dll version\n");
</syntaxhighlight>
|seealso=
* {{sdk method|create}}
}}

Vp join

2018-07-31T23:31:06Z

Sleepy E: Added reference number attribute

{{sdk method page|join|Send a join request to a user.
|paramex=user_id
|parameters=
{{sdk parameter row|int|user_id|User id}}
|attributes=
{{sdk attribute row|int|reference_number|Is passed to the callback to identify for which method call it is fired}}
|returncodes=
{{sdk return code row|NOT_IN_UNIVERSE|Bot is not currently in the universe}}
{{sdk return code row|JOIN_DECLINED|Join request was declined}}
{{sdk return code row|TIMEOUT|Join request timeout (no accept/decline within 30 seconds)}}
|returnattributes=
{{sdk attribute row|int |JOIN_ID |Join id |{{code|VP_RC_JOIN_DECLINED}}}}
{{sdk attribute row|int |USER_ID |User id |{{code|VP_RC_JOIN_DECLINED}}}}
{{sdk attribute row|string |JOIN_NAME |Name of user |{{code|VP_RC_JOIN_DECLINED}} and {{code|VP_RC_TIMEOUT}}}}
{{sdk attribute row|float |JOIN_X |User x coordinate |}}
{{sdk attribute row|float |JOIN_Y |User y coordinate |}}
{{sdk attribute row|float |JOIN_Z |User z coordinate |}}
{{sdk attribute row|float |JOIN_YAW |User yaw angle |}}
{{sdk attribute row|float |JOIN_PITCH |User pitch angle |}}
{{sdk attribute row|string |JOIN_WORLD |World that user is in |}}
|behavior=
* Upon sending a request, {{sdk event|JOIN}} is triggered for the user. See {{sdk method|event_set}}.
|caveats=
|examples=
<syntaxhighlight lang="c">
...
</syntaxhighlight>
|seealso=
* {{sdk event|JOIN}}
* {{sdk callback|JOIN}}
* {{sdk method|join_accept}}
* {{sdk method|join_decline}}
}}

Vp terrain node set

2018-07-31T23:29:11Z

Sleepy E: Added reference number attribute

{{sdk method page|terrain_node_set|Replace terrain node data.
|paramex=tile_x, tile_z, node_x, node_z, cells
|parameters=
{{sdk parameter row|int |tile_x |Tile X coordinate (with no terrain scaling, divide coordinates in decameter by 32 to get tile coordinates)}}
{{sdk parameter row|int |tile_z |Tile Z coordinate}}
{{sdk parameter row|int |node_x |Node X coordinate (within tile, 0 to 3)}}
{{sdk parameter row|int |node_z |Node Z coordinate}}
{{sdk parameter row|vp_terrain_cell_t* |cells |Pointer to 64 cells (8x8: cells[z*8+x])}}
|attributes=
{{sdk attribute row|int |reference_number |Is passed to the callback to identify for which method call it is fired}}
|returncodes=
{{sdk return code row|NOT_IN_WORLD |Bot is not currently in a world}}
|behavior=
* Upon successfully replacing a node, {{sdk event|TERRAIN_NODE_CHANGED}} is triggered for any user subscribed to it. See {{sdk method|event_set}}.
|caveats=
|examples=
<syntaxhighlight lang="c">
/*
* Set the height of the terrain node containing the terrain cell coordinate x, z (Note: it will reset the texture, rotation and hole flag!)
*/

int tile_from_cell(int val)
{
return val < 0 ? (val - 32) / 32 : val / 32;
}

void set_terrain_node_height(VPInstance sdk, int x, int z, float height)
{
int tile_x, tile_z;

tile_x = tile_from_cell(x);
tile_z = tile_from_cell(z);

int node_x, node_z;

if (node_x < 0)
node_x -= 8;

node_x = (x % 32) / 8;

if (node_z < 0)
node_z -= 8;

node_z = (z % 32) / 8;

struct vp_terrain_cell_t cells[64];

memset(cells, 0, sizeof(cells));

for (int i = 0; i < 64; i++)
cells[i].height = height;

vp_terrain_node_set(sdk, tile_x, tile_z, node_x, node_z, cells);
}
</syntaxhighlight>
|seealso=
* {{sdk event|TERRAIN_NODE_CHANGED}}
* {{sdk callback|TERRAIN_NODE_SET}}
* {{sdk method|terrain_query}}
}}

Vp terrain query

2018-07-31T23:28:30Z

Sleepy E: Added reference number attribute

{{sdk method page|terrain_query|Query a terrain tile.
|paramex=x, z
|parameters=
{{sdk parameter row|int |tile_x |X tile coordinate (with no terrain scaling, divide coordinates in decameter by 32 to get tile coordinates)}}
{{sdk parameter row|int |tile_z |Z tile coordinate}}
{{sdk parameter row|int[4][4] |revision |16 node revision numbers (4x4: revision[z][x])}}
|attributes=
{{sdk attribute row|int |reference_number |Is passed to the callback to identify for which method call it is fired}}
|returncodes=
{{sdk return code row|NOT_IN_WORLD |Bot is not currently in a world}}
|behavior=
* Upon successfully querying a tile, {{sdk event|TERRAIN_NODE}} is triggered for each of the terrain nodes in it. See {{sdk method|event_set}}.
|caveats=
|examples=
<syntaxhighlight lang="c">
/*
* This example will monitor avatars within the area from 0X 0Z to 32X 32Z and teleport them above ground when they go more than 2 meters below the terrain height.
* Note: The code assumes that the terrain has not been scaled or offset!
*/

float g_heights[32][32]; // All the heights inside the queried terrain tile (in this example it is a square from coordinate 0,0 to 32,32)

void handle_terrain_node(VPInstance sdk)
{
int offset_x, offset_z; // Offset cell x and z for storing current node in g_heights

offset_x = vp_int(sdk, VP_TERRAIN_NODE_X) * 8;
offset_z = vp_int(sdk, VP_TERRAIN_NODE_Z) * 8;

int length; // Not used in this example

vp_terrain_cell_t (*cell)[8][8] = (vp_terrain_cell_t(*)[8][8])vp_data(sdk, VP_TERRAIN_NODE_DATA, &length);

for (int i = 0; i < 8; i++)
for (int j = 0; j < 8; j++)
g_heights[i + offset_z][j + offset_x] = (*cell)[i][j].height;
}

float get_height(double x, double z)
{
int x_cell, z_cell; // Terrain cell coordinate is simply the truncated coordinate in decameters

x_cell = (int)x;
z_cell = (int)z;

if (x_cell < 0 || x_cell > 30) // Check if x coordinate is within the queried tile
return INFINITY;

if (z_cell < 0 || z_cell > 30) // Check if z coordinate is within the queried tile
return INFINITY;

double x_rel, z_rel; // Coordinate within the cell (for calculating the height)

x_rel = x - trunc(x);
z_rel = z - trunc(z);

double base, x_diff, z_diff; // Base height, maximum difference toward x and z.

// Four cases, depending on what cell it is and which half of the cell

if ((x_cell + z_cell) % 2)
{
// Odd cell, diagonal goes from 0,0 to 1,1

if ((1.0 - x_rel) + z_rel > 1)
{
// Upper half of the cell
base = g_heights[z_cell + 1][x_cell];
x_diff = g_heights[z_cell + 1][x_cell + 1] - base;
z_diff = g_heights[z_cell][x_cell] - base;

z_rel = 1.0 - z_rel;
}
else
{
// Lower half of the cell
base = g_heights[z_cell][x_cell + 1];
x_diff = g_heights[z_cell][x_cell] - base;
z_diff = g_heights[z_cell + 1][x_cell + 1] - base;

x_rel = 1.0 - x_rel;
}
}
else
{
// Even cell, diagonal goes from 1,0 to 0,1

if (x_rel + z_rel > 1)
{
// Upper half of the cell
base = g_heights[z_cell + 1][x_cell + 1];
x_diff = g_heights[z_cell + 1][x_cell] - base;
z_diff = g_heights[z_cell][x_cell + 1] - base;

x_rel = 1.0 - x_rel;
z_rel = 1.0 - z_rel;
}
else
{
// Lower half of the cell
base = g_heights[z_cell][x_cell];
x_diff = g_heights[z_cell][x_cell + 1] - base;
z_diff = g_heights[z_cell + 1][x_cell] - base;
}
}

return (float)(base + x_diff * x_rel + z_diff * z_rel);
}

void handle_avatar_change(VPInstance sdk)
{
double x, y, z;

x = vp_double(sdk, VP_AVATAR_X);
y = vp_double(sdk, VP_AVATAR_Y);
z = vp_double(sdk, VP_AVATAR_Z);

float y_calc;

y_calc = get_height(x, z);

if (y_calc != INFINITY) // Inside queried area
{
if (y < y_calc - 0.2) //Below the terrain (assuming avatar is shorter than 2 meters)
{
printf("WARNING: \"%s\" was moving around below the terrain!\n", vp_string(sdk, VP_AVATAR_NAME));
vp_teleport_avatar(sdk,
vp_int(sdk, VP_AVATAR_SESSION),
"",
x,
y_calc,
z,
vp_double(sdk, VP_AVATAR_YAW),
vp_double(sdk, VP_AVATAR_PITCH)); // Teleport avatar up above ground
}
}
}

int main(int argc, const char* argv[])
{
//...

vp_event_set(sdk, VP_EVENT_AVATAR_CHANGE, handle_avatar_change);
vp_event_set(sdk, VP_EVENT_TERRAIN_NODE, handle_terrain_node);

int rev[4][4];

memset(rev, 0, sizeof(rev));
vp_terrain_query(sdk, 0, 0, rev);

//...
}
</syntaxhighlight>
|seealso=
* {{sdk method|terrain_node_set}}
* {{sdk callback|TERRAIN_QUERY}}
* {{sdk event|TERRAIN_NODE}}
}}

Vp friend delete

2018-07-31T23:24:57Z

Sleepy E: Added reference number attribute

{{sdk method page|friend_delete|Delete a user from the friend list.
|paramex=friend_user_id
|parameters=
{{sdk parameter row|int|friend_user_id|User id of user to delete}}
|attributes=
{{sdk attribute row|int |reference_number |Is passed to the callback to identify for which method call it is fired}}
|returncodes=
{{sdk return code row|not_in_universe|Universe request made while not connected to a universe server}}
|returnattributes=
|behavior=
|caveats=
|examples=
|seealso=
* {{sdk method|friends_get}}
* {{sdk method|friend_add_by_name}}
}}

Vp friend add by name

2018-07-31T23:24:21Z

Sleepy E: Added reference number attribute, reason code

{{sdk method page|friend_add_by_name|Add a user to the friend list.
|paramex=name
|parameters=
{{sdk parameter row|string|name|Name of user to add}}
|attributes=
{{sdk attribute row|int|reference_number|Is passed to the callback to identify for which method call it is fired}}
|returncodes=
{{sdk return code row|NOT_IN_UNIVERSE|Universe request made while not connected to a universe server}}
|returnattributes=
|behavior=
* Upon successfully adding a user, {{sdk event|FRIEND}} is triggered if the bot has subscribed to it.
|caveats=
|examples=
|seealso=
* {{sdk method|friends_get}}
* {{sdk method|friend_delete}}
* {{sdk callback|FRIEND}}
}}

Vp friends get

2018-07-31T23:21:51Z

Sleepy E: Added reference number attribute, return code

{{sdk method page|friends_get|Request the friend list.
|paramex=
|parameters=
|attributes=
{{sdk attribute row|int|reference_number |Is passed to the callback to identify for which method call it is fired}}
|returncodes=
{{sdk return code row|NOT_IN_UNIVERSE|Universe request made while not connected to a universe server}}
|behavior=
|caveats=
|examples=
<syntaxhighlight lang="c">
void handle_friend(VPInstance sdk)
{
const char *name;
int user_id, online;

name = vp_string(sdk, VP_FRIEND_NAME);
user_id = vp_int(sdk, VP_FRIEND_USER_ID);
online = vp_int(sdk, VP_FRIEND_ONLINE);

printf("Friend \"%s\" (id #%d) is %s\n", name, user_id, online ? "online" : "offline");
}

void handle_get_friends(VPInstance sdk, int rc, int ref)
{
printf("Got the entire friend list!\n");
}

int main(int argc, const char* argv[])
{
//...

vp_callback_set(sdk, VP_CALLBACK_GET_FRIENDS, handle_get_friends);
vp_event_set(sdk, VP_EVENT_FRIEND, handle_friend);
vp_friends_get(sdk);

//...
}
</syntaxhighlight>
|seealso=
* {{sdk method|friend_add_by_name}}
* {{sdk method|friend_delete}}
* {{sdk callback|GET_FRIENDS}}
* {{sdk event|FRIEND}}
}}

Vp object delete

2018-07-31T23:17:50Z

Sleepy E: Added reference number attribute

{{sdk method page|object_delete|Delete an object.
|paramex=object_id
|parameters=
{{sdk parameter row|int|object_id |Id of object to delete}}
|attributes=
{{sdk attribute row|int|reference_number |Is passed to the callback to identify for which method call it is fired}}
|returncodes=
{{sdk return code row|NOT_IN_WORLD |Bot is not currently in a world}}
|returnattributes=
{{sdk attribute row|int|OBJECT_ID|Object id of deleted object}}
|behavior=
* Upon successful deletion of an object, {{sdk event|OBJECT_DELETE}} is triggered for those who have subscribed to it.
|caveats=
|examples=
|seealso=
* {{sdk method|object_add}}
* {{sdk method|object_change}}
* {{sdk callback|OBJECT_DELETE}}
}}

Vp object change

2018-07-31T23:15:55Z

Sleepy E: Added reference number attribute

{{sdk method page|object_change|Change an existing object.
|parameters=
|attributes=
{{sdk attribute row|int |reference_number |Is passed to the callback to identify for which method call it is fired}}
{{sdk attribute row|int |OBJECT_ID |Id of object to change}}
{{sdk attribute row|int |OBJECT_TYPE |Type of object}}
{{sdk attribute row|float |OBJECT_X |X coordinate}}
{{sdk attribute row|float |OBJECT_Y |Y coordinate}}
{{sdk attribute row|float |OBJECT_Z |Z coordinate}}
{{sdk attribute row|float |OBJECT_ROTATION_X |Rotation axis X}}
{{sdk attribute row|float |OBJECT_ROTATION_Y |Rotation axis Y}}
{{sdk attribute row|float |OBJECT_ROTATION_Z |Rotation axis Z}}
{{sdk attribute row|float |OBJECT_ROTATION_ANGLE |Rotation angle}}
{{sdk attribute row|string |OBJECT_MODEL |Model}}
{{sdk attribute row|string |OBJECT_ACTION |Action}}
{{sdk attribute row|string |OBJECT_DESCRIPTION |Description}}
{{sdk attribute row|data |OBJECT_DATA |Data}}
|returncodes=
{{sdk return code row|NOT_IN_WORLD |Bot is not currently in a world}}
|returnattributes=
{{sdk attribute row|int|OBJECT_ID|Object id of changed object}}
|behavior=
* Upon successful change of an object, {{sdk event|OBJECT_CHANGE}} is triggered for those who have subscribed to it.
|caveats=
|examples=
|seealso=
* {{sdk method|object_add}}
* {{sdk method|object_delete}}
* {{sdk callback|OBJECT_CHANGE}}
}}

Vp object load

2018-07-31T23:15:10Z

Sleepy E: Added reference number attribute

{{sdk method page|object_load|Load a new object, overriding user id and timestamp.
|parameters=
|attributes=
{{sdk attribute row|int |reference_number |Is passed to the callback to identify for which method call it is fired}}
{{sdk attribute row|int |object_time |Creation time to put on object (in unix time, seconds since UTC 00:00:00, 1 January 1970)}}
{{sdk attribute row|int |object_user_id |User id to put on object}}
{{sdk attribute row|int |object_type |Type of object (0 - 3D Model, 2 - Particle emitter, 3 - Path object) }}
{{sdk attribute row|float |object_x |X coordinate}}
{{sdk attribute row|float |object_y |Y coordinate}}
{{sdk attribute row|float |object_z |Z coordinate}}
{{sdk attribute row|float |object_rotation_x |Rotation X axis}}
{{sdk attribute row|float |object_rotation_y |Rotation Y axis}}
{{sdk attribute row|float |object_rotation_z |Rotation Z axis}}
{{sdk attribute row|float |object_rotation_angle |Rotation angle in radians}}
{{sdk attribute row|float |object_yaw |Yaw angle in degrees (these are used instead of X,Y,Z axis when rotation angle is set to INFINITY)}}
{{sdk attribute row|float |object_pitch |Pitch angle in degrees}}
{{sdk attribute row|float |object_roll |Roll angle in degrees}}
{{sdk attribute row|string |object_model |Model}}
{{sdk attribute row|string |object_action |Action}}
{{sdk attribute row|string |object_description |Description}}
{{sdk attribute row|data |object_data |Data}}
|returncodes=
{{sdk return code row|not_in_world|Bot is not currently in a world}}
{{sdk return code row|not_allowed|Instance does not have the permission to load objects.}}
{{sdk return code row|database_error|Unspecified database error}}
|returnattributes=
{{sdk attribute row|int|object_id|Object id that was assigned to the new object}}
|behavior=
* Upon successful creation of an object, {{sdk event|OBJECT}} is triggered for those who have subscribed to it. See {{sdk method|event_set}}.
* If {{sdk attribute|object_rotation_angle}} is set to INFINITY then it will be stored as that in world. The euler angles will be not be converted to an equivalent axis-angle representation. See examples in {{sdk method|object_add}} for euler to axis-angle conversion code.
|caveats=
* Setting {{sdk attribute|object_user_id}} to 0 will not default it to the owner of the bot (it will be set to user id #0).
* Setting {{sdk attribute|object_time}} to 0 will not default it to current time (it will be set to unix time 0, that is 00:00:00, 1 January 1970).
|examples=
Load a street1.rwx object at 0X 0Y 0Z.
<syntaxhighlight lang="c">
void handle_object_load(VPInstance sdk, int rc, int ref)
{
if (rc)
printf("Couldn't load object (reason %d)\n", rc);
else
printf("Object loaded successfully!\n");
}

int main(int argc, const char* argv[])
{
//...

vp_callback_set(sdk, VP_CALLBACK_OBJECT_LOAD, handle_object_load);

vp_int_set(sdk, VP_OBJECT_TYPE, 0); // 3D Model
vp_int_set(sdk, VP_OBJECT_USER_ID, 1234); // Owner #1234
vp_int_set(sdk, VP_OBJECT_TIME, time(NULL) - 3600); // One hour ago
vp_float_set(sdk, VP_OBJECT_X, 0.0);
vp_float_set(sdk, VP_OBJECT_Y, 0.0);
vp_float_set(sdk, VP_OBJECT_Z, 0.0);
vp_float_set(sdk, VP_OBJECT_ROTATION_X, 0.0);
vp_float_set(sdk, VP_OBJECT_ROTATION_Y, 0.0);
vp_float_set(sdk, VP_OBJECT_ROTATION_Z, 0.0);
vp_float_set(sdk, VP_OBJECT_ROTATION_ANGLE, 0.0);
vp_string_set(sdk, VP_OBJECT_MODEL, "street1.rwx");
vp_string_set(sdk, VP_OBJECT_ACTION, "");
vp_string_set(sdk, VP_OBJECT_DESCRIPTION, "");

rc = vp_object_load(sdk);
if (rc)
printf("Couldn't load object (reason %d)\n", rc);

//...
}
</syntaxhighlight>
|seealso=
* {{sdk method|object_add}}
* {{sdk method|object_change}}
* {{sdk method|object_delete}}
* {{sdk callback|object_load}}
}}

Vp object add

2018-07-31T23:14:05Z

Sleepy E: Added reference number attribute

{{sdk method page|object_add|Build a new object.
|parameters=
|attributes=
{{sdk attribute row|int |reference_number |Is passed to the callback to identify for which method call it is fired}}
{{sdk attribute row|int |object_type |Type of object (0 - 3D Model, 2 - Particle emitter, 3 - Path object) }}
{{sdk attribute row|float |object_x |X coordinate}}
{{sdk attribute row|float |object_y |Y coordinate}}
{{sdk attribute row|float |object_z |Z coordinate}}
{{sdk attribute row|float |object_rotation_x |Rotation X axis}}
{{sdk attribute row|float |object_rotation_y |Rotation Y axis}}
{{sdk attribute row|float |object_rotation_z |Rotation Z axis}}
{{sdk attribute row|float |object_rotation_angle |Rotation angle in radians}}
{{sdk attribute row|float |object_yaw |Yaw angle in degrees (these are used instead of X,Y,Z axis when rotation angle is set to INFINITY)}}
{{sdk attribute row|float |object_pitch |Pitch angle in degrees}}
{{sdk attribute row|float |object_roll |Roll angle in degrees}}
{{sdk attribute row|string |object_model |Model}}
{{sdk attribute row|string |object_action |Action}}
{{sdk attribute row|string |object_description |Description}}
{{sdk attribute row|data |object_data |Data}}
|returncodes=
{{sdk return code row|not_in_world|Bot is not currently in a world}}
|returnattributes=
{{sdk attribute row|int|object_id|Object id that was assigned to the new object}}
|behavior=
* Upon successful creation of an object, {{sdk event|OBJECT}} is triggered for those who have subscribed to it. See {{sdk method|event_set}}.
* If {{sdk attribute|object_rotation_angle}} is set to INFINITY then it will be stored as that in world. The euler angles will be not be converted to an equivalent axis-angle representation. See examples for euler to axis-angle conversion code.
|caveats=
|examples=
Build a street1.rwx object at 0X 0Y 0Z.
<syntaxhighlight lang="c">
void handle_object_add(VPInstance sdk, int rc, int ref)
{
if (rc)
printf("Couldn't build object (reason %d)\n", rc);
else
printf("Object built successfully!\n");
}

int main(int argc, const char* argv[])
{
//...

vp_callback_set(sdk, VP_CALLBACK_OBJECT_ADD, handle_object_add);

vp_int_set(sdk, VP_OBJECT_TYPE, 0); // 3D Model
vp_float_set(sdk, VP_OBJECT_X, 0.0);
vp_float_set(sdk, VP_OBJECT_Y, 0.0);
vp_float_set(sdk, VP_OBJECT_Z, 0.0);
vp_float_set(sdk, VP_OBJECT_ROTATION_X, 0.0);
vp_float_set(sdk, VP_OBJECT_ROTATION_Y, 0.0);
vp_float_set(sdk, VP_OBJECT_ROTATION_Z, 0.0);
vp_float_set(sdk, VP_OBJECT_ROTATION_ANGLE, 0.0);
vp_string_set(sdk, VP_OBJECT_MODEL, "street1.rwx");
vp_string_set(sdk, VP_OBJECT_ACTION, "");
vp_string_set(sdk, VP_OBJECT_DESCRIPTION, "");

rc = vp_object_add(sdk);
if (rc)
printf("Couldn't build object (reason %d)\n", rc);

//...
}
</syntaxhighlight>

Convert euler angles (in degrees) to axis-angle.
<syntaxhighlight lang="c">
void euler_to_axis_angle(double yaw, double pitch, double roll, double *x, double *y, double *z, double *angle)
{
// Convert angles to radians

yaw = (yaw / 180.0) * M_PI;
pitch = (pitch / 180.0) * M_PI;
roll = (roll / 180.0) * M_PI;

// Convert to axis-angle

double sin_yaw_2, sin_pitch_2, sin_roll_2, cos_yaw_2, cos_pitch_2, cos_roll_2;

sin_yaw_2 = sin(yaw / 2);
sin_pitch_2 = sin(pitch / 2);
sin_roll_2 = sin(roll / 2);
cos_yaw_2 = cos(yaw / 2);
cos_pitch_2 = cos(pitch / 2);
cos_roll_2 = cos(roll / 2);

// Return a normalized axis

double x_tmp, y_tmp, z_tmp;

x_tmp = sin_yaw_2 * sin_roll_2 * cos_pitch_2 + cos_yaw_2 * cos_roll_2 * sin_pitch_2;
y_tmp = sin_yaw_2 * cos_roll_2 * cos_pitch_2 + cos_yaw_2 * sin_roll_2 * sin_pitch_2;
z_tmp = cos_yaw_2 * sin_roll_2 * cos_pitch_2 - sin_yaw_2 * cos_roll_2 * sin_pitch_2;

double norm = sqrt(x_tmp * x_tmp + y_tmp * y_tmp + z_tmp * z_tmp);

if (norm)
{
*x = x_tmp / norm;
*y = y_tmp / norm;
*z = z_tmp / norm;
}
else
{
*x = 1;
*y = 0;
*z = 0;
}

*angle = 2 * acos(cos_yaw_2 * cos_pitch_2 * cos_roll_2 - sin_yaw_2 * sin_pitch_2 * sin_roll_2);
}
</syntaxhighlight>

Convert axis-angle to euler angles (in degrees).
<syntaxhighlight lang="c">
void axis_angle_to_euler(double x, double y, double z, double angle, double *yaw, double *pitch, double *roll)
{
// Normalize axis

double norm = sqrt(x * x + y * y + z * z);

if (norm)
{
x = x / norm;
y = y / norm;
z = z / norm;
}
else
{
*yaw = 0;
*pitch = 0;
*roll = 0;
return;
}

double sin_angle, cos_angle, cos_angle_1;

sin_angle = sin(angle);
cos_angle = cos(angle);
cos_angle_1 = 1 - cos(angle);

double yaw_tmp, pitch_tmp, roll_tmp;

if ((x * y * cos_angle_1 + z * sin_angle) > 0.998) // North pole singularity detected
{
yaw_tmp = 2 * atan2(x * sin(angle / 2), cos(angle / 2));
pitch_tmp = 0;
roll_tmp = M_PI_2;
}
else if ((x * y * cos_angle_1 + z * sin_angle) < -0.998) // South pole singularity detected
{
yaw_tmp = -2 * atan2(x * sin(angle / 2), cos(angle / 2));
pitch_tmp = 0;
roll_tmp = -M_PI_2;
}
else
{
yaw_tmp = atan2(y * sin_angle - x * z * cos_angle_1, 1 - (y * y + z * z) * cos_angle_1);
pitch_tmp = atan2(x * sin_angle - y * z * cos_angle_1, 1 - (x * x + z * z) * cos_angle_1);
roll_tmp = asin(x * y * cos_angle_1 + z * sin_angle);
}

*yaw = (yaw_tmp * 180) / M_PI;
*pitch = (pitch_tmp * 180) / M_PI;
*roll = (roll_tmp * 180) / M_PI;
}
</syntaxhighlight>
|seealso=
* {{sdk method|object_change}}
* {{sdk method|object_delete}}
* {{sdk callback|object_add}}
}}

Vp object get

2018-07-31T23:11:24Z

Sleepy E:

{{sdk method page|object_get|Gets the attributes of a single object in-world by its ID.
|version=0.3.37
|paramex=id
|parameters=
{{sdk parameter row|int|id|ID of the object}}
|attributes=
{{sdk attribute row|int|REFERENCE_NUMBER|Is passed to the callback to identify for which method call it is fired}}
|returncodes=
{{sdk return code row|NOT_INITIALIZED|SDK not initialized with {{sdk method|init}} yet}}
|behavior=
This is a non-blocking call that requires a [[callback]] to be set for {{sdk callback|OBJECT_GET}}. The callback will either return the object's data or an error [[reason code]].
|caveats=This call is only useful for single objects the bot does not know about. After getting an object's data once, it should cache the result and monitor changes using {{sdk event|object_change}}.
|seealso=
* {{sdk method|query_cell}}
* {{sdk event|object_click}}
* {{sdk callback|object_get}}
}}

Reason code

2018-07-31T23:09:19Z

Sleepy E: Redirected page to Return code

#REDIRECT [[return code]]

Vp object get

2018-07-31T23:08:46Z

Sleepy E: Added reference number attribute

{{sdk method page|object_get|Gets the attributes of a single object in-world by its ID.
|version=0.3.37
|paramex=id
|parameters=
{{sdk parameter row|int|id|ID of the object}}
|attributes=
{{sdk attribute row|int|REFERENCE_NUMBER|Will be passed to the callback to identify for which method call it is fired}}
|returncodes=
{{sdk return code row|NOT_INITIALIZED|SDK not initialized with {{sdk method|init}} yet}}
|behavior=
This is a non-blocking call that requires a [[callback]] to be set for {{sdk callback|OBJECT_GET}}. The callback will either return the object's data or an error [[reason code]].
|caveats=This call is only useful for single objects the bot does not know about. After getting an object's data once, it should cache the result and monitor changes using {{sdk event|object_change}}.
|seealso=
* {{sdk method|query_cell}}
* {{sdk event|object_click}}
* {{sdk callback|object_get}}
}}

Template:Sdk method page

2018-07-31T22:33:43Z

Sleepy E: Trying to fix a strange issue with the template

<div style="float: right; width: 400px; {{box-sizing}} {{bg linearfade|color={{{color|204,100%,90%}}}}}; padding: 32px 16px 16px 16px; border-radius: 0px 0px 16px 16px;">'''Method call snippet'''
<code style="display: block; padding: 8px; margin: 8px 0px; border: 1px dashed hsl(204,100%,70%);">vp_{{lc:{{{1|unknown}}}}}({{{customparamex|instance{{#if:{{{paramex|}}}|, {{{paramex}}}|}}}}});</code></div>
{{{2}}}__NOTOC__
== Parameters ==__NOEDITSECTION__
These are the parameters that this method requires:
{{sdk parameter table|{{#if:{{{noinstanceparam}}}|{{sdk parameter row|VPInstance|instance|Pointer to the instance this method call is intended for}}|}}
{{{parameters|}}}}}
{{#if: {{{attributes|}}} |== Used attributes ==__NOEDITSECTION__
This method uses data set in these attributes when called:
{{sdk attribute table|{{{attributes}}}}} |}}
== Returns ==__NOEDITSECTION__
{{{returns|This method returns a [[return code]] integer, which indicates whether the call was successful ({{code|0}}) or errored for any of these reasons:
{{sdk return code table|{{{returncodes|}}}}}
{{#if: {{{returnattributes|}}} |The following attributes will be returned in {{Sdk callback|{{{1}}}}} if the operation was successful:
{{sdk return attribute table|{{{returnattributes}}}}} |}} }}}
== Behavior ==__NOEDITSECTION__
{{#if: {{{behavior|}}} | {{{behavior}}} |:''There is no special behavior for this method''}}
{{#if: {{{caveats|}}} |== Caveats ==__NOEDITSECTION__
{{{caveats}}} |}}
== Examples ==__NOEDITSECTION__
{{#if: {{{examples|}}} | {{{examples}}} |:''This method has no usage examples; please add at least one to [{{canonicalurl:{{FULLPAGENAMEE}}|action=edit}} this page]''}}
{{#if: {{{seealso|}}} |== See also ==__NOEDITSECTION__
{{{seealso}}}
|}}{{{extra|}}}
<includeonly>{{DEFAULTSORT:{{{1}}}}} {{DISPLAYTITLE:vp_{{lc:{{{1}}}}}}} {{{category|[[Category:SDK methods]]}}}</includeonly><noinclude>

== Usage ==
<pre>{{sdk event page|Event name|Event description
|returntype=
|paramex=
|parameters=
{{sdk parameter row|type|name|description}}
|attributes=
{{sdk attribute row|type|name|description}}
|returncodes=
{{sdk return code row|name|cause}}
|returnattributes=
{{sdk attribute row|type|name|description}}
|behavior=
|caveats=
|examples=
|seealso=
}}</pre>

[[Category:Subpage templates]]
</noinclude>

Template:Sdk method page

2018-07-31T22:26:00Z

Sleepy E: Testing

<div style="float: right; width: 400px; {{box-sizing}} {{bg linearfade|color={{{color|204,100%,90%}}}}}; padding: 32px 16px 16px 16px; border-radius: 0px 0px 16px 16px;">'''Method call snippet'''
<code style="display: block; padding: 8px; margin: 8px 0px; border: 1px dashed hsl(204,100%,70%);">vp_{{lc:{{{1|unknown}}}}}({{{customparamex|instance{{#if:{{{paramex|}}}|, {{{paramex}}}|}}}}});</code></div>
{{{2}}}__NOTOC__{{#if: {{{parameters|}}} |== Parameters ==__NOEDITSECTION__
These are the parameters that this method requires:
{{sdk parameter table|{{#if:{{{noinstanceparam}}}|{{sdk parameter row|VPInstance|instance|Pointer to the instance this method call is intended for}}|}}
{{{parameters|}}}}} |}}{{#if: {{{attributes|}}} |== Used attributes ==__NOEDITSECTION__
This method uses data set in these attributes when called:
{{sdk attribute table|{{{attributes}}}}} |}}
== Returns ==__NOEDITSECTION__
{{{returns|This method returns a [[return code]] integer, which indicates whether the call was successful ({{code|0}}) or errored for any of these reasons:
{{sdk return code table|{{{returncodes|}}}}}
{{#if: {{{returnattributes|}}} |The following attributes will be returned in {{Sdk callback|{{{1}}}}} if the operation was successful:
{{sdk return attribute table|{{{returnattributes}}}}} |}} }}}
== Behavior ==__NOEDITSECTION__
{{#if: {{{behavior|}}} | {{{behavior}}} |:''There is no special behavior for this method''}}
{{#if: {{{caveats|}}} |== Caveats ==__NOEDITSECTION__
{{{caveats}}} |}}
== Examples ==__NOEDITSECTION__
{{#if: {{{examples|}}} | {{{examples}}} |:''This method has no usage examples; please add at least one to [{{canonicalurl:{{FULLPAGENAMEE}}|action=edit}} this page]''}}
{{#if: {{{seealso|}}} |== See also ==__NOEDITSECTION__
{{{seealso}}}
|}}{{{extra|}}}
<includeonly>{{DEFAULTSORT:{{{1}}}}} {{DISPLAYTITLE:vp_{{lc:{{{1}}}}}}} {{{category|[[Category:SDK methods]]}}}</includeonly><noinclude>

== Usage ==
<pre>{{sdk event page|Event name|Event description
|returntype=
|paramex=
|parameters=
{{sdk parameter row|type|name|description}}
|attributes=
{{sdk attribute row|type|name|description}}
|returncodes=
{{sdk return code row|name|cause}}
|returnattributes=
{{sdk attribute row|type|name|description}}
|behavior=
|caveats=
|examples=
|seealso=
}}</pre>

[[Category:Subpage templates]]
</noinclude>

Vp avatar click

2018-07-31T21:13:23Z

Sleepy E: Fixed typos and incorrect call snippet

{{sdk method page|avatar_click|Send an avatar click event to other users in the world.
|paramex=avatar_session
|parameters=
{{sdk parameter row|int |avatar_session |The session id of the clicked avatar}}
|attributes=
{{sdk attribute row|float |CLICK_HIT_X |X coordinate of hit (world coordinates)}}
{{sdk attribute row|float |CLICK_HIT_Y |Y coordinate of hit (world coordinates)}}
{{sdk attribute row|float |CLICK_HIT_Z |Z coordinate of hit (world coordinates)}}
|returncodes=
{{sdk return code row|NOT_IN_WORLD |World request made while not connected to a world server}}
|behavior=
* Upon successfully clicking an avatar, {{sdk event|AVATAR_CLICK}} is sent to those who have subscribed to it. See {{sdk method|event_set}}.
|caveats=
|examples=
|seealso=
* {{sdk event|AVATAR_CLICK}}
}}

Vp friend delete

2018-07-31T21:00:41Z

Sleepy E:

{{sdk method page|friend_delete|Delete a user from the friend list.
|paramex=friend_user_id
|parameters=
{{sdk parameter row|int|friend_user_id|User id of user to delete}}
|attributes=
|returncodes=
{{sdk return code row|not_in_universe|Universe request made while not connected to a universe server}}
|returnattributes=
|behavior=
|caveats=
|examples=
|seealso=
* {{sdk method|friends_get}}
* {{sdk method|friend_add_by_name}}
}}

Vp friend delete

2018-07-31T21:00:14Z

Sleepy E: Added missing reason code

{{sdk method page|friend_delete|Delete a user from the friend list.
|paramex=friend_user_id
|parameters=
{{sdk parameter row|int|friend_user_id|User id of user to delete}}
|attributes=
|returncodes=
{{sdk return code row|not_in_universe|Universe request made while not connected to a universe server
|returnattributes=
|behavior=
|caveats=
|examples=
|seealso=
* {{sdk method|friends_get}}
* {{sdk method|friend_add_by_name}}
}}

Vp user attributes by id

2018-07-30T23:31:22Z

Sleepy E: Added warning about failed requests

{{sdk method page|user_attributes_by_id|Request user attributes by user ID.
|paramex=user_id
|parameters=
{{sdk parameter row|int |user_id |User id}}
|returncodes=
|behavior=
The user attributes will be returned in the {{sdk event|USER_ATTRIBUTES}} event. See {{sdk method|event_set}}.
|caveats=
If the request fails then there will be no response from the server (e.g. if the user id doesn't exist).
|examples=
<syntaxhighlight lang="c">
void handle_user_attributes(VPInstance sdk)
{
int user_id;
const char *name;

user_id = vp_int(sdk, VP_USER_ID);
name = vp_string(sdk, VP_USER_NAME);

if (user_id == vp_int(sdk, VP_MY_USER_ID))
{
printf("The name of my owner is \"%s\"\n", name);
}
}

int main(int argc, const char* argv[])
{
//...

vp_event_set(sdk, VP_EVENT_USER_ATTRIBUTES, handle_user_attributes);
vp_user_attributes_by_id(sdk, vp_int(sdk, VP_MY_USER_ID));

//...
}
</syntaxhighlight>
|seealso=
* {{sdk event|USER_ATTRIBUTES}}
}}

Template:Sdk callback page

2018-07-30T23:11:51Z

Sleepy E: Missing reference parameter

<div style="float: right; width: 400px; {{box-sizing}} {{bg linearfade|color={{{color|204,100%,90%}}}}}; padding: 32px 16px 16px 16px; border-radius: 0px 0px 16px 16px;">'''Callback set and handler snippet'''
<code style="display: block; padding: 8px; margin: 8px 0px; border: 1px dashed hsl(204,100%,70%);">vp_callback_set(instance, VP_CALLBACK_{{uc:{{{1|unknown}}}}}, callback_{{lc:{{{1|unknown}}}}});

void callback_{{lc:{{{1|unknown}}}}}(VPInstance instance, int reason_code, int reference) { }</code></div>
Sent to the client in response to {{sdk_method|{{{1|unknown}}}}}__NOTOC__
== Reason code ==__NOEDITSECTION__
This callback is passed a [[return code]] integer, which indicates whether the request was successful ({{code|0}}) or errored for any of these reasons:
{{sdk return code table|{{{reasoncodes|}}}}}
== Return attributes ==__NOEDITSECTION__
{{#if: {{{returnattributes|}}} | {{sdk attribute table|{{{returnattributes}}}}} |:''No attributes are returned in this callback''}}
== Behavior ==__NOEDITSECTION__
{{#if: {{{behavior|}}} | {{{behavior}}} |:''There is no special behavior for this callback''}}
{{#if: {{{caveats|}}} |== Caveats ==__NOEDITSECTION__
{{{caveats}}} |}}
== Examples ==__NOEDITSECTION__
{{#if: {{{examples|}}} | {{{examples}}} |:''This callback has no usage examples; please add at least one to [{{canonicalurl:{{FULLPAGENAMEE}}|action=edit}} this page]''}}
{{#if: {{{seealso|}}} |== See also ==__NOEDITSECTION__
{{{seealso}}}
|}}{{{extra|}}}
<includeonly>{{DEFAULTSORT:{{{1}}}}} {{DISPLAYTITLE:VP_CALLBACK_{{uc:{{{1}}}}}}} {{{category|[[Category:SDK callbacks]]}}}</includeonly><noinclude>

== Usage ==
<pre>{{sdk callback page|Callback name
|reasoncodes=
{{sdk return code row|name|cause}}
|returnattributes=
{{sdk attribute row|type|name|description}}
|behavior=
|caveats=
|examples=
|seealso=
}}</pre>

[[Category:Subpage templates]]
</noinclude>

Return code

2018-07-30T21:47:18Z

Sleepy E:

{| class="wikitable sortable" border="1" width=100%
|-
!Reason code
!Value
!Description

|- id="VP_RC_SUCCESS"
|VP_RC_SUCCESS
|0
|Request has completed successfully

|- id="VP_RC_VERSION_MISMATCH"
|VP_RC_VERSION_MISMATCH
|1
|VP.h and the SDK library are from different builds

|- id="VP_RC_NOT_INITIALIZED"
|VP_RC_NOT_INITIALIZED
|2
|No longer used

|- id="VP_RC_ALREADY_INITIALIZED"
|VP_RC_ALREADY_INITIALIZED
|3
|No longer used

|- id="VP_RC_STRING_TOO_LONG"
|VP_RC_STRING_TOO_LONG
|4
|If any of the given string parameters exceed the maximum length for the operation (when using UTF-8 encoded characters they can each be multiple bytes long)

|- id="VP_RC_INVALID_LOGIN"
|VP_RC_INVALID_LOGIN
|5
|Incorrect username of password

|- id="VP_RC_WORLD_NOT_FOUND"
|VP_RC_WORLD_NOT_FOUND
|6
|No such world is connected to the universe

|- id="VP_RC_WORLD_LOGIN_ERROR"
|VP_RC_WORLD_LOGIN_ERROR
|7
|Could not enter world (e.g. incorrect world address configured) or banned (not yet implemented)

|- id="VP_RC_NOT_IN_WORLD"
|VP_RC_NOT_IN_WORLD
|8
|World request made while not connected to a world server

|- id="VP_RC_CONNECTION_ERROR"
|VP_RC_CONNECTION_ERROR
|9
|Unable to connect to universe, or waiting for events failed

|- id="VP_RC_NO_INSTANCE"
|VP_RC_NO_INSTANCE
|10
|No longer used

|- id="VP_RC_NOT_IMPLEMENTED"
|VP_RC_NOT_IMPLEMENTED
|11
|Requested operation is not implemented for bots (only available in the browser)

|- id="VP_RC_NO_SUCH_ATTRIBUTE"
|VP_RC_NO_SUCH_ATTRIBUTE
|12
|Invalid attribute (has an enum value that is out of range)

|- id="VP_RC_NOT_ALLOWED"
|VP_RC_NOT_ALLOWED
|13
|Not allowed to perform the requested operation

|- id="VP_RC_DATABASE_ERROR"
|VP_RC_DATABASE_ERROR
|14
|Unspecified database error

|- id="VP_RC_NO_SUCH_USER"
|VP_RC_NO_SUCH_USER
|15
|No user with a matching user id (or name) was found

|- id="VP_RC_TIMEOUT"
|VP_RC_TIMEOUT
|16
|It took too long to receive a response from the server

|- id="VP_RC_NOT_IN_UNIVERSE"
|VP_RC_NOT_IN_UNIVERSE
|17
|Universe request made while not connected to a universe server

|- id="VP_RC_INVALID_ARGUMENTS"
|VP_RC_INVALID_ARGUMENTS
|18
|???

|- id="VP_RC_OBJECT_NOT_FOUND"
|VP_RC_OBJECT_NOT_FOUND
|19
|???

|- id="VP_RC_UNKNOWN_ERROR"
|VP_RC_UNKNOWN_ERROR
|20
|Unknown error

|- id="VP_RC_RECURSIVE_WAIT"
|VP_RC_RECURSIVE_WAIT
|21
|{{sdk method|wait}} was called recursively on the same instance

|- id="VP_RC_JOIN_DECLINED"
|VP_RC_JOIN_DECLINED
|22
|Join request was declined

|- id="VP_RC_SECURE_CONNECTION_REQUIRED"
|VP_RC_SECURE_CONNECTION_REQUIRED
|23
|???

|- id="VP_RC_HANDSHAKE_FAILED"
|VP_RC_HANDSHAKE_FAILED
|24
|???

|- id="VP_RC_VERIFICATION_FAILED"
|VP_RC_VERIFICATION_FAILED
|25
|???

|- id="VP_RC_NO_SUCH_SESSION"
|VP_RC_NO_SUCH_SESSION
|26
|No user with the specified session is currently connected to the universe

|- id="VP_RC_NOT_SUPPORTED"
|VP_RC_NOT_SUPPORTED
|27
|Operation is not supported for this instance

|- id="VP_RC_INVITE_DECLINED"
|VP_RC_INVITE_DECLINED
|28
|Invite request was declined

|}

[[Category: Lists]]

Vp friend delete

2018-07-30T21:38:14Z

Sleepy E: User id is passed, not name

{{sdk method page|friend_delete|Delete a user from the friend list.
|paramex=friend_user_id
|parameters=
{{sdk parameter row|int|friend_user_id|User id of user to delete}}
|attributes=
|returncodes=
|returnattributes=
|behavior=
|caveats=
|examples=
|seealso=
* {{sdk method|friends_get}}
* {{sdk method|friend_add_by_name}}
}}

VP CALLBACK LOGIN

2018-07-30T21:17:12Z

Sleepy E: Removed reason codes that aren't passed to callback

{{sdk callback page|login
|reasoncodes=
{{sdk return code row|string_too_long |If any of the given string parameters exceed 255 bytes in length (when using UTF-8 encoded characters they can each be multiple bytes long)}}
{{sdk return code row|invalid_login |The login credentials are incorrect}}
|returnattributes=
{{sdk attribute row|int|my_user_id|User id of account used to log in}}
|examples=
|seealso=
}}

VP CALLBACK LOGIN

2018-07-30T21:14:49Z

Sleepy E: Changed template

{{sdk callback page|login
|reasoncodes=
{{sdk return code row|string_too_long |If any of the given string parameters exceed 255 bytes in length (when using UTF-8 encoded characters they can each be multiple bytes long)}}
{{sdk return code row|invalid_login |The login credentials are incorrect}}
{{sdk return code row|timeout |Timeout}}
{{sdk return code row|not_in_universe |Bot is not currently connected to universe}}
|returnattributes=
{{sdk attribute row|int|my_user_id|User id of account used to log in}}
|examples=
|seealso=
}}

Template:Sdk callback page

2018-07-30T21:13:43Z

Sleepy E:

<div style="float: right; width: 400px; {{box-sizing}} {{bg linearfade|color={{{color|204,100%,90%}}}}}; padding: 32px 16px 16px 16px; border-radius: 0px 0px 16px 16px;">'''Callback set and handler snippet'''
<code style="display: block; padding: 8px; margin: 8px 0px; border: 1px dashed hsl(204,100%,70%);">vp_callback_set(instance, VP_CALLBACK_{{uc:{{{1|unknown}}}}}, callback_{{lc:{{{1|unknown}}}}});

void callback_{{lc:{{{1|unknown}}}}}(VPInstance instance, int reason_code) { }</code></div>
Sent to the client in response to {{sdk_method|{{{1|unknown}}}}}__NOTOC__
== Reason code ==__NOEDITSECTION__
This callback is passed a [[return code]] integer, which indicates whether the request was successful ({{code|0}}) or errored for any of these reasons:
{{sdk return code table|{{{reasoncodes|}}}}}
== Return attributes ==__NOEDITSECTION__
{{#if: {{{returnattributes|}}} | {{sdk attribute table|{{{returnattributes}}}}} |:''No attributes are returned in this callback''}}
== Behavior ==__NOEDITSECTION__
{{#if: {{{behavior|}}} | {{{behavior}}} |:''There is no special behavior for this callback''}}
{{#if: {{{caveats|}}} |== Caveats ==__NOEDITSECTION__
{{{caveats}}} |}}
== Examples ==__NOEDITSECTION__
{{#if: {{{examples|}}} | {{{examples}}} |:''This callback has no usage examples; please add at least one to [{{canonicalurl:{{FULLPAGENAMEE}}|action=edit}} this page]''}}
{{#if: {{{seealso|}}} |== See also ==__NOEDITSECTION__
{{{seealso}}}
|}}{{{extra|}}}
<includeonly>{{DEFAULTSORT:{{{1}}}}} {{DISPLAYTITLE:VP_CALLBACK_{{uc:{{{1}}}}}}} {{{category|[[Category:SDK callbacks]]}}}</includeonly><noinclude>

== Usage ==
<pre>{{sdk callback page|Callback name
|reasoncodes=
{{sdk return code row|name|cause}}
|returnattributes=
{{sdk attribute row|type|name|description}}
|behavior=
|caveats=
|examples=
|seealso=
}}</pre>

[[Category:Subpage templates]]
</noinclude>

Template:Sdk callback page

2018-07-30T21:05:51Z

Sleepy E:

<div style="float: right; width: 400px; {{box-sizing}} {{bg linearfade|color={{{color|204,100%,90%}}}}}; padding: 32px 16px 16px 16px; border-radius: 0px 0px 16px 16px;">'''Callback set and handler snippet'''
<code style="display: block; padding: 8px; margin: 8px 0px; border: 1px dashed hsl(204,100%,70%);">vp_callback_set(instance, VP_CALLBACK_{{uc:{{{1|unknown}}}}}, callback_{{lc:{{{1|unknown}}}}});

void callback_{{lc:{{{1|unknown}}}}}(VPInstance instance, int reason_code) { }</code></div>
{{{2}}}__NOTOC__
== Reason code ==__NOEDITSECTION__
This callback is passed a [[return code]] integer, which indicates whether the request was successful ({{code|0}}) or errored for any of these reasons:
{{sdk return code table|{{{reasoncodes|}}}}}
== Return attributes ==__NOEDITSECTION__
{{#if: {{{returnattributes|}}} | {{sdk attribute table|{{{returnattributes}}}}} |:''No attributes are returned in this callback''}}
== Behavior ==__NOEDITSECTION__
{{#if: {{{behavior|}}} | {{{behavior}}} |:''There is no special behavior for this callback''}}
{{#if: {{{caveats|}}} |== Caveats ==__NOEDITSECTION__
{{{caveats}}} |}}
== Examples ==__NOEDITSECTION__
{{#if: {{{examples|}}} | {{{examples}}} |:''This callback has no usage examples; please add at least one to [{{canonicalurl:{{FULLPAGENAMEE}}|action=edit}} this page]''}}
{{#if: {{{seealso|}}} |== See also ==__NOEDITSECTION__
{{{seealso}}}
|}}{{{extra|}}}
<includeonly>{{DEFAULTSORT:{{{1}}}}} {{DISPLAYTITLE:VP_CALLBACK_{{uc:{{{1}}}}}}} {{{category|[[Category:SDK callbacks]]}}}</includeonly><noinclude>

== Usage ==
<pre>{{sdk callback page|Callback name|Callback description
|reasoncodes=
{{sdk return code row|name|cause}}
|returnattributes=
{{sdk attribute row|type|name|description}}
|behavior=
|caveats=
|examples=
|seealso=
}}</pre>

[[Category:Subpage templates]]
</noinclude>

Template:Sdk callback page

2018-07-30T21:02:59Z

Sleepy E: Undo revision 4918 by Sleepy E (talk)

<div style="float: right; width: 400px; {{box-sizing}} {{bg linearfade|color={{{color|204,100%,90%}}}}}; padding: 32px 16px 16px 16px; border-radius: 0px 0px 16px 16px;">'''Callback set and handler snippet'''
<code style="display: block; padding: 8px; margin: 8px 0px; border: 1px dashed hsl(204,100%,70%);">vp_callback_set(instance, VP_CALLBACK_{{uc:{{{1|unknown}}}}}, callback_{{lc:{{{1|unknown}}}}});

void callback_{{lc:{{{1|unknown}}}}}(VPInstance instance, int reason_code) { }</code></div>
{{{2}}}__NOTOC__
== Reason code ==__NOEDITSECTION__
{{{reasoncodes|This callback is passed a [[return code]] integer, which indicates whether the request was successful ({{code|0}}) or errored for any of these reasons:
{{sdk return code table|{{{reasoncodes|}}}}}
== Return attributes ==__NOEDITSECTION__
{{#if: {{{returnattributes|}}} | {{sdk attribute table|{{{returnattributes}}}}} |:''No attributes are returned in this callback''}}
== Behavior ==__NOEDITSECTION__
{{#if: {{{behavior|}}} | {{{behavior}}} |:''There is no special behavior for this callback''}}
{{#if: {{{caveats|}}} |== Caveats ==__NOEDITSECTION__
{{{caveats}}} |}}
== Examples ==__NOEDITSECTION__
{{#if: {{{examples|}}} | {{{examples}}} |:''This callback has no usage examples; please add at least one to [{{canonicalurl:{{FULLPAGENAMEE}}|action=edit}} this page]''}}
{{#if: {{{seealso|}}} |== See also ==__NOEDITSECTION__
{{{seealso}}}
|}}{{{extra|}}}
<includeonly>{{DEFAULTSORT:{{{1}}}}} {{DISPLAYTITLE:VP_CALLBACK_{{uc:{{{1}}}}}}} {{{category|[[Category:SDK callbacks]]}}}</includeonly><noinclude>

== Usage ==
<pre>{{sdk callback page|Callback name|Callback description
|reasoncodes=
{{sdk return code row|name|cause}}
|returnattributes=
{{sdk attribute row|type|name|description}}
|behavior=
|caveats=
|examples=
|seealso=
}}</pre>

[[Category:Subpage templates]]
</noinclude>

Template:Sdk callback page

2018-07-30T21:02:33Z

Sleepy E:

<div style="float: right; width: 400px; {{box-sizing}} {{bg linearfade|color={{{color|204,100%,90%}}}}}; padding: 32px 16px 16px 16px; border-radius: 0px 0px 16px 16px;">'''Callback set and handler snippet'''
<code style="display: block; padding: 8px; margin: 8px 0px; border: 1px dashed hsl(204,100%,70%);">vp_callback_set(instance, VP_CALLBACK_{{uc:{{{1|unknown}}}}}, callback_{{lc:{{{1|unknown}}}}});

void callback_{{lc:{{{1|unknown}}}}}(VPInstance instance, int reason_code) { }</code></div>
{{{2}}}__NOTOC__
== Reason code ==__NOEDITSECTION__
{{{returns|This callback is passed a [[return code]] integer, which indicates whether the request was successful ({{code|0}}) or errored for any of these reasons:
{{sdk return code table|{{{reasoncodes|}}}}}
== Return attributes ==__NOEDITSECTION__
{{#if: {{{returnattributes|}}} | {{sdk attribute table|{{{returnattributes}}}}} |:''No attributes are returned in this callback''}}
== Behavior ==__NOEDITSECTION__
{{#if: {{{behavior|}}} | {{{behavior}}} |:''There is no special behavior for this callback''}}
{{#if: {{{caveats|}}} |== Caveats ==__NOEDITSECTION__
{{{caveats}}} |}}
== Examples ==__NOEDITSECTION__
{{#if: {{{examples|}}} | {{{examples}}} |:''This callback has no usage examples; please add at least one to [{{canonicalurl:{{FULLPAGENAMEE}}|action=edit}} this page]''}}
{{#if: {{{seealso|}}} |== See also ==__NOEDITSECTION__
{{{seealso}}}
|}}{{{extra|}}}
<includeonly>{{DEFAULTSORT:{{{1}}}}} {{DISPLAYTITLE:VP_CALLBACK_{{uc:{{{1}}}}}}} {{{category|[[Category:SDK callbacks]]}}}</includeonly><noinclude>

== Usage ==
<pre>{{sdk callback page|Callback name|Callback description
|reasoncodes=
{{sdk return code row|name|cause}}
|returnattributes=
{{sdk attribute row|type|name|description}}
|behavior=
|caveats=
|examples=
|seealso=
}}</pre>

[[Category:Subpage templates]]
</noinclude>

VP CALLBACK LOGIN

2018-07-30T20:58:46Z

Sleepy E: Changed naming

{{sdk callback page|login|Sent to the client from a call to {{sdk method|login}}.
|reasoncodes=
{{sdk return code row|string_too_long |If any of the given string parameters exceed 255 bytes in length (when using UTF-8 encoded characters they can each be multiple bytes long)}}
{{sdk return code row|invalid_login |The login credentials are incorrect}}
{{sdk return code row|timeout |Timeout}}
{{sdk return code row|not_in_universe |Bot is not currently connected to universe}}
|returnattributes=
{{sdk attribute row|int|my_user_id|User id of account used to log in}}
|examples=
|seealso=
* {{sdk method|login}}
}}

Template:Sdk callback page

2018-07-30T20:57:41Z

Sleepy E: Added callback page template

<div style="float: right; width: 400px; {{box-sizing}} {{bg linearfade|color={{{color|204,100%,90%}}}}}; padding: 32px 16px 16px 16px; border-radius: 0px 0px 16px 16px;">'''Callback set and handler snippet'''
<code style="display: block; padding: 8px; margin: 8px 0px; border: 1px dashed hsl(204,100%,70%);">vp_callback_set(instance, VP_CALLBACK_{{uc:{{{1|unknown}}}}}, callback_{{lc:{{{1|unknown}}}}});

void callback_{{lc:{{{1|unknown}}}}}(VPInstance instance, int reason_code) { }</code></div>
{{{2}}}__NOTOC__
== Reason code ==__NOEDITSECTION__
{{{reasoncodes|This callback is passed a [[return code]] integer, which indicates whether the request was successful ({{code|0}}) or errored for any of these reasons:
{{sdk return code table|{{{reasoncodes|}}}}}
== Return attributes ==__NOEDITSECTION__
{{#if: {{{returnattributes|}}} | {{sdk attribute table|{{{returnattributes}}}}} |:''No attributes are returned in this callback''}}
== Behavior ==__NOEDITSECTION__
{{#if: {{{behavior|}}} | {{{behavior}}} |:''There is no special behavior for this callback''}}
{{#if: {{{caveats|}}} |== Caveats ==__NOEDITSECTION__
{{{caveats}}} |}}
== Examples ==__NOEDITSECTION__
{{#if: {{{examples|}}} | {{{examples}}} |:''This callback has no usage examples; please add at least one to [{{canonicalurl:{{FULLPAGENAMEE}}|action=edit}} this page]''}}
{{#if: {{{seealso|}}} |== See also ==__NOEDITSECTION__
{{{seealso}}}
|}}{{{extra|}}}
<includeonly>{{DEFAULTSORT:{{{1}}}}} {{DISPLAYTITLE:VP_CALLBACK_{{uc:{{{1}}}}}}} {{{category|[[Category:SDK callbacks]]}}}</includeonly><noinclude>

== Usage ==
<pre>{{sdk callback page|Callback name|Callback description
|reasoncodes=
{{sdk return code row|name|cause}}
|returnattributes=
{{sdk attribute row|type|name|description}}
|behavior=
|caveats=
|examples=
|seealso=
}}</pre>

[[Category:Subpage templates]]
</noinclude>

VP CALLBACK LOGIN

2018-07-30T20:39:22Z

Sleepy E: Starting to work on callback page

{{sdk callback page|login|Sent to the client from a call to {{sdk method|login}}.
|returncodes=
{{sdk return code row|string_too_long |If any of the given string parameters exceed 255 bytes in length (when using UTF-8 encoded characters they can each be multiple bytes long)}}
{{sdk return code row|invalid_login |The login credentials are incorrect}}
{{sdk return code row|timeout |Timeout}}
{{sdk return code row|not_in_universe |Bot is not currently connected to universe}}
|returnattributes=
{{sdk attribute row|int|my_user_id|User id of account used to log in}}
|examples=
|seealso=
* {{sdk method|login}}
}}

Return code

2018-07-30T20:06:47Z

Sleepy E: Added reason code for declined invites

{| class="wikitable sortable" border="1" width=100%
|-
!Reason code
!Value
!Description

|- id="VP_RC_SUCCESS"
|VP_RC_SUCCESS
|0
|Request has completed successfully

|- id="VP_RC_VERSION_MISMATCH"
|VP_RC_VERSION_MISMATCH
|1
|VP.h and the SDK library are from different builds

|- id="VP_RC_NOT_INITIALIZED"
|VP_RC_NOT_INITIALIZED
|2
|No longer used

|- id="VP_RC_ALREADY_INITIALIZED"
|VP_RC_ALREADY_INITIALIZED
|3
|No longer used

|- id="VP_RC_STRING_TOO_LONG"
|VP_RC_STRING_TOO_LONG
|4
|If any of the given string parameters exceed the maximum length for the operation (when using UTF-8 encoded characters they can each be multiple bytes long)

|- id="VP_RC_INVALID_LOGIN"
|VP_RC_INVALID_LOGIN
|5
|Incorrect username of password

|- id="VP_RC_WORLD_NOT_FOUND"
|VP_RC_WORLD_NOT_FOUND
|6
|No such world is connected to the universe

|- id="VP_RC_WORLD_LOGIN_ERROR"
|VP_RC_WORLD_LOGIN_ERROR
|7
|Could not enter world (e.g. incorrect world address configured) or banned (not yet implemented)

|- id="VP_RC_NOT_IN_WORLD"
|VP_RC_NOT_IN_WORLD
|8
|World request made while not connected to a world server

|- id="VP_RC_CONNECTION_ERROR"
|VP_RC_CONNECTION_ERROR
|9
|Unable to connect to universe, or waiting for events failed

|- id="VP_RC_NO_INSTANCE"
|VP_RC_NO_INSTANCE
|10
|No longer used

|- id="VP_RC_NOT_IMPLEMENTED"
|VP_RC_NOT_IMPLEMENTED
|11
|Requested operation is not implemented for bots (only available in the browser)

|- id="VP_RC_NO_SUCH_ATTRIBUTE"
|VP_RC_NO_SUCH_ATTRIBUTE
|12
|Invalid attribute (has an enum value that is out of range)

|- id="VP_RC_NOT_ALLOWED"
|VP_RC_NOT_ALLOWED
|13
|Not allowed to perform the requested operation

|- id="VP_RC_DATABASE_ERROR"
|VP_RC_DATABASE_ERROR
|14
|Unspecified database error

|- id="VP_RC_NO_SUCH_USER"
|VP_RC_NO_SUCH_USER
|15
|No user with a matching user id (or name) was found

|- id="VP_RC_TIMEOUT"
|VP_RC_TIMEOUT
|16
|It took too long to receive a response from the server

|- id="VP_RC_NOT_IN_UNIVERSE"
|VP_RC_NOT_IN_UNIVERSE
|17
|Universe request made while not connected to a universe server

|- id="VP_RC_INVALID_ARGUMENTS"
|VP_RC_INVALID_ARGUMENTS
|18
|???

|- id="VP_RC_OBJECT_NOT_FOUND"
|VP_RC_OBJECT_NOT_FOUND
|19
|???

|- id="VP_RC_UNKNOWN_ERROR"
|VP_RC_UNKNOWN_ERROR
|20
|Unknown error

|- id="VP_RC_RECURSIVE_WAIT"
|VP_RC_RECURSIVE_WAIT
|21
|{{sdk method|wait}} was called recursively

|- id="VP_RC_JOIN_DECLINED"
|VP_RC_JOIN_DECLINED
|22
|Join request was declined

|- id="VP_RC_SECURE_CONNECTION_REQUIRED"
|VP_RC_SECURE_CONNECTION_REQUIRED
|23
|???

|- id="VP_RC_HANDSHAKE_FAILED"
|VP_RC_HANDSHAKE_FAILED
|24
|???

|- id="VP_RC_VERIFICATION_FAILED"
|VP_RC_VERIFICATION_FAILED
|25
|???

|- id="VP_RC_NO_SUCH_SESSION"
|VP_RC_NO_SUCH_SESSION
|26
|No user with the specified session is currently connected to the universe

|- id="VP_RC_NOT_SUPPORTED"
|VP_RC_NOT_SUPPORTED
|27
|Operation is not supported for this instance

|- id="VP_RC_INVITE_DECLINED"
|VP_RC_INVITE_DECLINED
|28
|Invite request was declined

|}

[[Category: Lists]]