Skip to content

Commit

Permalink
Updated version (v0.0.3)
Browse files Browse the repository at this point in the history
  • Loading branch information
Francisco Dias committed Mar 19, 2024
1 parent cf61612 commit 719912e
Show file tree
Hide file tree
Showing 25 changed files with 748 additions and 1,054 deletions.
2 changes: 1 addition & 1 deletion metadata.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"gitHubUrl":"https://github.com/YoYoGames/GMEXT-FMOD","projectFile":"source/fmod_gml/FMOD.yyp","projectVersion":"LTS22","releaseTemplate":"templates/release_body.md","extensionMetaData":[{"extensionFile":"source/fmod_gml/extensions/FMOD/FMOD.yy","packageId":"com.yoyogames.fmodext","packageName":"FMOD Ext","packageVersion":"0.0.2","packageFormat":"LTS22","includeFolders":null,"includeResources":null,"excludeFolders":null,"excludeResources":null}]}
{"gitHubUrl":"https://github.com/YoYoGames/GMEXT-FMOD","projectFile":"source/fmod_gml/FMOD.yyp","projectVersion":"LTS22","releaseTemplate":"templates/release_body.md","extensionMetaData":[{"extensionFile":"source/fmod_gml/extensions/FMOD/FMOD.yy","packageId":"com.yoyogames.fmodext","packageName":"FMOD Ext","packageVersion":"0.0.3","packageFormat":"LTS22","includeFolders":null,"includeResources":null,"excludeFolders":null,"excludeResources":null}]}
2 changes: 1 addition & 1 deletion source/fmod_gml/extensions/FMOD/FMOD.yy

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

134 changes: 53 additions & 81 deletions source/fmod_gml/extensions/FMOD/docs/DSP.html

Large diffs are not rendered by default.

207 changes: 200 additions & 7 deletions source/fmod_gml/extensions/FMOD/docs/GeneralInformation.html

Large diffs are not rendered by default.

33 changes: 13 additions & 20 deletions source/fmod_gml/extensions/FMOD/docs/GettingStarted.html
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ <h1 id="fmod-systems">FMOD Systems</h1>
<h1 id="fmod-init-loop">FMOD Init &amp; Loop</h1>
<p>Your game needs to run some initialisation code (e.g. in a Create event) and loop code (in a Step event) for FMOD to work.</p>
<p>The following example code can be placed in an "FMOD manager" object's Create event, which initialises the system:</p>
<div class="highlight"><pre><span></span><code>var _max_channels = 1024
<pre class="highlight"><code class="language-gml">var _max_channels = 1024
var _flags_core = FMOD_INIT.NORMAL;
var _flags_studio = FMOD_STUDIO_INIT.LIVEUPDATE;

Expand All @@ -214,10 +214,10 @@ <h1 id="fmod-init-loop">FMOD Init &amp; Loop</h1>
The FMOD Studio System function also initialises the core FMOD system, which is why you do not need to call fmod_system_create() here.
*/
fmod_studio_system_create();
show_debug_message(&quot;fmod_studio_system_create: &quot; + string(fmod_last_result()));
show_debug_message("fmod_studio_system_create: " + string(fmod_last_result()));

fmod_studio_system_init(_max_channels, _flags_studio, _flags_core);
show_debug_message(&quot;fmod_studio_system_init: &quot; + string(fmod_last_result()));
show_debug_message("fmod_studio_system_init: " + string(fmod_last_result()));

/*
FMOD Studio will create an initialize an underlying core system to work with.
Expand All @@ -233,14 +233,13 @@ <h1 id="fmod-init-loop">FMOD Init &amp; Loop</h1>
It creates and initialises the core FMOD system, printing the result of each call to the Output Log.
*/
fmod_main_system = fmod_system_create()
show_debug_message(&quot;fmod_system_create: &quot; + string(fmod_last_result()))
show_debug_message("fmod_system_create: " + string(fmod_last_result()))

