vp_friend_add_by_name

From Virtual Paradise Wiki
Revision as of 23:24, 31 July 2018 by Sleepy E (talk | contribs) (Added reference number attribute, reason code)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Method call snippet vp_friend_add_by_name(instance, name);

Add a user to 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
string
name
Name of user to add

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

Behavior

  • Upon successfully adding a user, VP_EVENT_FRIEND is triggered if the bot has subscribed to it.

Examples

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

See also