Vp join: Difference between revisions

From Virtual Paradise Wiki
Jump to navigation Jump to search
Sleepy E (talk | contribs)
m Test
Sleepy E (talk | contribs)
m Added reference number attribute
 
Line 3: Line 3:
|parameters=
|parameters=
   {{sdk parameter row|int|user_id|User id}}
   {{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=
|returncodes=
   {{sdk return code row|NOT_IN_UNIVERSE|Bot is not currently in the universe}}
   {{sdk return code row|NOT_IN_UNIVERSE|Bot is not currently in the universe}}

Latest revision as of 23:31, 31 July 2018

Method call snippet vp_join(instance, user_id);

Send a join request to a user.

Parameters

These are the parameters that this method requires:

Parameter Usage
VPInstance
instance
Pointer to the instance this method call is intended for
int
user_id
User id

Used attributes

This method uses data set in these attributes when called:

Attribute Usage
VP_REFERENCE_NUMBER Is passed to the callback to identify for which method call it is fired

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_UNIVERSE Bot is not currently in the universe
VP_RC_JOIN_DECLINED Join request was declined
VP_RC_TIMEOUT Join request timeout (no accept/decline within 30 seconds)

The following attributes will be returned in VP_CALLBACK_JOIN if the operation was successful:

Attribute Usage Also returned for
VP_JOIN_ID Join id VP_RC_JOIN_DECLINED
VP_USER_ID User id VP_RC_JOIN_DECLINED
VP_JOIN_NAME Name of user VP_RC_JOIN_DECLINED and VP_RC_TIMEOUT
VP_JOIN_X User x coordinate
VP_JOIN_Y User y coordinate
VP_JOIN_Z User z coordinate
VP_JOIN_YAW User yaw angle
VP_JOIN_PITCH User pitch angle
VP_JOIN_WORLD World that user is in

Behavior

Examples

   ...

See also