GetPlayerScriptDebugLevel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Remove obsolete Requirements section)
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}
{{Shared function}}
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
{{New feature/item|3.0158|1.5.7|19626|
This will allow you to retrieve the player current debug script level.
This will allow you to retrieve the player current debug script level.
 
}}
{{New feature/item|3.0161|1.6.0|22592|
This function has a client-sided variant, which can only retrieve the local player's script debug level.
}}
==Syntax==  
==Syntax==  
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getPlayerScriptDebugLevel( player thePlayer )
int getPlayerScriptDebugLevel( player thePlayer )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[player]]:getScriptDebugLevel|scriptDebugLevel}}
{{OOP||[[player]]:getScriptDebugLevel|scriptDebugLevel|setPlayerScriptDebugLevel}}
===Required Arguments===  
===Required Arguments===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
Line 17: Line 22:
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns an ''int'' with the player debug script level, ''false'' if the player is invalid.
Returns an ''int'' with the player debug script level, ''false'' if the player is invalid.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
int getPlayerScriptDebugLevel()
</syntaxhighlight>
{{OOP||[[player]]:getScriptDebugLevel|scriptDebugLevel}}


===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns an ''int'' with the local player's debug script level.
</section>
==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
<!-- Explain what the example is in a single sentance -->
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
This will show your debug script level on your screen.
Displays a message in the chat what is the player's debug level.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler('onClientRender', root, function()
function showdebug (player)
     dxDrawText("Debug Script Level: "..getPlayerScriptDebugLevel(localPlayer), 10, 10)
    local level = getPlayerScriptDebugLevel( player )
end)
     outputChatBox( "Your Script Debug Level: " .. level )
end
addCommandHandler ( "showdebug", showdebug )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{Player_functions}}
{{Shared_player_functions}}

Latest revision as of 17:18, 7 November 2024

This will allow you to retrieve the player current debug script level.

ADDED/UPDATED IN VERSION 1.6.0 r22592:

This function has a client-sided variant, which can only retrieve the local player's script debug level.

Syntax

Click to collapse [-]
Server
int getPlayerScriptDebugLevel( player thePlayer )

OOP Syntax Help! I don't understand this!

Method: player:getScriptDebugLevel(...)
Variable: .scriptDebugLevel
Counterpart: setPlayerScriptDebugLevel


Required Arguments

  • thePlayer: The person whose debug script level you want

Returns

Returns an int with the player debug script level, false if the player is invalid.

Click to collapse [-]
Client
int getPlayerScriptDebugLevel()

OOP Syntax Help! I don't understand this!

Method: player:getScriptDebugLevel(...)
Variable: .scriptDebugLevel


Returns

Returns an int with the local player's debug script level.

Example

Displays a message in the chat what is the player's debug level. 

function showdebug (player)
    local level = getPlayerScriptDebugLevel( player )
    outputChatBox( "Your Script Debug Level: " .. level )
end
addCommandHandler ( "showdebug", showdebug )

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/GetPlayerScriptDebugLevel?oldid=81233"