GetMarkerColor: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added useful example)
mNo edit summary
 
(10 intermediate revisions by 8 users not shown)
Line 4: Line 4:


==Syntax==
==Syntax==
<section name="Server and Client" class="both" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int int int int getMarkerColor ( marker theMarker )
int, int, int, int getMarkerColor ( marker theMarker )
</syntaxhighlight>
</syntaxhighlight>
 
{{OOP||[[Marker]]:getColor||setMarkerColor}}
===Required Arguments===
===Required Arguments===
*'''theMarker''': The [[marker]] that you wish to retrieve the color of.
*'''theMarker''': The [[marker]] that you wish to retrieve the color of.
Line 14: Line 13:
===Returns===
===Returns===
Returns four [[int]]s corresponding to the amount of ''red'', ''green'', ''blue'' and ''alpha'' (respectively) of the marker, ''false'' if invalid arguments were passed.
Returns four [[int]]s corresponding to the amount of ''red'', ''green'', ''blue'' and ''alpha'' (respectively) of the marker, ''false'' if invalid arguments were passed.
</section>


==Example==
==Example==
Line 31: Line 29:
if R == 255 and G == 255 and B == 255 then
if R == 255 and G == 255 and B == 255 then
-- heal the player
-- heal the player
setPlayerHealth( source, 100 )
setElementHealth( source, 100 )
-- if it isn't white, but 255,0,0 (red),
-- if it isn't white, but 255,0,0 (red),
elseif R == 255 and G == 0 and B == 0 then
elseif R == 255 and G == 0 and B == 0 then
-- kill the player
-- kill the player
killPlayer( source )
killPed( source )
end
end
end
end
-- add our function as a handler to "onPlayerMarkerHit"
-- add our function as a handler to "onPlayerMarkerHit"
addEventHandler( "onPlayerMarkerHit", getRootElement(), healOrKill )
addEventHandler( "onPlayerMarkerHit", root, healOrKill )
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>

Latest revision as of 19:22, 15 July 2024

This function returns the color and transparency for a marker element.

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", root, healOrKill )

See Also