Vp state change: Difference between revisions

From Virtual Paradise Wiki
Jump to navigation Jump to search
(Basic layout)
 
mNo edit summary
 
Line 8: Line 8:
   {{sdk attribute row|int  |MY_TYPE  |Avatar type}}
   {{sdk attribute row|int  |MY_TYPE  |Avatar type}}
|returncodes=
|returncodes=
   {{sdk return code row|RC_NOT_IN_WORLD|Bot is not currently in a world}}
   {{sdk return code row|NOT_IN_WORLD|Bot is not currently in a world}}
|behavior=
|behavior=
|caveats=
|caveats=

Latest revision as of 22:08, 13 December 2016

Method call snippet vp_state_change(instance);

Update bot avatar.

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
VP_MY_X X coordinate
VP_MY_Y Y coordinate
VP_MY_Z Z coordinate
VP_MY_YAW Yaw
VP_MY_PITCH Pitch
VP_MY_TYPE Avatar type

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_WORLD Bot is not currently in a world

Behavior

There is no special behavior for this method

Examples

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