GetPlayerMapOpacity: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0159|1.5.8|20945|This function allows to get the opacity of the radar map (F11).}} ==Syntax== <syntaxhighlight lang="lua">...")
 
 
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{New feature/item|3.0159|1.5.8|20945|This function allows to get the opacity of the radar map (F11).}}
{{Added feature/item|1.5.9|1.5.8|20945|This function allows to get the opacity of the radar map (F11).}}


==Syntax==
==Syntax==
Line 7: Line 7:
int getPlayerMapOpacity ( )
int getPlayerMapOpacity ( )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[Player]].getMapOpacity}}
{{OOP||[[player]].getMapOpacity}}


===Returns===
===Returns===
Returns an [[integer]] value from 0 to 255, where 0 is fully transparent and 255 is fully opaque.
Returns an [[integer]] with a value from 0 to 255, where 0 is fully transparent and 255 is fully opaque.


==Example==
==Example==
{{Example}}
<section name="Client" class="client" show="true">
This example implements a command that tells you what your current map opacity is.
<syntaxhighlight lang="lua">
function showMapOpacity()
-- We get the map opacity value
local mapOpacity = getPlayerMapOpacity()
-- We tell what the map opacity is to the player
outputChatBox("Your map's opacity is at "..mapOpacity, 0, 255, 0)
end
addCommandHandler("mapopacity", showMapOpacity)
</syntaxhighlight>
</section>


==Requirements==
==Requirements==

Latest revision as of 09:31, 12 October 2021

This function allows to get the opacity of the radar map (F11).

Syntax

int getPlayerMapOpacity ( )

OOP Syntax Help! I don't understand this!

Method: player.getMapOpacity(...)


Returns

Returns an integer with a value from 0 to 255, where 0 is fully transparent and 255 is fully opaque.

Example

Click to collapse [-]
Client

This example implements a command that tells you what your current map opacity is. 

function showMapOpacity()
	-- We get the map opacity value
	local mapOpacity = getPlayerMapOpacity()
	-- We tell what the map opacity is to the player
	outputChatBox("Your map's opacity is at "..mapOpacity, 0, 255, 0)
end
addCommandHandler("mapopacity", showMapOpacity)

Requirements

Minimum server version n/a
Minimum client version 1.5.8-9.20945

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 client="1.5.8-9.20945" />

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetPlayerMapOpacity?oldid=72901"