Firelight Technologies FMOD Studio API

Geometry::getActive

Retrieves the user set active state of the geometry object.

C++ Syntax

FMOD_RESULT Geometry::getActive(
  bool *active
);

C Syntax

FMOD_RESULT FMOD_Geometry_GetActive(
  FMOD_GEOMETRY *geometry,
  FMOD_BOOL *active
);

C# Syntax

RESULT Geometry.getActive(
  out bool active
);

JavaScript Syntax

Geometry.getActive(
  active                           // writes value to active.val
);

Parameters

active

Address of a variable to receive the active state of the object. true = active, false = not active. Default = true.

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

See Also

• Geometry::setActive

Version 1.10.03 Built on Feb 1, 2018