SetDevelopmentMode: Difference between revisions

Revision as of 08:42, 18 January 2014

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

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.

Syntax

bool setDevelopmentMode ( bool enable )

Required Arguments

enable : A boolean to indicate whether development mode is on (true) or off (false)

Returns

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

Requirements

This template will be deleted.

Example

Click to collapse [-]

Client script

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 funtions.

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

@@ Line 20: / Line 20: @@
 ==Requirements==
 {{Requirements|n/a|1.1.1-9.03355|}}
+==Example==
+<section class="client" name="Client script" show="true">
+'''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 funtions.
+<syntaxhighlight lang="lua">
+addCommandHandler( "devmode",
+function ()
+	setDevelopmentMode ( true )
+end
+)
+</syntaxhighlight>
+</section>
 ==See Also==
 {{Client_utility_functions}}