Skip to content

Commit

Permalink
Documentation from 13d519e [no CI]
Browse files Browse the repository at this point in the history
  • Loading branch information
Docs Bot committed Apr 1, 2024
1 parent 7daf49d commit 9d01dd6
Showing 1 changed file with 28 additions and 28 deletions.
56 changes: 28 additions & 28 deletions corsixth_lua/_0_1_audio.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ <h5><a name="_0_1_audio_1cache_sound_filenames_associated_with_name">function Au
<td class="d">?</td>
</tr>
</table></p><p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L311">line 311 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L314">line 314 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
Expand All @@ -203,7 +203,7 @@ <h5><a name="_0_1_audio_1dump_sound_archive">function Audio:dumpSoundArchive(<sp
<td class="d">?</td>
</tr>
</table></p><p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L255">line 255 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L258">line 258 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
Expand All @@ -218,7 +218,7 @@ <h5><a name="_0_1_audio_1entity_no_longer_waiting_for_sounds_to_be_turned_on">fu
<td class="d">?</td>
</tr>
</table></p><p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L656">line 656 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L659">line 659 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
Expand Down Expand Up @@ -254,13 +254,13 @@ <h5><a name="_0_1_audio_1entity_sounds_handler">function Audio:entitySoundsHandl
--</td>
</tr>
</table></p><p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L380">line 380 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L383">line 383 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
<h5><a name="_0_1_audio_1find_index_of_current_track">function Audio:findIndexOfCurrentTrack()</a></h5>
<p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L469">line 469 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L472">line 472 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
Expand All @@ -281,26 +281,26 @@ <h5><a name="_0_1_audio_1init_speech">function Audio:initSpeech(<span class="p">
<td class="d">?</td>
</tr>
</table></p><p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L191">line 191 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L194">line 194 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
<h5><a name="_0_1_audio_1notify_jukebox">function Audio:notifyJukebox()</a></h5>
<p>
search for jukebox and notify it to update its play button<br/><br/>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L664">line 664 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L667">line 667 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
<h5><a name="_0_1_audio_1on_end_pause">function Audio:onEndPause()</a></h5>
<p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L425">line 425 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L428">line 428 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
<h5><a name="_0_1_audio_1on_music_over">function Audio:onMusicOver()</a></h5>
<p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L610">line 610 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L613">line 613 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
Expand All @@ -315,15 +315,15 @@ <h5><a name="_0_1_audio_1on_sound_played">function Audio:onSoundPlayed(<span cla
<td class="d">?</td>
</tr>
</table></p><p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L431">line 431 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L434">line 434 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
<h5><a name="_0_1_audio_1pause_background_track">function Audio:pauseBackgroundTrack()</a></h5>
<p>
Returns whether music is currently paused or not after the call.<br/><br/>
If nil is returned music might either be playing or completely stopped.<br/><br/>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L509">line 509 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L512">line 512 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
Expand All @@ -340,7 +340,7 @@ <h5><a name="_0_1_audio_1play_background_track">function Audio:playBackgroundTra
<td class="d">Index of the track to play in the playlist.</td>
</tr>
</table></p><p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L561">line 561 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L564">line 564 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
Expand Down Expand Up @@ -381,13 +381,13 @@ <h5><a name="_0_1_audio_1play_entity_sounds">function Audio:playEntitySounds(<sp
--</td>
</tr>
</table></p><p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L354">line 354 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L357">line 357 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
<h5><a name="_0_1_audio_1play_next_background_track">function Audio:playNextBackgroundTrack()</a></h5>
<p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L501">line 501 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L504">line 504 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
Expand All @@ -402,19 +402,19 @@ <h5><a name="_0_1_audio_1play_next_or_previous_background_track">function Audio:
<td class="d">?</td>
</tr>
</table></p><p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L479">line 479 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L482">line 482 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
<h5><a name="_0_1_audio_1play_previous_background_track">function Audio:playPreviousBackgroundTrack()</a></h5>
<p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L505">line 505 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L508">line 508 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
<h5><a name="_0_1_audio_1play_random_background_track">function Audio:playRandomBackgroundTrack()</a></h5>
<p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L452">line 452 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L455">line 455 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
Expand Down Expand Up @@ -449,7 +449,7 @@ <h5><a name="_0_1_audio_1play_sound">function Audio:playSound(<span class="p">na
<td class="d">?</td>
</tr>
</table></p><p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L278">line 278 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L281">line 281 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
Expand All @@ -464,7 +464,7 @@ <h5><a name="_0_1_audio_1play_sound_effects">function Audio:playSoundEffects(<sp
<td class="d">?</td>
</tr>
</table></p><p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L635">line 635 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L638">line 638 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
Expand All @@ -479,13 +479,13 @@ <h5><a name="_0_1_audio_1release_channel">function Audio:releaseChannel(<span cl
<td class="d">?</td>
</tr>
</table></p><p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L680">line 680 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L683">line 683 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
<h5><a name="_0_1_audio_1reserve_channel">function Audio:reserveChannel()</a></h5>
<p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L672">line 672 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L675">line 675 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
Expand All @@ -500,7 +500,7 @@ <h5><a name="_0_1_audio_1set_announcement_volume">function Audio:setAnnouncement
<td class="d">?</td>
</tr>
</table></p><p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L660">line 660 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L663">line 663 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
Expand All @@ -515,14 +515,14 @@ <h5><a name="_0_1_audio_1set_background_volume">function Audio:setBackgroundVolu
<td class="d">?</td>
</tr>
</table></p><p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L617">line 617 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L620">line 620 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
<h5><a name="_0_1_audio_1set_sound_stage">function Audio:setSoundStage()</a></h5>
<p>
Set the visual area for sound effects playback<br/><br/>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L247">line 247 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L250">line 250 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
Expand All @@ -537,7 +537,7 @@ <h5><a name="_0_1_audio_1set_sound_volume">function Audio:setSoundVolume(<span c
<td class="d">?</td>
</tr>
</table></p><p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L626">line 626 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L629">line 629 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
Expand All @@ -555,21 +555,21 @@ <h5><a name="_0_1_audio_1sound_exists">function Audio:soundExists(<span class="p
number (position in the list of sounds)</td>
</tr>
</table></p><p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L440">line 440 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L443">line 443 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
<h5><a name="_0_1_audio_1stop_background_track">function Audio:stopBackgroundTrack()</a></h5>
<p>
Stops playing background music for the time being.<br/><br/>
Does not affect the configuration setting play_music.<br/><br/>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L548">line 548 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L551">line 551 of Lua/audio.lua</a>.
</p>
</div>
<div class="method">
<h5><a name="_0_1_audio_1tell_interested_entities_they_can_now_play_sounds">function Audio:tellInterestedEntitiesTheyCanNowPlaySounds()</a></h5>
<p>
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L647">line 647 of Lua/audio.lua</a>.
<strong>Declared on:</strong> <a href="http://www.github.com/CorsixTH/CorsixTH/blob/master/CorsixTH/Lua/audio.lua#L650">line 650 of Lua/audio.lua</a>.
</p>
</div>
</div>
Expand Down

0 comments on commit 9d01dd6

Please sign in to comment.