vp_friend_add_by_name

From Virtual Paradise Wiki
Revision as of 12:52, 13 December 2016 by Sleepy E (talk | contribs)
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

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)

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