VPSDK
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
VP.h
Go to the documentation of this file.
1 #ifndef __VP_SDK
2 #define __VP_SDK
3 
4 #if defined(WIN32) || defined(UNDER_CE)
5 # ifdef VPSDK_EXPORTS
6 # ifdef VPSDK_STATIC
7 # define VPSDK_API extern "C"
8 # else
9 # define VPSDK_API extern "C" __declspec(dllexport)
10 # endif
11 # else
12 # ifdef __cplusplus
13 # ifdef VPSDK_STATIC
14 # define VPSDK_API extern "C"
15 # else
16 # define VPSDK_API extern "C" __declspec(dllimport)
17 # endif
18 # else
19 # ifdef VPSDK_STATIC
20 # define VPSDK_API extern
21 # else
22 # define VPSDK_API __declspec(dllimport)
23 # endif
24 # endif
25 # endif
26 #else
27 # if defined(VPSDK_EXPORTS) && (__GNUC__ >= 4)
28 # ifdef __cplusplus
29 # define VPSDK_API extern "C" __attribute__ ((visibility ("default")))
30 # else
31 # define VPSDK_API extern __attribute__ ((visibility ("default")))
32 # endif
33 # else
34 # ifdef __cplusplus
35 # define VPSDK_API extern "C"
36 # else
37 # define VPSDK_API extern
38 # endif
39 # endif
40 #endif
41 
42 /* API Version */
43 #define VPSDK_VERSION 2
44 
48 typedef enum vp_event_t
49 {
59  VP_EVENT_CHAT,
73  VP_EVENT_AVATAR_ADD,
86  VP_EVENT_AVATAR_CHANGE,
94  VP_EVENT_AVATAR_DELETE,
114  VP_EVENT_OBJECT,
134  VP_EVENT_OBJECT_CHANGE,
135 
143  VP_EVENT_OBJECT_DELETE,
144 
154  VP_EVENT_OBJECT_CLICK,
155 
164  VP_EVENT_WORLD_LIST,
165 
171  VP_EVENT_WORLD_SETTING,
172 
177  VP_EVENT_WORLD_SETTINGS_CHANGED,
178 
179  VP_EVENT_FRIEND,
180 
185  VP_EVENT_WORLD_DISCONNECT,
186 
191  VP_EVENT_UNIVERSE_DISCONNECT,
192 
202  VP_EVENT_USER_ATTRIBUTES,
203 
209  VP_EVENT_CELL_END,
210 
220  VP_EVENT_TERRAIN_NODE,
221 
230  VP_EVENT_AVATAR_CLICK,
231 
242  VP_EVENT_TELEPORT,
243 
250  VP_EVENT_URL,
251 
257  VP_EVENT_OBJECT_BUMP_BEGIN,
258 
264  VP_EVENT_OBJECT_BUMP_END,
265 
266  VP_HIGHEST_EVENT
267 } vp_event_t;
268 
269 typedef enum vp_callback_t
270 {
274  VP_CALLBACK_OBJECT_ADD,
278  VP_CALLBACK_OBJECT_CHANGE,
282  VP_CALLBACK_OBJECT_DELETE,
283  VP_CALLBACK_GET_FRIENDS,
284  VP_CALLBACK_FRIEND_ADD,
285  VP_CALLBACK_FRIEND_DELETE,
286  VP_CALLBACK_TERRAIN_QUERY,
287  VP_CALLBACK_TERRAIN_NODE_SET,
288 
313  VP_CALLBACK_OBJECT_GET,
314  VP_HIGHEST_CALLBACK
315 } vp_callback_t;
316 
317 /* Ints */
318 typedef enum vp_int_attribute_t
319 {
320  VP_AVATAR_SESSION,
321  VP_AVATAR_TYPE,
322  VP_MY_TYPE,
323 
324  VP_OBJECT_ID,
325  VP_OBJECT_TYPE,
326  VP_OBJECT_TIME,
327  VP_OBJECT_USER_ID,
328 
329  VP_WORLD_STATE,
330  VP_WORLD_USERS,
331 
332  VP_REFERENCE_NUMBER,
333  VP_CALLBACK,
334 
335  VP_USER_ID,
336  VP_USER_REGISTRATION_TIME,
337  VP_USER_ONLINE_TIME,
338  VP_USER_LAST_LOGIN,
339 
340  VP_FRIEND_ID,
341  VP_FRIEND_USER_ID,
342  VP_FRIEND_ONLINE,
343 
344  VP_MY_USER_ID,
345  VP_PROXY_TYPE,
346  VP_PROXY_PORT,
347 
348  VP_CELL_X,
349  VP_CELL_Z,
350 
351  VP_TERRAIN_TILE_X,
352  VP_TERRAIN_TILE_Z,
353  VP_TERRAIN_NODE_X,
354  VP_TERRAIN_NODE_Z,
355  VP_TERRAIN_NODE_REVISION,
356 
357  VP_CLICKED_SESSION,
358 
359  VP_CHAT_TYPE,
360  VP_CHAT_COLOR_RED,
361  VP_CHAT_COLOR_GREEN,
362  VP_CHAT_COLOR_BLUE,
363  VP_CHAT_EFFECTS,
364 
365  VP_DISCONNECT_ERROR_CODE,
366 
367  VP_URL_TARGET,
368  VP_CURRENT_EVENT,
369  VP_CURRENT_CALLBACK,
370 
371  VP_HIGHEST_INT
372 } vp_int_attribute_t;
373 
374 /* Floats */
375 typedef enum vp_float_attribute_t
376 {
377  VP_AVATAR_X,
378  VP_AVATAR_Y,
379  VP_AVATAR_Z,
380  VP_AVATAR_YAW,
381  VP_AVATAR_PITCH,
382 
383  VP_MY_X,
384  VP_MY_Y,
385  VP_MY_Z,
386  VP_MY_YAW,
387  VP_MY_PITCH,
388 
389  VP_OBJECT_X,
390  VP_OBJECT_Y,
391  VP_OBJECT_Z,
392  VP_OBJECT_ROTATION_X,
393  VP_OBJECT_ROTATION_Y,
394  VP_OBJECT_ROTATION_Z,
399  VP_OBJECT_YAW = VP_OBJECT_ROTATION_X,
404  VP_OBJECT_PITCH = VP_OBJECT_ROTATION_Y,
409  VP_OBJECT_ROLL = VP_OBJECT_ROTATION_Z,
410  VP_OBJECT_ROTATION_ANGLE,
411 
412  VP_TELEPORT_X,
413  VP_TELEPORT_Y,
414  VP_TELEPORT_Z,
415  VP_TELEPORT_YAW,
416  VP_TELEPORT_PITCH,
417 
418  VP_CLICK_HIT_X,
419  VP_CLICK_HIT_Y,
420  VP_CLICK_HIT_Z,
421 
422  VP_HIGHEST_FLOAT
423 } vp_float_attribute_t;
424 
425 /* Strings */
426 typedef enum vp_string_attribute_t
427 {
428  VP_AVATAR_NAME,
429  VP_CHAT_MESSAGE,
430 
431  VP_OBJECT_MODEL,
432  VP_OBJECT_ACTION,
433  VP_OBJECT_DESCRIPTION,
434 
435  VP_WORLD_NAME,
436 
437  VP_USER_NAME,
438  VP_USER_EMAIL,
439 
440  VP_WORLD_SETTING_KEY,
441  VP_WORLD_SETTING_VALUE,
442 
443  VP_FRIEND_NAME,
444  VP_PROXY_HOST,
445 
446  VP_TELEPORT_WORLD,
447 
448  VP_URL,
449 
450  VP_HIGHEST_STRING
451 } vp_string_attribute_t;
452 
453 /* Data */
454 typedef enum vp_data_attribute_t
455 {
456  VP_OBJECT_DATA,
457  VP_TERRAIN_NODE_DATA,
458  VP_HIGHEST_DATA
459 } vp_data_attribute_t;
460 
464 typedef enum vp_proxy_type_t {
465  VP_PROXY_TYPE_NONE,
466  VP_PROXY_TYPE_SOCKS4A
467 } vp_proxy_type_t;
468 
469 typedef enum vp_url_target_t {
470  VP_URL_TARGET_BROWSER,
471  VP_URL_TARGET_OVERLAY
472 } vp_url_target_t;
473 
474 #ifdef __cplusplus
475 namespace vpsdk {
476  struct VPInstance_;
477 }
478 
479 typedef vpsdk::VPInstance_ *vp_instance_t;
480 #else
481 typedef void* vp_instance_t;
482 #endif
483 
484 typedef vp_instance_t VPInstance;
485 
486 typedef void(*VPEventHandler)(VPInstance);
487 typedef void(*VPCallbackHandler)(VPInstance, int, int);
488 
489 typedef struct vp_terrain_cell_t {
490  float height;
491 
492  /* 1 bit visibility, 2 bits rotation, 1 bit padding, 12 bits texture */
493  unsigned short attributes;
494 } vp_terrain_cell_t;
495 
496 #define VP_PACK_TERRAIN_ATTRIBUTES(tex, rotation, visible) ((tex & 0x1FFF) | \
497  (visible << 15) | \
498  (rotation << 13))
499 
500 #define VP_UNPACK_TERRAIN_VISIBILITY(x) ((x & 0x8000) >> 15)
501 #define VP_UNPACK_TERRAIN_ROTATION(x) ((x & 0x6000) >> 13)
502 #define VP_UNPACK_TERRAIN_TEXTURE(x) (x & 0x0FFF)
503 
507 enum vp_chat_type {
508  VP_CHAT_NORMAL,
509  VP_CHAT_CONSOLE_MESSAGE,
510  VP_CHAT_PRIVATE
511 };
512 
516 enum vp_text_effect {
517  VP_TEXT_EFFECT_BOLD = 1,
518  VP_TEXT_EFFECT_ITALIC = 2
519 };
520 
529 #ifdef __cplusplus
530 VPSDK_API int vp_init(int version=VPSDK_VERSION);
531 #else
532 VPSDK_API int vp_init(int version);
533 #endif
534 
539 VPSDK_API VPInstance vp_create(void);
540 
544 VPSDK_API int vp_destroy(VPInstance instance);
545 
553 VPSDK_API int vp_connect_universe(VPInstance instance, const char * host, int port);
554 
567 VPSDK_API int vp_login(VPInstance instance, const char * username, const char * password, const char * botname);
568 
576 VPSDK_API int vp_wait(VPInstance instance, int milliseconds);
577 
589 VPSDK_API int vp_enter(VPInstance instance, const char * worldname);
590 
596 VPSDK_API int vp_leave(VPInstance instance);
597 
605 VPSDK_API int vp_say(VPInstance instance, const char * message);
606 
620 VPSDK_API int vp_console_message(VPInstance instance,
621  int session,
622  const char* name,
623  const char* message,
624  int effects,
625  unsigned char red,
626  unsigned char green,
627  unsigned char blue);
628 
633 VPSDK_API int vp_event_set(VPInstance instance, vp_event_t eventname, VPEventHandler event);
634 
639 VPSDK_API int vp_callback_set(VPInstance instance, vp_callback_t callbackname, VPCallbackHandler callback);
640 
645 VPSDK_API void * vp_user_data(VPInstance instance);
646 
652 VPSDK_API void vp_user_data_set(VPInstance instance, void * data);
653 
667 VPSDK_API int vp_state_change(VPInstance instance);
668 
669 VPSDK_API int vp_int(VPInstance instance, vp_int_attribute_t name);
670 VPSDK_API float vp_float(VPInstance instance, vp_float_attribute_t name);
671 VPSDK_API const char* vp_string(VPInstance instance, vp_string_attribute_t name);
672 VPSDK_API const char* vp_data(VPInstance instance, vp_data_attribute_t name, int* length);
673 
674 VPSDK_API int vp_int_get(VPInstance instance, vp_int_attribute_t name, int* value);
675 VPSDK_API int vp_float_get(VPInstance instance, vp_float_attribute_t name, float* value);
676 VPSDK_API int vp_string_get(VPInstance instance, vp_string_attribute_t name, char** value);
677 
678 VPSDK_API int vp_int_set(VPInstance instance, vp_int_attribute_t name, int value);
679 VPSDK_API int vp_float_set(VPInstance instance, vp_float_attribute_t name, float value);
680 VPSDK_API void vp_string_set(VPInstance instance, vp_string_attribute_t name, const char * str);
681 VPSDK_API int vp_data_set(VPInstance instance, vp_data_attribute_t name, int length, char* data);
682 
688 VPSDK_API int vp_query_cell(VPInstance instance, int x, int z);
689 
707 VPSDK_API int vp_object_add(VPInstance instance);
708 
714 VPSDK_API int vp_object_bump_begin(vp_instance_t instance,
715  int object_id, int session_to);
716 
722 VPSDK_API int vp_object_bump_end(vp_instance_t instance,
723  int object_id, int session_to);
724 
743 VPSDK_API int vp_object_change(VPInstance instance);
744 
753 VPSDK_API int vp_object_click(VPInstance instance, int object_id,
754  int session_to, float hit_x,
755  float hit_y, float hit_z);
756 
761 VPSDK_API int vp_object_delete(VPInstance instance, int object_id);
762 
767 VPSDK_API int vp_object_get(VPInstance instance, int object_id);
768 
774 VPSDK_API int vp_world_list(VPInstance instance, int time);
775 
776 /* VPSDK_API void* vp_callback_pointer(VPInstance instance); */
777 /* VPSDK_API void vp_callback_pointer_set(VPInstance instance, void* ptr); */
778 
784 VPSDK_API int vp_user_attributes_by_id(VPInstance instance, int user_id);
785 
790 VPSDK_API int vp_user_attributes_by_name(VPInstance instance, const char * name);
791 
792 VPSDK_API int vp_friends_get(VPInstance instance);
793 VPSDK_API int vp_friend_add_by_name(VPInstance instance, const char* name);
794 VPSDK_API int vp_friend_delete(VPInstance instance, int friend_id);
795 
804 VPSDK_API int vp_terrain_query(VPInstance instance, int tile_x, int tile_z, int revision[][4]);
805 
816 VPSDK_API int vp_terrain_node_set(VPInstance instance,
817  int tile_x, int tile_z,
818  int node_x, int node_z,
819  struct vp_terrain_cell_t* cells);
820 
832 VPSDK_API int vp_avatar_click(VPInstance instance, int avatar_session);
833 
844 VPSDK_API int vp_teleport_avatar(VPInstance instance,
845  int target_session,
846  const char* world,
847  float x, float y, float z,
848  float yaw, float pitch);
849 
856 VPSDK_API int vp_url_send(VPInstance instance,
857  int session_id,
858  const char* url,
859  vp_url_target_t url_target);
860 
861 #endif
Generated on Sat Apr 26 2014 12:43:13 for VPSDK by   doxygen 1.8.2