vp_double_get

From Virtual Paradise Wiki
Jump to navigation Jump to search
Method call snippet vp_double_get(instance, attr, value);

Return the value of a floating point attribute (with double-precision).

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 return value of (defined in VP.h)
float*
value
Returns the value

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

If unsuccessful, then value is not modified.

Examples

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

See also