Virtual Paradise Wiki - User contributions [en]

VP EVENT OBJECT

2014-05-11T09:23:53Z

Roy Curtis: fixed wording on rotation

{{sdk event page|object|This event is received:
* Each time an object is created anywhere in the world
* For each object in a cell queried by a call to {{sdk function|query_cell}}
|attributes=
{{sdk attribute row|int |avatar_session|Session ID of object's creator}}

{{sdk attribute header|Data of the created object:}}
{{sdk attribute row|int |object_id |Unique ID}}
{{sdk attribute row|int |object_user_id |Creator's ID}}
{{sdk attribute row|int |object_time |Timestamp}}
{{sdk attribute row|int |object_type |Type}}
{{sdk attribute row|string|object_model |Model file name}}
{{sdk attribute row|string|object_description |Description}}
{{sdk attribute row|string|object_action |Action code}}
{{sdk attribute row|float |object_x |X position}}
{{sdk attribute row|float |object_y |Y position}}
{{sdk attribute row|float |object_z |Z position}}
{{sdk attribute row|float |object_rotation_x |X axis-angle rotation}}
{{sdk attribute row|float |object_rotation_y |Y axis-angle rotation}}
{{sdk attribute row|float |object_rotation_z |Z axis-angle rotation}}
{{sdk attribute row|float |object_rotation_angle|A axis-angle rotation}}
{{sdk attribute row|data |object_data |Arbitrary data}}
|behavior=
If this event was fired as a result of an object created by a client, {{sdk attribute|avatar_session}} will have their session number. Otherwise, query results will have this set to {{code|-1}}.
|caveats=
|examples=
|seealso=
}}

Category:SDK attributes

2014-04-28T20:35:52Z

Roy Curtis: Created page with "Category:SDK"

[[Category:SDK]]

List of SDK attributes

2014-04-28T19:55:56Z

Roy Curtis: Created page with "A list of attributes available in the C SDK. For the category, see :Category:SDK attributes. * {{sdk attribute|int|AVATAR_SESSION}} * {{sdk attribute|int|AVATAR_T..."

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|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|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|data|HIGHEST_STRING}}
* {{sdk attribute|data|OBJECT_DATA}}
* {{sdk attribute|data|TERRAIN_NODE_DATA}}

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

List of SDK callbacks

2014-04-28T19:45:36Z

Roy Curtis: switched to callback formatting template

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

* {{sdk callback|OBJECT_ADD}}
* {{sdk callback|OBJECT_CHANGE}}
* {{sdk callback|OBJECT_DELETE}}
* {{sdk callback|GET_FRIENDS}}
* {{sdk callback|FRIEND_ADD}}
* {{sdk callback|FRIEND_DELETE}}
* {{sdk callback|TERRAIN_QUERY}}
* {{sdk callback|TERRAIN_NODE_SET}}
* {{sdk callback|OBJECT_GET}}

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

Template:Sdk callback

2014-04-28T19:44:03Z

Roy Curtis: Created page with "{{code|unknown}}}}}}}<noinclude>Category:Formatting templates</noinclude>"

{{code|[[VP_CALLBACK_{{uc:{{{1|unknown}}}}}]]}}<noinclude>[[Category:Formatting templates]]</noinclude>

Template:Sdk event

2014-04-28T19:43:51Z

Roy Curtis: use code template

{{code|[[VP_EVENT_{{uc:{{{1|unknown}}}}}]]}}<noinclude>[[Category:Formatting templates]]</noinclude>

Template:Sdk function

2014-04-28T19:41:08Z

Roy Curtis: redir to sdk method template

#REDIRECT [[Template:Sdk method]]

Template:Sdk method

2014-04-28T19:40:46Z

Roy Curtis: added title

{{code|title=A callable SDK function|[[vp_{{lc:{{{1|???}}}}}]]()}}<noinclude>[[Category:Formatting templates]]</noinclude>

Template:Code

2014-04-28T19:40:07Z

Roy Curtis: added title param

<code title="{{{title|}}}">{{{1|???}}}</code><noinclude>[[Category:Formatting templates]]</noinclude>

List of SDK methods

2014-04-28T19:35:48Z

Roy Curtis: Created page with "A list of methods available in the C SDK. For the category, see :Category:SDK methods. * {{sdk method|init}} * {{sdk method|create}} * {{sdk method|destroy}} * {{sdk..."

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

* {{sdk method|init}}
* {{sdk method|create}}
* {{sdk method|destroy}}
* {{sdk method|connect_universe}}
* {{sdk method|login}}
* {{sdk method|wait}}
* {{sdk method|enter}}
* {{sdk method|leave}}
* {{sdk method|say}}
* {{sdk method|console_message}}
* {{sdk method|event_set}}
* {{sdk method|callback_set}}
* {{sdk method|user_data}}
* {{sdk method|user_data_set}}
* {{sdk method|state_change}}
* {{sdk method|int}}
* {{sdk method|int_get}}
* {{sdk method|int_set}}
* {{sdk method|float}}
* {{sdk method|float_get}}
* {{sdk method|float_set}}
* {{sdk method|string}}
* {{sdk method|string_get}}
* {{sdk method|string_set}}
* {{sdk method|data}}
* {{sdk method|data_get}}
* {{sdk method|data_set}}
* {{sdk method|query_cell}}
* {{sdk method|object_add}}
* {{sdk method|object_bump_begin}}
* {{sdk method|object_bump_end}}
* {{sdk method|object_change}}
* {{sdk method|object_click}}
* {{sdk method|object_delete}}
* {{sdk method|object_get}}
* {{sdk method|world_list}}
* {{sdk method|user_attributes_by_id}}
* {{sdk method|user_attributes_by_name}}
* {{sdk method|friends_get}}
* {{sdk method|friend_add_by_name}}
* {{sdk method|friend_delete}}
* {{sdk method|terrain_query}}
* {{sdk method|terrain_node_set}}
* {{sdk method|avatar_click}}
* {{sdk method|teleport_avatar}}
* {{sdk method|url_send}}

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

Category:SDK callbacks

2014-04-28T19:27:06Z

Roy Curtis: Created page with "Category:SDK"

[[Category:SDK]]

List of SDK callbacks

2014-04-28T19:26:40Z

Roy Curtis: complete list

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

* [[VP_CALLBACK_OBJECT_ADD]]
* [[VP_CALLBACK_OBJECT_CHANGE]]
* [[VP_CALLBACK_OBJECT_DELETE]]
* [[VP_CALLBACK_GET_FRIENDS]]
* [[VP_CALLBACK_FRIEND_ADD]]
* [[VP_CALLBACK_FRIEND_DELETE]]
* [[VP_CALLBACK_TERRAIN_QUERY]]
* [[VP_CALLBACK_TERRAIN_NODE_SET]]
* [[VP_CALLBACK_OBJECT_GET]]

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

List of SDK events

2014-04-28T19:20:46Z

Roy Curtis: complete list

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

* [[VP_EVENT_CHAT]]
* [[VP_EVENT_AVATAR_ADD]]
* [[VP_EVENT_AVATAR_CHANGE]]
* [[VP_EVENT_AVATAR_DELETE]]
* [[VP_EVENT_OBJECT]]
* [[VP_EVENT_OBJECT_CHANGE]]
* [[VP_EVENT_OBJECT_DELETE]]
* [[VP_EVENT_OBJECT_CLICK]]
* [[VP_EVENT_WORLD_LIST]]
* [[VP_EVENT_WORLD_SETTING]]
* [[VP_EVENT_WORLD_SETTINGS_CHANGED]]
* [[VP_EVENT_FRIEND]]
* [[VP_EVENT_WORLD_DISCONNECT]]
* [[VP_EVENT_UNIVERSE_DISCONNECT]]
* [[VP_EVENT_USER_ATTRIBUTES]]
* [[VP_EVENT_CELL_END]]
* [[VP_EVENT_TERRAIN_NODE]]
* [[VP_EVENT_AVATAR_CLICK]]
* [[VP_EVENT_TELEPORT]]
* [[VP_EVENT_URL]]
* [[VP_EVENT_OBJECT_BUMP_BEGIN]]
* [[VP_EVENT_OBJECT_BUMP_END]]

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

Category:Games

2014-04-28T19:12:13Z

Roy Curtis: wanted cat

Articles and categories pertaining to games hosted in Virtual Paradise and/or developed with the Virtual Paradise [[SDK]].

[[Category:Articles]]

SDK

2014-04-28T17:13:38Z

Roy Curtis: hub page

The Virtual Paradise '''Software Development Kit''' is used for interacting with Virtual Paradise universes and worlds. This page serves as a hub for all SDK topics in the wiki.

== Documentation ==
* [[Getting started/SDK]]
* [[Tutorials/SDK]]

=== General concepts ===
* [[Avatar]]
* [[Property]]
* [[Terrain]]
* [[Universe]]
* [[World]]

== C reference ==
All reference pages of the standard Virtual Paradise C SDK are documented on this wiki. For other SDKs, such as the C# wrapper, visit their project websites for documentation.

* [[List of SDK events]] - [[:Category:SDK events]]
* [[List of SDK callbacks]] - [[:Category:SDK callbacks]]
* [[List of SDK methods]] - [[:Category:SDK methods]]
* [[List of SDK attributes]] - [[:Category:SDK attributes]]
* [[:Category:SDK examples]]

[[Category:SDK]]

List of SDK Callbacks

2014-04-28T17:06:55Z

Roy Curtis: Roy Curtis moved page List of SDK Callbacks to List of SDK callbacks: casefix

#REDIRECT [[List of SDK callbacks]]

List of SDK callbacks

2014-04-28T17:06:55Z

Roy Curtis: Roy Curtis moved page List of SDK Callbacks to List of SDK callbacks: casefix

* [[VP_CALLBACK_OBJECT_ADD]]
* [[VP_CALLBACK_OBJECT_CHANGE]]
* [[VP_CALLBACK_OBJECT_DELETE]]
* [[VP_CALLBACK_GET_FRIENDS]]
* [[VP_CALLBACK_FRIEND_ADD]]
* [[VP_CALLBACK_FRIEND_DELETE]]
* [[VP_CALLBACK_TERRAIN_QUERY]]
* [[VP_CALLBACK_TERRAIN_NODE_SET]]

[[Category: SDK]]
[[Category: Lists]]

List of SDK Events

2014-04-28T17:06:45Z

Roy Curtis: Roy Curtis moved page List of SDK Events to List of SDK events: casefix

#REDIRECT [[List of SDK events]]

List of SDK events

2014-04-28T17:06:45Z

Roy Curtis: Roy Curtis moved page List of SDK Events to List of SDK events: casefix

* [[VP_EVENT_CHAT]]
* [[VP_EVENT_AVATAR_ADD]]
* [[VP_EVENT_AVATAR_CHANGE]]
* [[VP_EVENT_AVATAR_DELETE]]
* [[VP_EVENT_OBJECT]]
* [[VP_EVENT_OBJECT_CHANGE]]
* [[VP_EVENT_OBJECT_DELETE]]
* [[VP_EVENT_OBJECT_CLICK]]
* [[VP_EVENT_WORLD_LIST]]
* [[VP_EVENT_WORLD_SETTING]]
* [[VP_EVENT_WORLD_SETTINGS_CHANGED]]
* [[VP_EVENT_FRIEND]]
* [[VP_EVENT_WORLD_DISCONNECT]]
* [[VP_EVENT_UNIVERSE_DISCONNECT]]
* [[VP_EVENT_USER_ATTRIBUTES]]
* [[VP_EVENT_CELL_END]]
* [[VP_EVENT_TERRAIN_NODE]]
* [[VP_EVENT_AVATAR_CLICK]]
* [[VP_EVENT_TELEPORT]]

[[Category: SDK]]
[[Category: Lists]]

User:Roy Curtis/Category tree

2014-04-28T17:06:26Z

Roy Curtis: -wikiprojects

This tree is only a guideline for category structure; please do not create these categories until they are needed. List copied from ActiveWiki; some categories may not be applicable to this wiki.

* [[:Category:VPWiki]]
** [[:Category:Administration]]
*** [[:Category:Protection requests]]
*** [[:Category:Policy discussion]]

----

*-
** [[:Category:Articles]]
*** [[:Category:Software]]
**** [[:Category:Client]]
***** [[:Category:Communicating]]
***** [[:Category:Versions]]
***** [[:Category:Avatars]]
***** [[:Category:Objects]]
**** [[:Category:Bots]]
**** [[:Category:Utilities]]
**** [[:Category:Renderware]]
***** [[:Category:RWX commands]]
**** [[:Category:Servers]]
***** [[:Category:World server]]
***** [[:Category:Universe server]]
*** [[:Category:Terminology]]
*** [[:Category:Events]]
**** [[:Category:Reunions]]
*** [[:Category:News and media]]
**** [[:Category:Television]]
**** [[:Category:Radio]]
**** [[:Category:Publishing]]
*** [[:Category:Groups]]
**** [[:Category:Companies]]
**** [[:Category:Communities]]
**** [[:Category:Organizations]]
***** [[:Category:Defunct organizations]]
***** [[:Category:Helper organizations]]
*** [[:Category:History]]
**** [[:Category:Years]]
**** [[:Category:Versions]]
*** [[:Category:Projects]]
*** [[:Category:Lore]]
**** [[:Category:Political entities]]
*** [[:Category:Games]]
*** [[:Category:Building]]
**** [[:Category:Building commands]]
*** [[:Category:SDK]]
**** [[:Category:SDK events]]
**** [[:Category:SDK callbacks]]
**** [[:Category:SDK methods]]
**** [[:Category:SDK attributes]]
**** [[:Category:SDK examples]]
*** [[:Category:Places]]
**** [[:Category:Buildings]]
**** [[:Category:Galaxies]]
***** [[:Category:Defunct galaxies]]
**** [[:Category:Worlds]]
***** [[:Category:World administration]]
***** [[:Category:Defunct worlds]]
*** [[:Category:People]]
**** [[:Category:Citizens]]
**** [[:Category:Staff]]
*** [[:Category:Websites]]

----

* -
** [[:Category:Disambiguations]]
** [[:Category:Documents]]
** [[:Category:Images]]
*** [[:Category:Guide images]]
*** [[:Category:Animated images]]
*** [[:Category:Screenshots]]
**** [[:Category:Client screenshots]]
**** [[:Category:Utility screenshots]]
**** [[:Category:Bot screenshots]]
**** [[:Category:World screenshots]]
**** [[:Category:Build screenshots]]
**** [[:Category:3D homepage screenshots]]
*** [[:Category:Template images]]
**** [[:Category:Badges]]
** [[:Category:FAQs]]
** [[:Category:Lists]]
** [[:Category:Guides]]
** [[:Category:Maintenance]]
*** [[:Category:Flagged for deletion]]
*** [[:Category:Flagged for cleaning]]
*** [[:Category:Flagged for merging]]
*** [[:Category:Categories for deletion]]
*** [[:Category:Articles with missing coordinates]]
*** [[:Category:Articles with uncertainties]]
*** [[:Category:Articles with downloads]]
*** [[:Category:Citation needed]]
*** [[:Category:Nonexistent]]
*** [[:Category:Pages with broken file links]]
** [[:Category:Portals]]
** [[:Category:Users]]
*** [[:Category:Notable contributors]]
** [[:Category:Stubs]]
** [[:Category:Templates]]
*** [[:Category:Jokes]]
*** [[:Category:Button templates]]
*** [[:Category:Pill templates]]
*** [[:Category:Formatting templates]]
*** [[:Category:Wishlist templates]]
*** [[:Category:Maintenance templates]]
*** [[:Category:Reference templates]]
*** [[:Category:Subpage templates]]
*** [[:Category:Messageboxes]]
*** [[:Category:Userboxes]]
*** [[:Category:Navboxes]]
*** [[:Category:Infoboxes]]

User:Roy Curtis/Category tree

2014-04-28T17:06:05Z

Roy Curtis: SDK cats

Main Page

2014-04-27T17:14:33Z

Roy Curtis: updated downloads

<div style="width: 100%; padding: 32px 16px 8px 16px; margin: 0 auto; {{box-sizing}} {{bg linearfade|color=204,100%,90%}}">
{{:Main Page/t/sectionbox|float=left|align=center|width=25%|
<h3>Welcome to the Virtual Paradise wiki</h3>
A publicly editable resource of '''{{NUMBEROFARTICLES}} articles''' related to the '''Virtual Paradise''' platform and friends.
}}

{{:Main Page/t/sectionbox|margin-left=26%|
[[Image:Blizzard GZ.jpg|128px|right|Ground zero of Blizzard world]]
<h3>What is Virtual Paradise?</h3>
''From the [http://virtualparadise.org official website]:'' '''Virtual Paradise''' is an online virtual universe consisting of several 3D [[:Category:Worlds|worlds]]. In each world you can chat with others, create your own [[:Category:Buildings and structures|buildings]] and explore the environments built by other [[List of citizens|users]] of Virtual Paradise.
----
'''Latest client version:''' [[Changelog|0.3.41]] {{*}} '''Download now:''' [http://virtualparadise.org/downloads/virtualparadise_0.3.41_windows_x86.zip Windows] - [http://virtualparadise.org/downloads/virtualparadise_0.3.41_mac_x86.dmg MacOS X] - Ubuntu [http://virtualparadise.org/downloads/virtualparadise_0.3.38_i386.deb x86]/[http://virtualparadise.org/downloads/virtualparadise_0.3.39_x86_64.deb x64]{{clear}}
}}
{{clear}}
</div>


<div style="width: 100%; padding: 8px 16px 16px 16px; margin: 0 auto; {{box-sizing}} background: hsla(204,100%,86%,1); border-radius: 0px 0px 16px 16px;">
{{:Main Page/t/sectionbox|float=left|width=25%|{{:Main Page/section/sidebar}}}}

{{:Main Page/t/sectionbox|margin-left=26%|
{{:Main Page/t/subsectionbox|padding-right=16px|{{:Main Page/section/Programmers}}}}
{{:Main Page/t/subsectionbox|{{:Main Page/section/External links}}}}
}}

{{:Main Page/t/sectionbox|margin-left=26%|
{{:Main Page/section/What's new}}
}}
{{clear}}
</div>
__NOTOC__

Main Page

2014-04-27T17:02:07Z

Roy Curtis: version bump

<div style="width: 100%; padding: 32px 16px 8px 16px; margin: 0 auto; {{box-sizing}} {{bg linearfade|color=204,100%,90%}}">
{{:Main Page/t/sectionbox|float=left|align=center|width=25%|
<h3>Welcome to the Virtual Paradise wiki</h3>
A publicly editable resource of '''{{NUMBEROFARTICLES}} articles''' related to the '''Virtual Paradise''' platform and friends.
}}

{{:Main Page/t/sectionbox|margin-left=26%|
[[Image:Blizzard GZ.jpg|128px|right|Ground zero of Blizzard world]]
<h3>What is Virtual Paradise?</h3>
''From the [http://virtualparadise.org official website]:'' '''Virtual Paradise''' is an online virtual universe consisting of several 3D [[:Category:Worlds|worlds]]. In each world you can chat with others, create your own [[:Category:Buildings and structures|buildings]] and explore the environments built by other [[List of citizens|users]] of Virtual Paradise.
----
'''Latest client version:''' [[Changelog|0.3.41]] {{*}} '''Download now:''' [http://virtualparadise.org/downloads/virtualparadise_0.3.38_windows_x86.zip Windows] - [http://virtualparadise.org/downloads/virtualparadise_0.3.38_mac_x86.dmg MacOS X] - Ubuntu [http://virtualparadise.org/downloads/virtualparadise_0.3.38_i386.deb x86]/[http://virtualparadise.org/downloads/virtualparadise_0.3.38_x86_64.deb x64]{{clear}}
}}
{{clear}}
</div>


<div style="width: 100%; padding: 8px 16px 16px 16px; margin: 0 auto; {{box-sizing}} background: hsla(204,100%,86%,1); border-radius: 0px 0px 16px 16px;">
{{:Main Page/t/sectionbox|float=left|width=25%|{{:Main Page/section/sidebar}}}}

{{:Main Page/t/sectionbox|margin-left=26%|
{{:Main Page/t/subsectionbox|padding-right=16px|{{:Main Page/section/Programmers}}}}
{{:Main Page/t/subsectionbox|{{:Main Page/section/External links}}}}
}}

{{:Main Page/t/sectionbox|margin-left=26%|
{{:Main Page/section/What's new}}
}}
{{clear}}
</div>
__NOTOC__

Vp wait

2014-04-24T08:45:37Z

Roy Curtis: + thread info

{{sdk method page|wait|Pumps incoming and outgoing network traffic and fires any registered events. Required for most in-world method calls (e.g. {{sdk method|say}}) and events to actually happen.
|paramex=1000
|parameters=
{{sdk parameter row|int|milliseconds|Maximum amount of time to pump (in milliseconds)}}
|returncodes=
{{sdk return code row|NOT_INITIALIZED|SDK not initialized with {{sdk method|init}} yet}}
|behavior=
* This will attempt to send all pending messages and receive all pending data within the given time limit
* All [[:Category:SDK events|SDK events]] are fired from this method call. Consequently, events are fired on the same thread as the caller.
* If a value of {{code|0}} is passed, it could still fire a number of different events
* If there is nothing to handle, it will wait until the time limit. 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. Doing so is undefined behavior and may break the internal SDK state. For example:
<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[100];
sprintf((char*)&message, "Hello, %s!", vp_string(sdk, VP_AVATAR_NAME));
vp_say(sdk, (char*)&message);
vp_wait(instance, 1000); // Undefined behavior
}
</C>
|seealso=
* {{sdk method|event_set}}
}}

Main Page/section/What's new

2014-03-24T15:49:23Z

Roy Curtis: removed unused events box

<div style="{{box-sizing}} display: inline-block; vertical-align: top; width: 100%">
==== Changelog ====
<div style="font-size: small; overflow: auto; height: 300px;">
{{:Changelog|toc=}}
</div>
</div>__NOTOC__

VP EVENT WORLD DISCONNECT

2013-10-06T19:53:19Z

Roy Curtis: added disconnect attribute

{{sdk event page|world_disconnect|Fired when the SDK is unexpectedly disconnected from the world server.
|attributes=
{{sdk attribute row|int|DISCONNECT_ERROR_CODE|Operating system's disconnect error code}}
|behavior=
* Will not fire if the client intentionally disconnects using {{sdk function|leave}} or {{sdk function|destroy}}
* Because the SDK maintains separate connections to the [[universe]] and [[world]] server, a {{sdk event|UNIVERSE_DISCONNECT}} will not fire this event also
|caveats=
|examples=
|seealso=
}}

VP EVENT UNIVERSE DISCONNECT

2013-10-06T19:53:02Z

Roy Curtis: added disconnect attribute

{{sdk event page|universe_disconnect|Fired when the SDK is unexpectedly disconnected from the [[universe]] server.
|attributes=
{{sdk attribute row|int|DISCONNECT_ERROR_CODE|Operating system's disconnect error code}}
|behavior=
* Will not fire if the client intentionally disconnects using {{sdk function|destroy}}
* Because the SDK maintains separate connections to the [[universe]] and [[world]] server, a {{sdk event|WORLD_DISCONNECT}} will not fire as a result of this event
|caveats=
|examples=
|seealso=
}}

Vp url send

2013-10-06T18:41:03Z

Roy Curtis: Created page with "{{sdk method page|url_send|Sends a URL to a client for them to open in a web browser. |version=0.3.37 |paramex=session, url, target |parameters= {{sdk parameter row|int |s..."

{{sdk method page|url_send|Sends a URL to a client for them to open in a web browser.
|version=0.3.37
|paramex=session, url, target
|parameters=
{{sdk parameter row|int |session|Target session ID}}
{{sdk parameter row|string|url |URL to open}}
{{sdk parameter row|int |target |Target container to open the URL in}}
|returncodes=
{{sdk return code row|NOT_INITIALIZED|SDK not initialized with {{sdk method|init}} yet}}
|behavior=
* See {{sdk attribute|url_target}} for valid targets to use
}}

Vp object get

2013-10-06T18:36:07Z

Roy Curtis: Created page with "{{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}..."

{{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}}
|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}}
}}

VP URL TARGET

2013-10-06T18:27:34Z

Roy Curtis: rough page for new feature

This int attribute may be any of the following enumeration values from {{code|vp_url_target_t}}:

* {{code|VP_URL_TARGET_BROWSER}} - The client (e.g. the [[browser]]) should open the URL in an external browser
* {{code|VP_URL_TARGET_OVERLAY}} - The client (e.g. the [[browser]]) should open the URL on top of the 3D viewport

VP EVENT URL

2013-10-06T18:25:29Z

Roy Curtis: corrected attr type

{{sdk event page|url|A request for the receiving client to open a [http://en.wikipedia.org/wiki/URL URL].
|version=0.3.37
|attributes=
{{sdk attribute row|int |avatar_session|Source session ID of the URL request}}
{{sdk attribute row|int |url_target |Target container to open the URL in}}
{{sdk attribute row|string|url |URL to open}}
|behavior=
* If {{sdk attribute|url}} is a blank string, it should be assumed that the client close the web view for the specified target
}}

VP EVENT URL

2013-10-06T18:25:06Z

Roy Curtis: new .37 event

{{sdk event page|url|A request for the receiving client to open a [http://en.wikipedia.org/wiki/URL URL].
|version=0.3.37
|attributes=
{{sdk attribute row|int |avatar_session|Source session ID of the URL request}}
{{sdk attribute row|string|url |URL to open}}
{{sdk attribute row|string|url_target |Target container to open the URL in}}
|behavior=
* If {{sdk attribute|url}} is a blank string, it should be assumed that the client close the web view for the specified target
}}

VP EVENT TELEPORT

2013-10-06T18:18:05Z

Roy Curtis: minor space fix

{{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=
{{sdk attribute row|int |avatar_session|Source session ID of the teleport request}}
{{sdk attribute row|float |teleport_x |Destination X coordinate}}
{{sdk attribute row|float |teleport_y |Destination Y coordinate}}
{{sdk attribute row|float |teleport_z |Destination Z coordinate}}
{{sdk attribute row|float |teleport_pitch|Destination pitch rotation}}
{{sdk attribute row|float |teleport_yaw |Destination yaw rotation}}
{{sdk attribute row|string|teleport_world|Destination world}}
|behavior=
* If {{sdk attribute|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 is a minimal program example which contains no error checking''
<c>
#include <vpsdk/VP.h>
#include <stdio.h>
#include <stdlib.h>

#define Username "User"
#define Password "1234"
#define World "VP-Build"

VPInstance sdk;

int main(int argc, char ** argv)
{
vp_init(VPSDK_VERSION);

sdk = vp_create();

vp_connect_universe(sdk, "universe.virtualparadise.org", 57000);
vp_login(sdk, Username, Password, "VPBot");
vp_enter(sdk, World);
vp_state_change(sdk);
vp_event_set(sdk, VP_EVENT_TELEPORT, on_teleport);

while(vp_wait(sdk, 1000) == 0){}
return 0;
}

void event_teleport(VPInstance sdk)
{
// Only teleports to given coordinates and rotation, not world
// To teleport, we need to set our MY_* attributes to given teleport
// attributes and change state
vp_float_set(sdk, VP_MY_X, vp_float(sdk, VP_TELEPORT_X));
vp_float_set(sdk, VP_MY_Y, vp_float(sdk, VP_TELEPORT_Y));
vp_float_set(sdk, VP_MY_Z, vp_float(sdk, VP_TELEPORT_Z));
vp_float_set(sdk, VP_MY_PITCH, vp_float(sdk, VP_TELEPORT_PITCH));
vp_float_set(sdk, VP_MY_YAW, vp_float(sdk, VP_TELEPORT_YAW));

vp_state_change(sdk);
}
</c>
|seealso=
}}

Vp console message

2013-10-05T21:22:56Z

Roy Curtis: draft commit

{{sdk method page|console_message|Makes a bot send a custom named and/or formatted message to the [[world]] or a specific session in-world.
|paramex=session, name, message, effects, red, green, blue
|parameters=
{{sdk parameter row|int |session|Target session}}
{{sdk parameter row|string|name |Name to attach to the message}}
{{sdk parameter row|string|message|Message body}}
{{sdk parameter row|int |effects|Bitfield of message formatting}}
{{sdk parameter row|uchar |red |Message color red value}}
{{sdk parameter row|uchar |green |Message color green value}}
{{sdk parameter row|uchar |blue |Message color blue value}}
|returncodes=
{{sdk return code row|NOT_INITIALIZED|SDK not initialized with {{sdk method|init}} yet}}
{{sdk return code row|NOT_IN_WORLD |Bot is not currently in a world}}
{{sdk return code row|STRING_TOO_LONG|Name or message exceeds 255 characters in length}}
|behavior=
|caveats=
|seealso=
* {{sdk method|chat}}
}}

Template:Sdk parameter

2013-10-05T17:52:45Z

Roy Curtis: descbytype

<span title="A method parameter of the {{descbytype|{{{1|int}}}}} type" style="font-family: Courier, monospace;"><div style="border-left: solid 4px hsl({{huebytype|{{{1|int}}}}},100%,60%); border-bottom: dotted 1px hsl({{huebytype|{{{1|int}}}}},100%,60%); display: inline-block; text-align: right; font-weight: bold; width: 90px;">{{{1|int}}}</div> {{{2|???}}}</span><noinclude>[[Category:Formatting templates]]</noinclude>

Template:Huebytype

2013-10-05T17:52:34Z

Roy Curtis: fixed def

{{#switch: {{{1|int}}}
| data = 320
| int = 200
| float = 260
| string = 0
| bool = 160
| VPInstance = 35
| uchar = 230
| 200
}}<noinclude>[[Category:Formatting templates]]</noinclude>

Template:Descbytype

2013-10-05T17:52:20Z

Roy Curtis: fixed def

{{#switch: {{{1|int}}}
| string = C null-terminated string
| uchar = C unsigned int
| {{{1|int}}}
}}<noinclude>[[Category:Formatting templates]]</noinclude>

Template:Descbytype

2013-10-05T17:51:43Z

Roy Curtis: Created page with "{{#switch: {{{1|int}}} | string = C null-terminated string | uchar = C unsigned int | default {{{1|int}}} }}<noinclude>Category:Formatting templates</noinclude>"

{{#switch: {{{1|int}}}
| string = C null-terminated string
| uchar = C unsigned int
| default {{{1|int}}}
}}<noinclude>[[Category:Formatting templates]]</noinclude>

Template:Huebytype

2013-10-05T17:48:13Z

Roy Curtis: added uchar

{{#switch: {{{1|int}}}
| data = 320
| int = 200
| float = 260
| string = 0
| bool = 160
| VPInstance = 35
| uchar = 230
| default 200
}}<noinclude>[[Category:Formatting templates]]</noinclude>

Vp say

2013-09-30T15:27:38Z

Roy Curtis: Created page with "{{sdk method page|say|Makes a bot say a message in the current world's chat channel. |paramex=message |parameters= {{sdk parameter row|string|message|Chat message}} |ret..."

{{sdk method page|say|Makes a bot say a message in the current [[world]]'s chat channel.
|paramex=message
|parameters=
{{sdk parameter row|string|message|Chat message}}
|returncodes=
{{sdk return code row|NOT_INITIALIZED|SDK not initialized with {{sdk method|init}} yet}}
{{sdk return code row|NOT_IN_WORLD |Bot is not currently in a world}}
{{sdk return code row|STRING_TOO_LONG|Chat message exceeds 255 characters in length}}
|behavior=
Like normal chat from other users, the message will appear in the [[browser]] with standard black text formatting.
|caveats=
The bot will not hear itself speak; it will not receive a {{sdk event|CHAT}} event for its own message.
|seealso=
* {{sdk method|console_message}}
}}

Vp login

2013-09-30T15:23:26Z

Roy Curtis: clarification

{{sdk method page|login|Logs in a bot to the [[universe]] server, using the credentials of an existing account.
|paramex=username, password, botname
|parameters=
{{sdk parameter row|string|username|Username of the account to log into}}
{{sdk parameter row|string|password|Password of the account to log into}}
{{sdk parameter row|string|botname |Desired name for the bot to use}}
|returncodes=
{{sdk return code row|NOT_INITIALIZED|SDK not initialized with {{sdk method|init}} yet}}
{{sdk return code row|INVALID_LOGIN |The login credentials are incorrect}}
{{sdk return code row|STRING_TOO_LONG|If any of the given string parameters exceed 255 characters in length}}
|behavior=
* 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 bots
|caveats=To log out from a universe, {{sdk method|destroy}} must be called which will also disconnect the bot from the universe.
|seealso=
* {{sdk method|destroy}}
* {{sdk method|enter}}
}}

Vp login

2013-09-30T15:23:06Z

Roy Curtis: added RC

{{sdk method page|login|Logs in a bot to the [[universe]] server, using the credentials of an existing account.
|paramex=username, password, botname
|parameters=
{{sdk parameter row|string|username|Username of the account to log into}}
{{sdk parameter row|string|password|Password of the account to log into}}
{{sdk parameter row|string|botname |Desired name for the bot to use}}
|returncodes=
{{sdk return code row|NOT_INITIALIZED|SDK not initialized with {{sdk method|init}} yet}}
{{sdk return code row|INVALID_LOGIN |The login credentials are incorrect}}
{{sdk return code row|STRING_TOO_LONG|If any of the given parameters exceed 255 characters in length}}
|behavior=
* 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 bots
|caveats=To log out from a universe, {{sdk method|destroy}} must be called which will also disconnect the bot from the universe.
|seealso=
* {{sdk method|destroy}}
* {{sdk method|enter}}
}}

Vp leave

2013-09-30T15:16:42Z

Roy Curtis: fixed def

{{sdk method page|leave|Makes a bot leave its current [[world]].
|returncodes=
{{sdk return code row|NOT_INITIALIZED|SDK not initialized with {{sdk method|init}} yet}}
{{sdk return code row|NOT_IN_WORLD |Bot is not currently in a world}}
|caveats=
This does not need to be called to move a bot to another world, as {{sdk method|enter}} will do that automatically.
|seealso=
* {{sdk method|enter}}
* {{sdk method|destroy}}
}}

Vp leave

2013-09-30T15:13:14Z

Roy Curtis: Created page with "{{sdk method page|leave|Makes a bot leave its current world. |returncodes= {{sdk return code row|NOT_INITIALIZED|SDK not initialized with {{sdk method|init}} yet}} {{s..."

{{sdk method page|leave|Makes a bot leave its current [[world]].
|returncodes=
{{sdk return code row|NOT_INITIALIZED|SDK not initialized with {{sdk method|init}} yet}}
{{sdk return code row|NOT_IN_WORLD |No such world is connected to the [[universe]]}}
|caveats=
This does not need to be called to move a bot to another world, as {{sdk method|enter}} will do that automatically.
|seealso=
* {{sdk method|enter}}
* {{sdk method|destroy}}
}}

Vp enter

2013-09-30T15:08:59Z

Roy Curtis: Created page with "{{sdk method page|enter|Enters a bot into a world. |paramex=world |parameters= {{sdk parameter row|string|world|Name of an online world to enter}} |returncodes= {{sdk ..."

{{sdk method page|enter|Enters a bot into a [[world]].
|paramex=world
|parameters=
{{sdk parameter row|string|world|Name of an online world to enter}}
|returncodes=
{{sdk return code row|NOT_INITIALIZED |SDK not initialized with {{sdk method|init}} yet}}
{{sdk return code row|CONNECTION_ERROR |Error connecting to the world server}}
{{sdk return code row|TIMEOUT |Connection attempt to the world server timed out (e.g. firewalled server)}}
{{sdk return code row|WORLD_NOT_FOUND |No such world is connected to the [[universe]]}}
{{sdk return code row|WORLD_LOGIN_ERROR|Could not login to world (e.g. incorrect world address configured) or banned (not yet implemented)}}
|behavior=
* If the bot was already in a world, it will automatically leave that world
|caveats=
The bot will not have a visible "presence" in the world (e.g. will not appear to other users or bots') until {{sdk method|state_change}} is called at least once.
|seealso=
* {{sdk method|state_change}}
* {{sdk method|leave}}
}}

Vp init

2013-09-30T15:02:20Z

Roy Curtis: added seealso

{{sdk method page|init|Initializes the Virtual Paradise SDK, which is required before calling any other method of the SDK.
|customparam={{sdk parameter|int|version}}
|customparamex=VP_BUILD
|noinstanceparam=
|parameters=
{{sdk parameter row|int|version|{{code|VP_BUILD}} in VP.h defines the build of the SDK library}}
|behavior=
This only has to be called once for every application. 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=
<C>
int rc;
if(rc = vp_init(VP_BUILD))
printf("Error initializing VP API (reason %d)\n", rc);
</C>
|seealso=
* {{sdk method|create}}
}}

Vp login

2013-09-30T15:01:58Z

Roy Curtis: method templates

{{sdk method page|login|Logs in a bot to the [[universe]] server, using the credentials of an existing account.
|paramex=username, password, botname
|parameters=
{{sdk parameter row|string|username|Username of the account to log into}}
{{sdk parameter row|string|password|Password of the account to log into}}
{{sdk parameter row|string|botname |Desired name for the bot to use}}
|returncodes=
{{sdk return code row|NOT_INITIALIZED|SDK not initialized with {{sdk method|init}} yet}}
{{sdk return code row|INVALID_LOGIN |The login credentials are incorrect}}
|behavior=
* 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 bots
|caveats=To log out from a universe, {{sdk method|destroy}} must be called which will also disconnect the bot from the universe.
|seealso=
* {{sdk method|destroy}}
* {{sdk method|enter}}
}}

Vp create

2013-09-30T15:01:28Z

Roy Curtis: method templates

{{sdk method page|create|Creates a VPInstance in memory for use with connecting to a world or universe.|customparam=
|customparamex=
|noinstanceparam=
|returns=A pointer to the newly created instance, or {{code|NULL}} if something went wrong whilst trying to create one.
|examples=
<C>VPInstance instance;
instance = vp_create();</C>
|seealso=
* {{sdk method|connect_universe}}
* {{sdk method|destroy}}
* {{sdk method|login}}
}}

Vp connect universe

2013-09-30T15:01:01Z

Roy Curtis: method templates

{{sdk method page|connect_universe|Connects an instance to a [[universe]] server. Required before an instance log in with user credentials and connects to any world.
|paramex="universe.virtualparadise.org", 57000
|parameters=
{{sdk parameter row|string|host|Hostname of uniserver; typically {{code|"universe.virtualparadise.org"}}}}
{{sdk parameter row|int |port|Port of uniserver; typically {{code|57000}}}}
|returncodes=
{{sdk return code row|NOT_INITIALIZED|SDK not initialized with {{sdk method|init}} yet}}
{{sdk return code row|CONNECTION_ERROR|Error connecting to the universe server}}
|caveats=To disconnect from a universe, {{sdk method|destroy}} must be called.
|examples=
<C>
int rc;
if(rc = vp_connect_universe(instance, "universe.virtualparadise.org", 57000))
printf("Error connecting to universe (reason %d)\n", rc);
</C>
|seealso=
* {{sdk method|destroy}}
* {{sdk method|login}}
}}

Vp destroy

2013-09-30T15:00:43Z

Roy Curtis: method templates

{{sdk method page|destroy|Destroys an existing VPInstance.
|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.
|seealso=
* {{sdk method|create}}
}}