Public Member Functions | List of all members
ScriptingApi::ModuleIds Class Reference

A list with all available modules. More...

Inheritance diagram for ScriptingApi::ModuleIds:
ApiClass

Public Member Functions

Identifier getName () const override
 Returns the name. More...
 
- Public Member Functions inherited from ApiClass
void addConstant (String constantName, var value)
 Adds a constant. More...
 
void addFunction (const Identifier &id, call0 newFunction)
 Adds a function with no parameters. More...
 
void addFunction1 (const Identifier &id, call1 newFunction)
 Adds a function with one parameter. More...
 
void addFunction2 (const Identifier &id, call2 newFunction)
 Adds a function with two parameters. More...
 
void addFunction3 (const Identifier &id, call3 newFunction)
 Adds a function with three parameters. More...
 
void addFunction4 (const Identifier &id, call4 newFunction)
 Adds a function with four parameters. More...
 
void addFunction5 (const Identifier &id, call5 newFunction)
 Adds a function with five parameters. More...
 
virtual bool allowIllegalCallsOnAudioThread (int) const
 You can overwrite this method and return true if you want to allow illegal calls that would otherwise fire a warning. More...
 
 ApiClass (int numConstants_)
 Creates a Api class with the given amount of constants. More...
 
var callFunction (int index, var *args, int numArgs)
 Calls the function with the index and the argument data. More...
 
void getAllConstants (Array< Identifier > &ids) const
 Returns all constant names as alphabetically sorted array. More...
 
void getAllFunctionNames (Array< Identifier > &ids) const
 This returns all function names alphabetically sorted. More...
 
int getConstantIndex (const Identifier &id) const
 Return the index for the given name. More...
 
Identifier getConstantName (int index) const
 Returns the name for the constant as it is used in the scripting context. More...
 
const var getConstantValue (int index) const
 Returns the constant at the given index. More...
 
void getIndexAndNumArgsForFunction (const Identifier &id, int &index, int &numArgs) const
 This will fill in the information for the given function. More...
 

Detailed Description

A list with all available modules.

Member Function Documentation

Identifier getName ( void  ) const
inlineoverridevirtual

Returns the name.

Implements ApiClass.

©2017 HISE. This documentation is autogenerated from the HISE source code using Doxygen.