getElementColShape

Client-side

Server-side

Shared

This page is incomplete! Help wanted!

Please finish this page using the corresponding Old Wiki article.
Go to Contribution guidelines for more information.

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

Syntax

 getElementColShape ( )

Code Examples

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

getElementColShape

Syntax

Code Examples

See Also

Element Functions

Element Events

Reference