User:Roy Curtis/sample/SDK method

Method call snippet vp_sdk_method(instance, intValue, stringValue, floatValue, boolValue);

Makes the SDK do something either to the VP universe, world or local state.

Parameters

These are the parameters that this method requires:

Parameter	Usage
VPInstance instance	Pointer to the instance this method call is intended for

Used attributes

This method uses data set in these attributes when called:

Attribute	Usage
int VP_INT_VALUE	Used int value sent to server
float VP_FLOAT_VALUE	Used float value sent to server
string VP_STRING_VALUE	Used string value sent to server
data VP_DATA_VALUE	Used data value sent to server

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

• This is the behavior of this SDK event (e.g. when and why it is sent)

Caveats

• This is a common pitfall, missing expected functionality or otherwise something to look out for when using this event

Examples

This is where a minimal example would go for using this event

See also

• Related SDK events
• Related SDK stuff