CustomEventDescription

Generic typessource

Handle to an FMOD event description, can be used to create a CustomEventInstance with CustomEventDescription:create_instance(). Also can be used to load and unload non-streaming sample data for the Event, and release all instances of the event. You can also get parameter IDs using CustomEventDescription:get_parameter_description_by_name().

Methods

create_instance

function CustomEventDescription:create_instance(): CustomEventInstance

Returns CustomEventInstance

source

get_parameter_description_by_index

function CustomEventDescription:get_parameter_description_by_index(index: integer): ParameterDescription?

index: integer

Returns ParameterDescription? (may be nil)

source

get_parameter_description_by_name

function CustomEventDescription:get_parameter_description_by_name(name: string): ParameterDescription?

name: string

Returns ParameterDescription? (may be nil)

source

get_parameter_description_count

function CustomEventDescription:get_parameter_description_count(): integer?

Returns integer? (may be nil)

source

get_parameter_id_by_name

function CustomEventDescription:get_parameter_id_by_name(name: string): ParameterId?

name: string

Returns ParameterId? (may be nil)

source

get_sample_loading_state

function CustomEventDescription:get_sample_loading_state(): integer?

Returns integer? (may be nil)

source

is_valid

function CustomEventDescription:is_valid(): boolean

Returns boolean

source

load_sample_data

function CustomEventDescription:load_sample_data(): boolean

Returns boolean

source

release_all_instances

function CustomEventDescription:release_all_instances(): boolean

Returns boolean

source

unload_sample_data

function CustomEventDescription:unload_sample_data(): boolean

Returns boolean

source