Vp avatar click: Difference between revisions

Latest revision as of 21:13, 31 July 2018

Method call snippet vp_avatar_click(instance, avatar_session);

Send an avatar click event to other users in the world.

These are the parameters that this method requires:

Parameter	Usage
VPInstance instance	Pointer to the instance this method call is intended for
int avatar_session	The session id of the clicked avatar

This method uses data set in these attributes when called:

Attribute	Usage
float VP_CLICK_HIT_X	X coordinate of hit (world coordinates)
float VP_CLICK_HIT_Y	Y coordinate of hit (world coordinates)
float VP_CLICK_HIT_Z	Z coordinate of hit (world coordinates)

This method returns a return code integer, which indicates whether the call was successful or errored for any reason:

Return code	Cause
`VP_RC_SUCCESS`	Successful call (for methods that have a registered callback, it only means the request has been sent)
`VP_RC_NOT_IN_WORLD`	World request made while not connected to a world server

Upon successfully clicking an avatar, VP_EVENT_AVATAR_CLICK is sent to those who have subscribed to it. See vp_event_set().

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

@@ Line 1: / Line 1: @@
 {{sdk method page|avatar_click|Send an avatar click event to other users in the world.
-|paramex=object_id, session_to, hit_x, hit_y, hit_z
+|paramex=avatar_session
 |parameters=
    {{sdk parameter row|int   |avatar_session |The session id of the clicked avatar}}
 |attributes=
-   {{sdk attribute row|float |VP_CLICK_HIT_X |X coordinate of hit (world coordinates)}}
+   {{sdk attribute row|float |CLICK_HIT_X |X coordinate of hit (world coordinates)}}
-   {{sdk attribute row|float |VP_CLICK_HIT_Y |Y coordinate of hit (world coordinates)}}
+   {{sdk attribute row|float |CLICK_HIT_Y |Y coordinate of hit (world coordinates)}}
-   {{sdk attribute row|float |VP_CLICK_HIT_Z |Z 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 |Bot is not currently in a world}}
+   {{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}}.