IsElementWithinMarker: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (→‎Syntax: OOP)
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|This function is also a static function underneath the Element class.|[[element]]:isWithinMarker||}}


===Required Arguments===
===Required Arguments===

Revision as of 16:33, 16 August 2014

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!

Note: This function is also a static function underneath the Element class.
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

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

function duty(thePlayer, matchingDimension)
 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