Events.AudioDebugChangeMusic (Civ5 API): Difference between revisions

From Civilization Modding Wiki
Jump to navigationJump to search
m (Argument descriptions.)
m (Spelling correction. "Toggle sar state." changed to "Toggle war state.")
 
Line 23: Line 23:
|-
|-
|valign="top" style="padding-right:6px;"|arg1:
|valign="top" style="padding-right:6px;"|arg1:
|valign="top"| ''Toggle sar state.''
|valign="top"| ''Toggle war state.''
|-
|-
|valign="top" style="padding-right:6px;"|arg2:
|valign="top" style="padding-right:6px;"|arg2:

Latest revision as of 01:08, 6 September 2013

This page is a part of the Lua and UI Reference (Civ5).


Function.png This function is a member of Events.

This is a static method, invoke it with a dot.


Usage

void Events.AudioDebugChangeMusic(bool arg0, bool arg1, bool arg2)


Event Type

Regular event: you can subscribe to it through Events.AudioDebugChangeMusic.Add(<function handler>) or invoke it directly through Events.AudioDebugChangeMusic(<arguments list>).

Parameters

arg0: Play next song.
arg1: Toggle war state.
arg2: Reset audio.


Source code samples

DebugMenu.lua

UI/InGame/DebugMenu.lua
0132
Events.AudioDebugChangeMusic(true,false,false);
0136
Events.AudioDebugChangeMusic(true,true,false);
0140
Events.AudioDebugChangeMusic(false,false,true);



The initial version of this page was created by the Civ5 API Bot, see the Civ5 API Reference FAQ. Some of the texts come from the 2kgames' wiki and most of code samples are copyrighted to Firaxis.
Functions' signatures were either copied from the 2kgames' wiki, or infered from the Lua source files and the binaries. Errors are possible.
Contributors may find help in the Contributors guide to the Civ5 API.