DebugSleep: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Server client function}} This function is used to set the freeze time for the client/server. This means that all synchronization, frame updating and script's execu...")
 
(fixed the example, having to use a number as first argument to debugSleep)
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}
This function is used to set the freeze time for the client/server. This means that all synchronization, frame updating and script's execution will stop.
[[debugSleep]] freezes the client/server for the specified time. This means that all synchronization, rendering and script execution will stop except HTTP processing invoked by [[fetchRemote]]. This function only works, if development mode is enabled by [[setDevelopmentMode]] and can be utilised to build a debugger that communicates via HTTP requests with the editor/IDE.
 
{{Warning|Only use this function if you know what you are doing!|true}}


==Syntax==
==Syntax==
Line 23: Line 25:
addCommandHandler ( "zzz",
addCommandHandler ( "zzz",
     function ( command, sleep )
     function ( command, sleep )
         debugSleep ( sleep )
         if ( sleep ) then
            local ms = tonumber ( sleep )
            if ( ms ) then
                debugSleep ( ms )
            end
        end
     end
     end
)
)

Latest revision as of 14:35, 27 January 2022

debugSleep freezes the client/server for the specified time. This means that all synchronization, rendering and script execution will stop except HTTP processing invoked by fetchRemote. This function only works, if development mode is enabled by setDevelopmentMode and can be utilised to build a debugger that communicates via HTTP requests with the editor/IDE.


Dialog-warning.png Warning: Only use this function if you know what you are doing!

Syntax

bool debugSleep ( int sleep )

Required Arguments

  • sleep : An integer value in milliseconds.

Returns

Returns true if the development mode is enabled and arguments are correct, false otherwise.

Requirements

Minimum server version 1.5.4-9.11306
Minimum client version 1.5.4-9.11306

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version server="1.5.4-9.11306" client="1.5.4-9.11306" />

Example

Example 1: This example would add the command to set the client's freeze time.

Click to collapse [-]
Client
addCommandHandler ( "zzz",
    function ( command, sleep )
        if ( sleep ) then
            local ms = tonumber ( sleep )
            if ( ms ) then
                debugSleep ( ms )
            end
        end
    end
)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/DebugSleep?oldid=73856"