vp_avatar_click

From Virtual Paradise Wiki
Revision as of 21:13, 31 July 2018 by Sleepy E (talk | contribs) (Fixed typos and incorrect call snippet)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Method call snippet vp_avatar_click(instance, avatar_session);

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

Parameters

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

Used attributes

This method uses data set in these attributes when called:

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

Returns

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

Behavior

Examples

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

See also