fmod_system_init(_max_channels, _flags_core)
show_debug_message(&quot;fmod_system_init: &quot; + string(fmod_last_result()))
}
</code></pre></div>
show_debug_message("fmod_system_init: " + string(fmod_last_result()))
}</code></pre>
<p>Your manager object should also have a Step event with the following code in it:</p>
<div class="highlight"><pre><span></span><code>if (USE_FMOD_STUDIO) {
<pre class="highlight"><code class="language-gml">if (USE_FMOD_STUDIO) {
/*
If you are only using Studio you need this.
This call will update the STUDIO system and the underlying CORE system.
Expand All @@ -252,8 +251,7 @@ <h1 id="fmod-init-loop">FMOD Init &amp; Loop</h1>
If you are only using Core you only need this.
*/
fmod_system_update();
}
</code></pre></div>
}</code></pre>
<h1 id="playing-events">Playing Events</h1>
<blockquote>
<p>If you are not familiar with FMOD, <a href="https://www.youtube.com/watch?v=7A1HMOsD2eU">watch this tutorial</a>.</p>
Expand All @@ -262,20 +260,15 @@ <h1 id="playing-events">Playing Events</h1>
<p>Once you have set up your FMOD project, go to <strong>File -&gt; Build</strong> to export the banks.</p>
<p>Copy the banks into the <code>datafiles</code> folder of your GameMaker project, to add them to your <a href="https://manual.gamemaker.io/monthly/en/Settings/Included_Files.htm">Included Files</a>.</p>
<p>In your game code, load your bank with <a href="studio_system.html#fmod_studio_system_load_bank_file">fmod_studio_system_load_bank_file</a>:</p>
<div class="highlight"><pre><span></span><code>bank_ref = fmod_studio_system_load_bank_file(fmod_path_bundle(&quot;master.bank&quot;), FMOD_STUDIO_LOAD_BANK.NORMAL);
</code></pre></div>
<pre class="highlight"><code class="language-gml">bank_ref = fmod_studio_system_load_bank_file(fmod_path_bundle("master.bank"), FMOD_STUDIO_LOAD_BANK.NORMAL);</code></pre>
<p>Then load your strings bank with <a href="studio_system.html#fmod_studio_system_load_bank_file">fmod_studio_system_load_bank_file</a> so you can look-up events in the bank:</p>
<div class="highlight"><pre><span></span><code>strings_bank_ref = fmod_studio_system_load_bank_file(fmod_path_bundle(&quot;master.strings.bank&quot;), FMOD_STUDIO_LOAD_BANK.NORMAL);
</code></pre></div>
<pre class="highlight"><code class="language-gml">strings_bank_ref = fmod_studio_system_load_bank_file(fmod_path_bundle("master.strings.bank"), FMOD_STUDIO_LOAD_BANK.NORMAL);</code></pre>
<p>Load the event description, using its name defined in FMOD Studio with the <a href="studio_system.html#fmod_studio_system_get_event">fmod_studio_system_get_event</a> function:</p>
<div class="highlight"><pre><span></span><code>event_description_ref = fmod_studio_system_get_event(&quot;event:/Ambience/Country&quot;);
</code></pre></div>
<pre class="highlight"><code class="language-gml">event_description_ref = fmod_studio_system_get_event("event:/Ambience/Country");</code></pre>
<p>Create an instance of the event description before playing it, using <a href="event_description.html#fmod_studio_event_description_create_instance">fmod_studio_event_description_create_instance</a>:</p>
<div class="highlight"><pre><span></span><code>event_description_instance_ref = fmod_studio_event_description_create_instance(event_description_ref);
</code></pre></div>
<pre class="highlight"><code class="language-gml">event_description_instance_ref = fmod_studio_event_description_create_instance(event_description_ref);</code></pre>
<p>Finally, play the instance so you hear sound using <a href="event_instance.html#fmod_studio_event_instance_start">fmod_studio_event_instance_start</a>:</p>
<div class="highlight"><pre><span></span><code>fmod_studio_event_instance_start(event_description_instance_ref);
</code></pre></div>
<pre class="highlight"><code class="language-gml">fmod_studio_event_instance_start(event_description_instance_ref);</code></pre>

