FMOD_STUDIO_USER_PROPERTY

FMOD Studio API

Firelight Technologies FMOD Studio API

FMOD_STUDIO_USER_PROPERTY

Structure describing a user property.

C/C++ Syntax

typedef struct {
  const char *name;
  FMOD_STUDIO_USER_PROPERTY_TYPE type;
  int intvalue;
  FMOD_BOOL boolvalue;
  float floatvalue;
  const char *stringvalue;
} FMOD_STUDIO_USER_PROPERTY;

JavaScript Syntax

struct FMOD_STUDIO_USER_PROPERTY
{
  name,
  type,
  intvalue,
  boolvalue,
  floatvalue,
  stringvalue,
};

Members

name

Name of the user property.

type

Type of the user property. Use this to select one of the following values.

intvalue

Value of the user property. Only valid when type is FMOD_STUDIO_USER_PROPERTY_TYPE_INTEGER.

boolvalue

Value of the user property. Only valid when type is FMOD_STUDIO_USER_PROPERTY_TYPE_BOOLEAN.

floatvalue

Value of the user property. Only valid when type is FMOD_STUDIO_USER_PROPERTY_TYPE_FLOAT.

stringvalue

Value of the user property. Only valid when type is FMOD_STUDIO_USER_PROPERTY_TYPE_STRING.

Remarks

JavaScript only :

Not all fields are currently supported or may not work as expected at this time. To initialize an new instance in javascript use "FMOD.STUDIO_USER_PROPERTY()", no 'new' keyword is required.

See Also



Version 1.10.03 Built on Feb 1, 2018