GetMarkerColor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Reverted edits by Algeriany (talk) to last revision by Strix)
(11 intermediate revisions by 8 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
This function returns three [[int]]s corresponding to the amount of red, green and blue (respectively) in the marker's color. It can be useful for coloring objectives text to the same color as the marker.
{{Server client function}}
This function returns the color and transparency for a marker element. Not all marker types support transparency.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int int int getMarkerColor ( marker myMarker )
int, int, int, int getMarkerColor ( marker theMarker )
</syntaxhighlight>
</syntaxhighlight>
 
{{OOP||[[Marker]]:getColor||setMarkerColor}}
===Required Arguments===
===Required Arguments===
*'''myMarker''': The [[marker]] that you wish to retrieve the color of.
*'''theMarker''': The [[marker]] that you wish to retrieve the color of.


===Returns===
===Returns===
Returns three [[int]]s corresponding to the amount of red, green and blue (respectively) in the marker's color. If the function fails, it'll return ''false''. Check this by checking the ''red'' [[int]]'s value for ''false''.
Returns four [[int]]s corresponding to the amount of ''red'', ''green'', ''blue'' and ''alpha'' (respectively) of the marker, ''false'' if invalid arguments were passed.


==Example==
==Example==
<section name="Serverside example" class="server" show="true">
This example script fully heals players who hit a white marker, and kills players who hit a red one.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- Create a new marker
-- we define the function that will determine if the player is to be healed or killed
newMarker = createMarker ( 1, 1000, 1000, 1000, 1,0,0 )
function healOrKill ( hitMarker, matchingDimension )
-- Get the marker's color components into the three variables, red, green and blue.
-- if the marker was in a different dimension, stop here to ignore the event
red,green,blue = getMarkerColor ( newMarker )
if not matchingDimension then
if ( red ) then
return
outputChatBox ( ("Current marker color: " .. r .. "," .. g .. "," .. b .. ".") )
end
-- get the marker's color
local R, G, B, A = getMarkerColor( hitMarker )
-- if its RGB color is 255,255,255 (white),
if R == 255 and G == 255 and B == 255 then
-- heal the player
setElementHealth( source, 100 )
-- if it isn't white, but 255,0,0 (red),
elseif R == 255 and G == 0 and B == 0 then
-- kill the player
killPed( source )
end
end
end
-- add our function as a handler to "onPlayerMarkerHit"
addEventHandler( "onPlayerMarkerHit", getRootElement(), healOrKill )
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Marker}}
{{Marker functions}}

Revision as of 23:00, 26 September 2016

This function returns the color and transparency for a marker element. Not all marker types support transparency.

Syntax

int, int, int, int getMarkerColor ( marker theMarker )

OOP Syntax Help! I don't understand this!

Method: Marker:getColor(...)
Counterpart: setMarkerColor


Required Arguments

  • theMarker: The marker that you wish to retrieve the color of.

Returns

Returns four ints corresponding to the amount of red, green, blue and alpha (respectively) of the marker, false if invalid arguments were passed.

Example

Click to collapse [-]
Serverside example

This example script fully heals players who hit a white marker, and kills players who hit a red one. 

-- we define the function that will determine if the player is to be healed or killed
function healOrKill ( hitMarker, matchingDimension )
	-- if the marker was in a different dimension, stop here to ignore the event
	if not matchingDimension then
		return
	end
	-- get the marker's color
	local R, G, B, A = getMarkerColor( hitMarker )
	-- if its RGB color is 255,255,255 (white),
	if R == 255 and G == 255 and B == 255 then
		-- heal the player
		setElementHealth( source, 100 )
	-- if it isn't white, but 255,0,0 (red),
	elseif R == 255 and G == 0 and B == 0 then
		-- kill the player
		killPed( source )
	end
end
-- add our function as a handler to "onPlayerMarkerHit"
addEventHandler( "onPlayerMarkerHit", getRootElement(), healOrKill )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetMarkerColor?oldid=49316"