</div>
</div><footer>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 18 additions & 36 deletions source/fmod_gml/extensions/FMOD/docs/bank.html
Original file line number Diff line number Diff line change
Expand Up @@ -201,8 +201,7 @@ <h1 id="fmod_studio_bank_get_loading_state">fmod_studio_bank_get_loading_state</
<p><br></p>
<p><strong>Syntax:</strong></p>
<blockquote>
<div class="highlight"><pre><span></span><code>fmod_studio_bank_get_loading_state(bank_ref)
</code></pre></div>
<pre class="highlight"><code class="language-gml">fmod_studio_bank_get_loading_state(bank_ref)</code></pre>
</blockquote>
<table>
<thead>
Expand Down Expand Up @@ -241,8 +240,7 @@ <h1 id="fmod_studio_bank_load_sample_data">fmod_studio_bank_load_sample_data</h1
<p><br></p>
<p><strong>Syntax:</strong></p>
<blockquote>
<div class="highlight"><pre><span></span><code>fmod_studio_bank_load_sample_data(bank_ref)
</code></pre></div>
<pre class="highlight"><code class="language-gml">fmod_studio_bank_load_sample_data(bank_ref)</code></pre>
</blockquote>
<table>
<thead>
Expand Down Expand Up @@ -280,8 +278,7 @@ <h1 id="fmod_studio_bank_unload_sample_data">fmod_studio_bank_unload_sample_data
<p><br></p>
<p><strong>Syntax:</strong></p>
<blockquote>
<div class="highlight"><pre><span></span><code>fmod_studio_bank_unload_sample_data(bank_ref)
</code></pre></div>
<pre class="highlight"><code class="language-gml">fmod_studio_bank_unload_sample_data(bank_ref)</code></pre>
</blockquote>
<table>
<thead>
Expand Down Expand Up @@ -320,8 +317,7 @@ <h1 id="fmod_studio_bank_get_sample_loading_state">fmod_studio_bank_get_sample_l
<p><br></p>
<p><strong>Syntax:</strong></p>
<blockquote>
<div class="highlight"><pre><span></span><code>fmod_studio_bank_get_sample_loading_state(bank_ref)
</code></pre></div>
<pre class="highlight"><code class="language-gml">fmod_studio_bank_get_sample_loading_state(bank_ref)</code></pre>
</blockquote>
<table>
<thead>
Expand Down Expand Up @@ -360,8 +356,7 @@ <h1 id="fmod_studio_bank_unload">fmod_studio_bank_unload</h1>
<p><br></p>
<p><strong>Syntax:</strong></p>
<blockquote>
<div class="highlight"><pre><span></span><code>fmod_studio_bank_unload(bank_ref)
</code></pre></div>
<pre class="highlight"><code class="language-gml">fmod_studio_bank_unload(bank_ref)</code></pre>
</blockquote>
<table>
<thead>
Expand Down Expand Up @@ -399,8 +394,7 @@ <h1 id="fmod_studio_bank_get_bus_count">fmod_studio_bank_get_bus_count</h1>
<p><br></p>
<p><strong>Syntax:</strong></p>
<blockquote>
<div class="highlight"><pre><span></span><code>fmod_studio_bank_get_bus_count(bank_ref)
</code></pre></div>
<pre class="highlight"><code class="language-gml">fmod_studio_bank_get_bus_count(bank_ref)</code></pre>
</blockquote>
<table>
<thead>
Expand Down Expand Up @@ -438,8 +432,7 @@ <h1 id="fmod_studio_bank_get_bus_list">fmod_studio_bank_get_bus_list</h1>
<p><br></p>
<p><strong>Syntax:</strong></p>
<blockquote>
<div class="highlight"><pre><span></span><code>fmod_studio_bank_get_bus_list(bank_ref)
</code></pre></div>
<pre class="highlight"><code class="language-gml">fmod_studio_bank_get_bus_list(bank_ref)</code></pre>
</blockquote>
<table>
<thead>
Expand Down Expand Up @@ -478,8 +471,7 @@ <h1 id="fmod_studio_bank_get_event_count">fmod_studio_bank_get_event_count</h1>
<p><br></p>
<p><strong>Syntax:</strong></p>
<blockquote>
<div class="highlight"><pre><span></span><code>fmod_studio_bank_get_event_count(bank_ref)
</code></pre></div>
<pre class="highlight"><code class="language-gml">fmod_studio_bank_get_event_count(bank_ref)</code></pre>
</blockquote>
<table>
<thead>
Expand Down Expand Up @@ -518,8 +510,7 @@ <h1 id="fmod_studio_bank_get_event_description_list">fmod_studio_bank_get_event_
<p><br></p>
<p><strong>Syntax:</strong></p>
<blockquote>
<div class="highlight"><pre><span></span><code>fmod_studio_bank_get_event_description_list(bank_ref)
</code></pre></div>
<pre class="highlight"><code class="language-gml">fmod_studio_bank_get_event_description_list(bank_ref)</code></pre>
</blockquote>
<table>
<thead>
Expand Down Expand Up @@ -557,8 +548,7 @@ <h1 id="fmod_studio_bank_get_string_count">fmod_studio_bank_get_string_count</h1
<p><br></p>
<p><strong>Syntax:</strong></p>
<blockquote>
<div class="highlight"><pre><span></span><code>fmod_studio_bank_get_string_count(bank_ref)
</code></pre></div>
<pre class="highlight"><code class="language-gml">fmod_studio_bank_get_string_count(bank_ref)</code></pre>
</blockquote>
<table>
<thead>
Expand Down Expand Up @@ -596,8 +586,7 @@ <h1 id="fmod_studio_bank_get_string_info">fmod_studio_bank_get_string_info</h1>
<p><br></p>
<p><strong>Syntax:</strong></p>
<blockquote>
<div class="highlight"><pre><span></span><code>fmod_studio_bank_get_string_info(bank_ref, string_index)
</code></pre></div>
<pre class="highlight"><code class="language-gml">fmod_studio_bank_get_string_info(bank_ref, string_index)</code></pre>
</blockquote>
<table>
<thead>
Expand Down Expand Up @@ -640,8 +629,7 @@ <h1 id="fmod_studio_bank_get_vca_count">fmod_studio_bank_get_vca_count</h1>
<p><br></p>
<p><strong>Syntax:</strong></p>
<blockquote>
<div class="highlight"><pre><span></span><code>fmod_studio_bank_get_vca_count(bank_ref)
</code></pre></div>
<pre class="highlight"><code class="language-gml">fmod_studio_bank_get_vca_count(bank_ref)</code></pre>
</blockquote>
<table>
<thead>
Expand Down Expand Up @@ -679,8 +667,7 @@ <h1 id="fmod_studio_bank_get_vca_list">fmod_studio_bank_get_vca_list</h1>
<p><br></p>
<p><strong>Syntax:</strong></p>
<blockquote>
<div class="highlight"><pre><span></span><code>fmod_studio_bank_get_vca_list(bank_ref)
</code></pre></div>
<pre class="highlight"><code class="language-gml">fmod_studio_bank_get_vca_list(bank_ref)</code></pre>
</blockquote>
<table>
<thead>
Expand Down Expand Up @@ -717,8 +704,7 @@ <h1 id="fmod_studio_bank_get_id">fmod_studio_bank_get_id</h1>
<p><br></p>
<p><strong>Syntax:</strong></p>
<blockquote>
<div class="highlight"><pre><span></span><code>fmod_studio_bank_get_id(bank_ref)
</code></pre></div>
<pre class="highlight"><code class="language-gml">fmod_studio_bank_get_id(bank_ref)</code></pre>
</blockquote>
<table>
<thead>
Expand Down Expand Up @@ -756,8 +742,7 @@ <h1 id="fmod_studio_bank_get_path">fmod_studio_bank_get_path</h1>
<p><br></p>
<p><strong>Syntax:</strong></p>
<blockquote>
<div class="highlight"><pre><span></span><code>fmod_studio_bank_get_path(bank_ref)
</code></pre></div>
<pre class="highlight"><code class="language-gml">fmod_studio_bank_get_path(bank_ref)</code></pre>
</blockquote>
<table>
<thead>
Expand Down Expand Up @@ -794,8 +779,7 @@ <h1 id="fmod_studio_bank_is_valid">fmod_studio_bank_is_valid</h1>
<p><br></p>
<p><strong>Syntax:</strong></p>
<blockquote>
<div class="highlight"><pre><span></span><code>fmod_studio_bank_is_valid(bank_ref)
</code></pre></div>
<pre class="highlight"><code class="language-gml">fmod_studio_bank_is_valid(bank_ref)</code></pre>
</blockquote>
<table>
<thead>
Expand Down Expand Up @@ -832,8 +816,7 @@ <h1 id="fmod_studio_bank_set_user_data">fmod_studio_bank_set_user_data</h1>
<p><br></p>
<p><strong>Syntax:</strong></p>
<blockquote>
<div class="highlight"><pre><span></span><code>fmod_studio_bank_set_user_data(bank_ref, data)
</code></pre></div>
<pre class="highlight"><code class="language-gml">fmod_studio_bank_set_user_data(bank_ref, data)</code></pre>
</blockquote>
<table>
<thead>
Expand Down Expand Up @@ -876,8 +859,7 @@ <h1 id="fmod_studio_bank_get_user_data">fmod_studio_bank_get_user_data</h1>
<p><br></p>
<p><strong>Syntax:</strong></p>
<blockquote>
<div class="highlight"><pre><span></span><code>fmod_studio_bank_get_user_data(bank_ref)
</code></pre></div>
<pre class="highlight"><code class="language-gml">fmod_studio_bank_get_user_data(bank_ref)</code></pre>
</blockquote>
<table>
<thead>
Expand Down
Loading

0 comments on commit 719912e

Please sign in to comment.