Vp friend delete: Difference between revisions

From Virtual Paradise Wiki
Jump to navigation Jump to search
Sleepy E (talk | contribs)
m Added missing reason code
Sleepy E (talk | contribs)
mNo edit summary
Line 5: Line 5:
|attributes=
|attributes=
|returncodes=
|returncodes=
   {{sdk return code row|not_in_universe|Universe request made while not connected to a universe server
   {{sdk return code row|not_in_universe|Universe request made while not connected to a universe server}}
|returnattributes=
|returnattributes=
|behavior=
|behavior=

Revision as of 21:00, 31 July 2018

Method call snippet vp_friend_delete(instance, friend_user_id);

Delete a user from the friend list.

Parameters

These are the parameters that this method requires:

Parameter Usage
VPInstance
instance
Pointer to the instance this method call is intended for
int
friend_user_id
User id of user to delete

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 Universe request made while not connected to a universe server

Behavior

There is no special behavior for this method

Examples

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

See also