SetDevelopmentMode: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (→‎Example: Typo)
(Remove obsolete Requirements section)
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
{{Shared function}}
This function is used to set the development mode. Setting development mode allows access to special commands which can assist with script debugging.
This function is used to set the development mode. Setting development mode allows access to special commands which can assist with script debugging.


Development mode commands:
'''Client-side''' development mode commands:
* '''[[Client_Commands#showcol|showcol]]''': Enables colshapes to be viewed as a wireframe object.
* '''[[Client_Commands#showcol|showcol]]''': Enables colshapes to be viewed as a wireframe object.
* '''[[Client_Commands#showsound|showsound]]''': Enables world sound ids to be printed in the debug output window.
* '''[[Client_Commands#showsound|showsound]]''': Enables world sound ids to be printed in the debug output window.


Development mode functions:
'''Shared''' development mode functions:
* '''[[debugSleep]]''': Sets the freeze time for the client/server.
* '''[[debugSleep]]''': Sets the freeze time for the client/server.
{{Note|Enabling development mode on the server side does '''not enable''' it on the client side. These functions work independently on both sides}}


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setDevelopmentMode ( bool enable, [ bool enableWeb = false ] )
bool setDevelopmentMode ( bool enable [, bool enableWeb = false ] )
</syntaxhighlight>
</syntaxhighlight>


===Required Arguments===
===Required Arguments===
*'''enable ''': A boolean to indicate whether development mode is on (''true'') or off (''false'')  
*'''enable''': A boolean to indicate whether development mode is on (''true'') or off (''false'')  
{{New feature/item|3.0150|1.5||
{{New feature/item|3.0150|1.5||
*'''enableWeb ''': A boolean to indicate whether browser debug messages will be filtered (''false'') or not (''true'')
*'''enableWeb''': A boolean to indicate whether browser debug messages will be filtered (''false'') or not (''true'')
}}
}}


===Returns===
===Returns===
Returns ''true'' if the mode was set correctly, ''false'' otherwise.
Returns ''true'' if the mode was set correctly, ''false'' otherwise.
==Requirements==
{{Requirements|1.5.4-9.11305|1.1.1-9.03355|}}


==Example==  
==Example==  
'''Example 1:''' This example would set the development mode of the client. Use /showcol [<0-1>] and /showsound [<0-1>] later to enable/disable respective functions.  
'''Example 1:''' This example would set the development mode of the client. Use /showcol [<0-1>] and /showsound [<0-1>] later to enable/disable respective functions.  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addCommandHandler( "devmode",
addCommandHandler("devmode",
function ()
    function()
    setDevelopmentMode ( true )
        setDevelopmentMode(true)
end
    end
)
)
</syntaxhighlight>
</syntaxhighlight>
It is important to note that this example has to be in a client side script. Otherwise, the execution of the command would only result in the shared dev mode that does not allow the use of '''[[Client_Commands#showcol|showcol]]''' and '''[[Client_Commands#showsound|showsound]]'''.


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

Latest revision as of 15:35, 7 November 2024

This function is used to set the development mode. Setting development mode allows access to special commands which can assist with script debugging.

Client-side development mode commands:

  • showcol: Enables colshapes to be viewed as a wireframe object.
  • showsound: Enables world sound ids to be printed in the debug output window.

Shared development mode functions:

  • debugSleep: Sets the freeze time for the client/server.
[[{{{image}}}|link=|]] Note: Enabling development mode on the server side does not enable it on the client side. These functions work independently on both sides

Syntax

bool setDevelopmentMode ( bool enable [, bool enableWeb = false ] )

Required Arguments

  • enable: A boolean to indicate whether development mode is on (true) or off (false)
  • enableWeb: A boolean to indicate whether browser debug messages will be filtered (false) or not (true)

Returns

Returns true if the mode was set correctly, false otherwise.

Example

Example 1: This example would set the development mode of the client. Use /showcol [<0-1>] and /showsound [<0-1>] later to enable/disable respective functions. 

addCommandHandler("devmode",
    function()
        setDevelopmentMode(true)
    end
)

It is important to note that this example has to be in a client side script. Otherwise, the execution of the command would only result in the shared dev mode that does not allow the use of showcol and showsound.


See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetDevelopmentMode?oldid=81032"