ShowSound: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client function}} {{Added feature/item|3.0159|1.5.9|1.5.8|20840|Prints world sound IDs in the debug output window to help when writing scripts with setWorld...")
 
(Remove obsolete Requirements section)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
{{Added feature/item|3.0159|1.5.9|1.5.8|20840|Prints world [[sound]] IDs in the debug output window to help when writing scripts with [[setWorldSoundEnabled]].}}
{{Added feature/item|1.5.9|1.5.8|20844|Prints world [[sound]] IDs in the debug output window to help when writing scripts with [[setWorldSoundEnabled]].}}
{{Note|This function only works in development mode.}}
{{Note|This function only works in development mode.}}


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">bool showCol ( bool state )</syntaxhighlight>
<syntaxhighlight lang="lua">bool showSound ( bool state )</syntaxhighlight>
===Required Arguments===  
===Required Arguments===  
*'''state:''' A [[boolean]] indicating if the world sound IDs should be printed in the debug window or not.
*'''state:''' A [[boolean]] indicating if the world sound IDs should be printed in the debug window or not.
Line 22: Line 22:
)
)
</syntaxhighlight>
</syntaxhighlight>
==Requirements==
{{Requirements|n/a|1.5.8-9.20840|}}


==See Also==
==See Also==
{{Client_utility_functions}}
{{Client_utility_functions}}

Latest revision as of 17:29, 7 November 2024

Prints world sound IDs in the debug output window to help when writing scripts with setWorldSoundEnabled.

[[{{{image}}}|link=|]] Note: This function only works in development mode.

Syntax

bool showSound ( bool state )

Required Arguments

  • state: A boolean indicating if the world sound IDs should be printed in the debug window or not.

Returns

  • Returns true if the function is successful, false otherwise.

Example

You can refer to the example below:

setDevelopmentMode (true)

addCommandHandler ("devdebug",
    function ()
        showSound (not isShowSoundEnabled())
    end
)

See Also