vp_float

From Virtual Paradise Wiki
Revision as of 22:11, 13 December 2016 by Sleepy E (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Method call snippet vp_float(instance, attr);

Return 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 return value of (defined in VP.h)

Returns

The value of the attribute.

Behavior

If an invalid identifier is passed for attr, then 0 will be returned.

Caveats

There is no way to know if the call was unsuccessful, use vp_float_get() when this is required. Also, when higher precision is desired, use vp_double().

Examples

void handle_avatar_add(VPInstance sdk)
{
  float x, z;

  x = vp_float(sdk, VP_AVATAR_X);
  z = vp_float(sdk, VP_AVATAR_Z);

  // If an avatar appears at roughly 0X 0Z (at any height), then send a welcome message.
  if (x > -0.5 && x < 0.5 && y > -0.5 && y < 0.5)
  {
    char msg[256];

    sprintf(msg, "Welcome %s to the world!", vp_string(sdk, VP_AVATAR_NAME));
    vp_say(sdk, msg);
  }
}

int main(int argc, const char* argv[])
{

  //...

  vp_event_set(sdk, VP_EVENT_AVATAR_ADD, handle_avatar_add);

  //...
}

See also