GetElementColShape: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: {{Server function}} __NOTOC__ This function is used to get element's colshape. ==Syntax== <syntaxhighlight lang="lua"> colshape getElementColShape ( element theElement ) </syntaxhighlight> ===Require...)
 
(Remove spaces)
 
(16 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Server function}}
{{Server client function}}
__NOTOC__  
__NOTOC__  
This function is used to get element's colshape.
Some elements have an associated colshape, for example [[Marker]] and [[Pickup]]. This function is used to get the associated colshape.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
colshape getElementColShape ( element theElement )        
colshape getElementColShape ( element theElement )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[element]]:getColShape|colShape|}}


===Required Arguments===  
===Required Arguments===  
Line 14: Line 15:
Returns ''colshape'' of the element, ''false'' if not or an invalid argument was passed to the function.
Returns ''colshape'' of the element, ''false'' if not or an invalid argument was passed to the function.


==Example==  
==Example==
<section class="server" name="Server" show="true">
This example creates a marker inside Toreno's house and adds a command to check whether you are standing on it.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
theMarker = createMarker( -687.9, 937.8, 13.6, "cylinder", 2.0, 255, 0, 0, 80 ) -- create a red cylinder marker inside Toreno's house


function checkOnMarker ( thePlayer )
    local isIn = isPlayerInMarker( thePlayer, theMarker ) -- use the function to check if player is in the marker
    if isIn then
        outputChatBox( "You are on the marker.", thePlayer )
    else
        outputChatBox( "You are not on the marker.", thePlayer )
    end
end
addCommandHandler ( "amionmarker", checkOnMarker )
-- define the isPlayerInMarker function
function isPlayerInMarker( thePlayer, theMarker )
local theShape = getElementColShape( theMarker ) -- get markers colshape
if isElementWithinColShape( thePlayer, theShape ) then -- check if the player is in it
return true
else -- he isn't on the marker
return false
end
end
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Element_functions}}
{{Element_functions}}
[[Category:Needs_Example]]
 
[[ar:getElementColShape]]
[[en:getElementColShape]]
[[hu:getElementColShape]]

Latest revision as of 18:45, 29 October 2023

Some elements have an associated colshape, for example Marker and Pickup. This function is used to get the associated colshape.

Syntax

colshape getElementColShape ( element theElement )

OOP Syntax Help! I don't understand this!

Method: element:getColShape(...)
Variable: .colShape


Required Arguments

  • theElement: The element you want to get the colshape of

Returns

Returns colshape of the element, false if not or an invalid argument was passed to the function.

Example

Click to collapse [-]
Server

This example creates a marker inside Toreno's house and adds a command to check whether you are standing on it. 

theMarker = createMarker( -687.9, 937.8, 13.6, "cylinder", 2.0, 255, 0, 0, 80 ) -- create a red cylinder marker inside Toreno's house

function checkOnMarker ( thePlayer )
    local isIn = isPlayerInMarker( thePlayer, theMarker ) -- use the function to check if player is in the marker
    if isIn then
        outputChatBox( "You are on the marker.", thePlayer )
    else
        outputChatBox( "You are not on the marker.", thePlayer )
    end
end
addCommandHandler ( "amionmarker", checkOnMarker )

-- define the isPlayerInMarker function
function isPlayerInMarker( thePlayer, theMarker )
	local theShape = getElementColShape( theMarker ) -- get markers colshape
	if isElementWithinColShape( thePlayer, theShape ) then -- check if the player is in it
		return true
	else -- he isn't on the marker
		return false
	end
end

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/GetElementColShape?oldid=78430"