Vp float set: Difference between revisions

From Virtual Paradise Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
|paramex=attr, value
|paramex=attr, value
|parameters=
|parameters=
   {{sdk parameter row|vp_int_attribute_t |attr  |Attribute to set value of (defined in VP.h)}}
   {{sdk parameter row|vp_float_attribute_t |attr  |Attribute to set value of (defined in VP.h)}}
   {{sdk parameter row|float             |value |Value to set}}
   {{sdk parameter row|float               |value |Value to set}}
|returncodes=
|returncodes=
   {{sdk return code row|NO_SUCH_ATTRIBUTE  |Invalid attribute}}
   {{sdk return code row|NO_SUCH_ATTRIBUTE  |Invalid attribute}}
Line 10: Line 10:
|examples=
|examples=
<syntaxhighlight lang="c">
<syntaxhighlight lang="c">
void move_avatar(VPInstance sdk, float x, float y, floay z)
void move_avatar(VPInstance sdk, float x, float y, float z)
{
{
   vp_float_set(sdk, VP_MY_X, x);
   vp_float_set(sdk, VP_MY_X, x);

Latest revision as of 20:32, 14 December 2016

Method call snippet vp_float_set(instance, attr, value);

Set the value of a floating point attribute.

Parameters

These are the parameters that this method requires:

Parameter Usage
VPInstance
instance
Pointer to the instance this method call is intended for
vp_float_attribute_t
attr
Attribute to set value of (defined in VP.h)
float
value
Value to set

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_NO_SUCH_ATTRIBUTE Invalid attribute

Behavior

There is no special behavior for this method

Caveats

When higher precision is desired, use vp_double_set().

Examples

void move_avatar(VPInstance sdk, float x, float y, float z)
{
  vp_float_set(sdk, VP_MY_X, x);
  vp_float_set(sdk, VP_MY_Y, y);
  vp_float_set(sdk, VP_MY_Z, z);
  vp_state_change(sdk);
}

See also