GetMarkerColor: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| (12 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
This function returns | {{Server client function}} | ||
This function returns the color and transparency for a marker element. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
int int int getMarkerColor ( marker | 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. | ||
===Returns=== | ===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. | ||
==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"> | ||
-- | -- 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 | |||
if ( | 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 | end | ||
-- add our function as a handler to "onPlayerMarkerHit" | |||
addEventHandler( "onPlayerMarkerHit", root, healOrKill ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
==See Also== | ==See Also== | ||
{{Marker functions}} | {{Marker functions}} | ||
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 exampleThis 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
- createMarker
- getMarkerColor
- getMarkerCount
- getMarkerIcon
- getMarkerSize
- getMarkerTarget
- getMarkerType
- setMarkerColor
- setMarkerIcon
- setMarkerSize
- setMarkerTarget
- setMarkerType
- isElementWithinMarker