IsElementWithinMarker: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with '{{Server client function}} __NOTOC__ This function is used to determine if an element is within a marker. ==Syntax== <syntaxhighlight lang="lua">bool isElementWithinMarker ( element th…')
 
 
(12 intermediate revisions by 7 users not shown)
Line 5: Line 5:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool isElementWithinMarker ( element theElement, marker theMarker )</syntaxhighlight>
<syntaxhighlight lang="lua">bool isElementWithinMarker ( element theElement, marker theMarker )</syntaxhighlight>
{{OOP||[[element]]:isWithinMarker||}}


===Required Arguments===
===Required Arguments===
*'''theElement:''' The [[element]] you're checking.
*'''theElement:''' The [[element]] you're checking.
*'''theShape:''' The [[marker]] you're checking
*'''theMarker:''' The [[marker]] you're checking.


===Returns===
===Returns===
Line 15: Line 16:
==Example==
==Example==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
local dutymarker = createMarker(126.56, 254.98, 78.9, "cylinder", 2.0, 255, 0, 0, 150)
 
function duty(thePlayer)
    if isElementWithinMarker(thePlayer, dutymarker) then
        giveWeapon(thePlayer, 22, 100, 1) 
    else
        outputChatBox("You are not at the right place!", thePlayer, 255, 0, 0)
    end
end
addCommandHandler("duty", duty)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Marker functions}}
{{Marker functions}}
[[ru:isElementWithinMarker]]

Latest revision as of 10:53, 18 August 2018

This function is used to determine if an element is within a marker.

Syntax

bool isElementWithinMarker ( element theElement, marker theMarker )

OOP Syntax Help! I don't understand this!

Method: element:isWithinMarker(...)


Required Arguments

  • theElement: The element you're checking.
  • theMarker: The marker you're checking.

Returns

Returns true if the element is within the marker, false otherwise

Example

local dutymarker = createMarker(126.56, 254.98, 78.9, "cylinder", 2.0, 255, 0, 0, 150)

function duty(thePlayer)
    if isElementWithinMarker(thePlayer, dutymarker) then
        giveWeapon(thePlayer, 22, 100, 1)  
    else
        outputChatBox("You are not at the right place!", thePlayer, 255, 0, 0)
    end
end
addCommandHandler("duty", duty)

See Also