Read any property of an object — including dynamic, per-class managed properties not in the static reference (e.g. an event's 'timeline').

Set any property of an object (e.g. instrument 'audioFile' = an asset, or 'name'). Value is auto-embedded: numbers/booleans as literals, a path or '{guid}' as an object reference, else a string.

Add an object to one of a target's relationships, e.g. relationship 'banks' on an event -> a 'bank:/...'. (target.relationships[name].add(other))

Remove an object from one of a target's relationships. (target.relationships[name].remove(other))

List the project model's class/entity names (introspection: keys of studio.project.model).

List a class's schema-defined property and relationship names — how to discover the dynamic members (use with fmod_get_property/fmod_set_property/fmod_add_relationship).

Composite: create an event, optionally import a one-shot sound onto a new audio track and assign the event to a bank. Equivalent to a create + importAudioFile + addGroupTrack + addSound + set audioFile + add bank relationship.

Logs a message. Alias for studio.system.print . [method · console.log]

Logs a warning. Alias for studio.system.warn . [method · console.warn]

Logs an error. Alias for studio.system.error . [method · console.error]

Logs all members of object. [method · console.dump]

Logs a message in a popup dialog (blocking). Alias for studio.system.message . [method · (global).alert]

The current operating system of the computer. Returns either "mac" for Mac OS X or "win" for all Windows versions. Returns either "mac" for Mac OS X or "win" for all Windows versions. [property · studio.os.platform]

The absolute file path of the FMOD Studio process's executable. [property · studio.application.filePath]

An object containing version information for the Studio tool: [property · studio.version]

Registers a menu item under the "Scripts" menu, based on the description object: Returns true if the operation succeeds, or false otherwise. [method · menu.addMenuItem]

Removes a menu item that was added with menu.addMenuItem() . The description argument must match a description that the menu item was added with. Returns true if the operation succeeds, or false otherwise. [method · menu.removeMenuItem]

Returns an Array of menu item descriptions added with menu.addMenuItem() . The order of the Array matches the order in which the items were added. Returns an Array of menu item descriptions added with menu. [method · menu.menuItems]

Builds all the banks to all the platforms listed in the build tab of the preferences dialog. Returns true if the operation succeeds, or false otherwise. [method · project.build]

Returns a new instance of a ManagedObject of the given entity name. Returns a new instance of a ManagedObject of the given entity name. [method · project.create]

Deletes the ManagedObject and its references, if any, from the project. Returns true if the operation succeeds, or false otherwise. [method · project.deleteObject]

Exports project "guids.txt". Returns true if the operation succeeds, or false otherwise. [method · project.exportGUIDs]

Returns an array of strings that lists all available plugins. Returns an array of strings that lists all available plugins. [method · project.findAvailablePlugins]

Imports an audio asset into the project. Returns an model. [method · project.importAudioFile]

Lookup a ManagedObject by path or GUID. Returns a ManagedObject found by GUID or path. [method · project.lookup]

Saves the project. Returns true if the operation succeeds, or false otherwise. [method · project.save]

Callback triggered when an audio file has finished being imported. [property · project.audioFileImported]

Sets a function to be called when an audio file is imported, with the signature function(audioFile) . [method · project.audioFileImported.connect]

Disconnects the connectFunction once it is no longer needed. It is important to disconnect the connected signals when they are no longer needed, otherwise they can accumulate and cause unexpected behavior. [method · project.audioFileImported.disconnect]

A callback that will be fired when a build has completed. [property · project.buildEnded]

Sets a function to be called after banks are built, with the signature function(success) . The success argument will be false if a build error occurs or the build is cancelled by the user, and true otherwise. For example: [method · project.buildEnded.connect]

Disconnects the connectFunction once it is no longer needed. It is important to disconnect the connected signals when they are no longer needed, otherwise they can accumulate and cause unexpected behavior. [method · project.buildEnded.disconnect]

A callback that will be fired when a build has commenced. [property · project.buildStarted]

Sets a function to be called before banks are built, with the signature function() . For example: [method · project.buildStarted.connect]

Disconnects the connectFunction once it is no longer needed. It is important to disconnect the connected signals when they are no longer needed, otherwise they can accumulate and cause unexpected behavior. [method · project.buildStarted.disconnect]

The absolute path to the project's ".fspro` file on disk. [property · project.filePath]

An enum corresponding to different distance attenuation roll-off types available to spatial effects. [property · project.distanceRolloffType]

An enum corresponding to different model.Parameter types available. [property · project.parameterType]

An enum corresponding to different loop modes of a loop region. [property · project.regionLoopMode]

A constant boolean value that is set to true if an object is the base class of another entity type. [property · entity.isAbstract]

A constant boolean value that is set to true if an entity exists globally, rather than on a per project basis. [property · entity.isGlobal]

A constant boolean value that is set to true if only a single ManagedObject instance of the entity can exist at any given time. [property · entity.isSingleton]

Returns an array of property description objects containing named properties that represent each ManagedObject property available for this entity. Returns an array of property description objects containing named properties that represent each ManagedObject property available for this entity. [property · entity.properties]

An array of strings representing the entity type inherited by this entity. [property · entity.superEntities]

Returns a string describing the entity, including its properties and relationships. Returns a string describing the entity, including its properties and relationships. [method · entity.document]

Returns an array of ManagedObject instances of a given entity type. Returns an array of ManagedObject instances of a given entity type. (bracketed args are optional) [method · entity.findInstances]

Returns the singleton ManagedObject instance of a particular entity type. Returns the singleton ManagedObject instance of a particular entity type. [method · entity.singletonInstance]

Returns an array of relationship description objects, containing named relationships that represents each ManagedObject relationship available for this entity. Returns an array of relationship description objects, containing named relationships that represents each ManagedObject relationship available for this entity. [property · entity.relationships]

A string representing the object's project.Entity type. [property · ManagedObject.entity]

The object's unique ID. [property · ManagedObject.id]

Returns whether an object is in a valid state. Returns whether an object is in a valid state. [property · ManagedObject.isValid]

Provides access to an object's properties. Returns a ManagedPropertyMap . [property · ManagedObject.properties]

Provides access to an object's relationships. Returns a ManagedRelationshipMap . [property · ManagedObject.relationships]

Returns a string describing this ManagedObject 's entity type. Returns a string describing this ManagedObject 's entity type. [method · ManagedObject.document]

Logs all members. [method · ManagedObject.dump]

Returns true if the object type matches the provided entity name. Returns true if the object type matches the provided entity name. [method · ManagedObject.isOfExactType]

Returns true if the object has an entity that matches the entity name, or is of a derived type. Returns true if the object has an entity that matches the entity name, or is of a derived type. [method · ManagedObject.isOfType]

Retrieves the absolute path of the file the asset refers to. Returns the absolute path of the file the asset refers to. [method · Asset.getAbsoluteAssetPath]

Retrieves the path of the file the asset refers to, relative to the project assets directory. Returns the path of the file the asset refers to, relative to the project assets directory. [method · Asset.getAssetPath]

Sets the path of the file the asset refers to, relative to the project assets directory. Returns true if the operation succeeds, or false otherwise. [method · Asset.setAssetPath]

Creates a model.Automator for a given property of the automatable object. Returns the automator ManagedObject . [method · AutomatableObject.addAutomator]

Creates a model.Modulator for a given property of the automatable object. Returns the modulator ManagedObject . [method · AutomatableObject.addModulator]

Creates an automation point at the given position. Returns the automation point ManagedObject . [method · AutomationCurve.addAutomationPoint]

Creates a model.AutomationCurve on the parameter specified. Returns the automation curve ManagedObject . [method · Automator.addAutomationCurve]

Retrieves the bank's unique path identifier. Returns the bank's path as a string . [method · Bank.getPath]

Adds a game parameter to the event. Returns the game parameter ManagedObject . [method · Event.addGameParameter]

Adds an audio track with the given name to the event. Returns the newly created model. [method · Event.addGroupTrack]

Adds a marker track to the event. Returns the newly created model. [method · Event.addMarkerTrack]

Adds a return track with the given name to the event. Returns the newly created return track ManagedObject . [method · Event.addReturnTrack]

Retrieves the 3D attributes of an event. [method · Event.get3DAttributes]

Retrieves the cursor position. Returns the cursor position as a number . [method · Event.getCursorPosition]

Retrieves an array of preset parameters referenced by the event . Returns an array of all model. [method · Event.getParameterPresets]

Retrieves the event 's unique path identifier. Returns the event's path as a string . [method · Event.getPath]

Retrieves the playback position of a given parameter . Returns the playback position of a model. [method · Event.getPlayheadPosition]

Reports whether an event is 3D . Returns true if an event is 3D. [method · Event.is3D]

Reports whether an event is a one-shot. Returns true if an event is one-shot. [method · Event.isOneShot]

Reports whether an event instance is paused. Returns true if an event instance is paused. [method · Event.isPaused]

Reports whether an event instance is playing. Returns true if an event instance is playing. [method · Event.isPlaying]

Reports whether an event instance is being recorded in a profiler session . Returns true for profiler sessions with recording enabled. [method · Event.isRecording]

Reports whether an event instance is stopping. Returns true if an event instance is stopping. [method · Event.isStopping]

Sends the keyoff command to a currently playing event instance . [method · Event.keyOff]

Moves the playback position to the cursor position if called while the event instance is playing, stopping, or paused, or to the start of the timeline while the event instance is stopped. [method · Event.returnToStart]

Sets the 3D attributes of an event instance being auditioned based on a 3D attributes object. [method · Event.set3DAttributes]

Sets the cursor position to a number. [method · Event.setCursorPosition]

Stops an event instance immediately, skipping the stopping event state . [method · Event.stopImmediate]

Commands a playing event instance to enter the stopping event state . [method · Event.stopNonImmediate]

Toggles the pause state of an event instance . [method · Event.togglePause]

Toggles the recording state for a profiler session. [method · Event.toggleRecording]

Plays the event instance . [method · Event.play]

Retrieves the item at the relative path specified. Returns the item at the relative path specified. [method · Folder.getItem]

Retrieves the asset at the path specified. Returns the model. [method · MasterAssetFolder.getAsset]

Creates an effect and adds it to the end of the chain. Returns the effect ManagedObject . [method · MixerBusEffectChain.addEffect]

Sets the impulse response for a convolution reverb effect. [method · ConvolutionReverbEffect.setIRFromFilePath]

Retrieves the input format of the bus . Returns the effective input format for a model. [method · MixerBus.getInputFormat]

Retrieves the output format of the bus . Returns the effective output format for a model. [method · MixerBus.getOutputFormat]

Retrieves the mixer strip's unique path identifier. Returns the model. [method · MixerStrip.getPath]

Retrieves the parameter 's cursor position. Returns the cursor position of the global user parameter as a number . [method · GameParameter.getCursorPosition]

Sets the cursor position of the global , user , or built-in parameter to a number. [method · GameParameter.setCursorPosition]

Retrieves the playback position of a parameter, within the context of the associated model.Event . [property · Parameter.getPlayheadPosition]

Retrieves the preset parameter's unique path identifier. Returns the parameter's path as a string . [method · ParameterPreset.getPath]