GetPlayerBlurLevel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (fix oop syntax)
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__
{{Server client function}}
This function allows you to check the current blur level of a specified [[player]].
==Syntax==
==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int getPlayerBlurLevel ( player thePlayer )
int getPlayerBlurLevel ( player thePlayer )
</syntaxhighlight>
</syntaxhighlight>
[[Category:Incomplete]]
{{OOP||[[player]]:getBlurLevel||setPlayerBlurLevel}}
===Required Arguments===
*'''thePlayer:''' The [[player]] whose blur level you want to check.
 
===Returns===
Returns the player's blur level if successful, ''false'' if an invalid player was given.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
int getBlurLevel ()
</syntaxhighlight>
{{OOP||[[Player]].getBlurLevel|blurLevel|setPlayerBlurLevel}}
===Returns===
Returns the local blur level.
</section>


==Example==  
==Example==
<!-- Explain what the example is in a single sentance -->
<section name="Server" class="server" show="true">
This will show the blur level to the player.
This example adds a command ''blurlevel'' with which you can check your current blur level.
<!-- 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 -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function changeBlurLevel(playerSource)
function checkBlurLevel( playerSource )
     local blur = getPlayerBlurLevel(playerSource)
     local blur = getPlayerBlurLevel( playerSource )
     outputChatBox("Blur level: " .. blur, playerSource)
     if blur then
        outputChatBox( "Blur level: " .. blur, playerSource )
    end
end
end
addCommandHandler("blurlevel", changeBlurLevel)
addCommandHandler("blurlevel", checkBlurLevel)
-- Type /blurlevel to check the blur level
</syntaxhighlight>
</syntaxhighlight>
</section>
==See Also==
{{Player functions}}

Latest revision as of 04:13, 29 December 2014

This function allows you to check the current blur level of a specified player.

Syntax

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

OOP Syntax Help! I don't understand this!

Method: player:getBlurLevel(...)
Counterpart: setPlayerBlurLevel


Required Arguments

  • thePlayer: The player whose blur level you want to check.

Returns

Returns the player's blur level if successful, false if an invalid player was given.

Click to collapse [-]
Client
int getBlurLevel ()

OOP Syntax Help! I don't understand this!

Method: Player.getBlurLevel(...)
Variable: .blurLevel
Counterpart: setPlayerBlurLevel


Returns

Returns the local blur level.

Example

Click to collapse [-]
Server

This example adds a command blurlevel with which you can check your current blur level. 

function checkBlurLevel( playerSource )
    local blur = getPlayerBlurLevel( playerSource )
    if blur then
        outputChatBox( "Blur level: " .. blur, playerSource )
    end
end
addCommandHandler("blurlevel", checkBlurLevel)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetPlayerBlurLevel?oldid=43552"