Skip to content

CustomBank

Generic typessource

Handle to a loaded FMOD Bank. Unloading a bank will destroy all objects loaded from it, and unload all sample data. Can be used to load and unload the non-streaming sample data of all events in the bank. However you can also control the loading state of non-streaming sample data for individual events with a CustomEventDescription.

Methods

get_loading_state

function CustomBank:get_loading_state(): integer?

Returns integer? (may be nil)

source

get_sample_loading_state

function CustomBank:get_sample_loading_state(): integer?

Returns integer? (may be nil)

source

is_valid

function CustomBank:is_valid(): boolean

Returns boolean

source

load_sample_data

function CustomBank:load_sample_data(): boolean

Returns boolean

source

unload

function CustomBank:unload(): boolean

Returns boolean

source

unload_sample_data

function CustomBank:unload_sample_data(): boolean

Returns boolean

source