CreateColCircle: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 3: Line 3:


__NOTOC__  
__NOTOC__  
This function is for blahblah.. not defined yet
This function creates a collision circle. This is a shape that has a position and a radius and infinite height that you can use to detect a player's presence. Events will be triggered when a player enters or leaves it.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
INSERT SYNTAX HERE             
colshape createColCircle ( float fX, float fY, float fZ, float radius )           
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''argumentName:''' description
*'''fX:''' The collision circle's center point's X axis position
 
*'''fY:''' The collision circle's center point's Y axis position
===Optional Arguments===
*'''fZ:''' The collision circle's center point's Z axis position
{{OptionalArg}}
*'''radius''' The radius of the collision circle
*'''argumentName2:''' descriptiona
*'''argumentName3:''' description


===Returns===
===Returns===
Returns ''true'' if blah, ''false'' otherwise.
Returns a [[colshape]] element if successful, ''false'' if invalid arguments were passed to the function.


==Example==  
==Example==  
This example does...
This example displays a chat message when a player enters the colshape and allows the colshape to be created using a console function ''set_zone''.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
theZone = false
blabhalbalhb --abababa
 
--This line does this...
addCommandHandler ( "set_zone", "setZone" ) -- add a console function called set_zone that will trigger the function setZone
mooo
function setZone ( playerSource, commandName, fX, fY, fZ )
    if ( fZ and fY and fX ) then -- check we've got all 3 args we need
        local tempCol = createColCircle ( fX, fY, fZ, 10.0 ) -- create a col
        if ( tempCol == false ) then -- did the col get created successfully?
            outputConsole ( "Syntax is: set_zone <X> <Y> <Z>" ) -- inform the user what the valid syntax is
        else
            if ( theZone != false ) then -- did we already have a zone?
                destroyElement ( theZone ) -- if so, destroy it
            end
            theZone = tempCol -- and store the new zone we've made
            outputChat ( "Zone has moved!" ) -- and tell everyone
        end
    end
end
 
addEventHandler ( "onColShapeHit", getRootElement(), "shapeHit" ) -- add a handler for the onColShapeHit event
function shapeHit ( thePlayer )
    outputChatBox ( getClientName ( thePlayer ) .. " is in the zone!" ) -- display a message in everyone's chat box
end
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{FunctionArea_Functions}}
{{Collision shape functions}}

Revision as of 13:05, 11 September 2006


This function creates a collision circle. This is a shape that has a position and a radius and infinite height that you can use to detect a player's presence. Events will be triggered when a player enters or leaves it.

Syntax

colshape createColCircle ( float fX, float fY, float fZ, float radius )

Required Arguments

  • fX: The collision circle's center point's X axis position
  • fY: The collision circle's center point's Y axis position
  • fZ: The collision circle's center point's Z axis position
  • radius The radius of the collision circle

Returns

Returns a colshape element if successful, false if invalid arguments were passed to the function.

Example

This example displays a chat message when a player enters the colshape and allows the colshape to be created using a console function set_zone. 

theZone = false

addCommandHandler ( "set_zone", "setZone" ) -- add a console function called set_zone that will trigger the function setZone
function setZone ( playerSource, commandName, fX, fY, fZ )
    if ( fZ and fY and fX ) then -- check we've got all 3 args we need
        local tempCol = createColCircle ( fX, fY, fZ, 10.0 ) -- create a col
        if ( tempCol == false ) then -- did the col get created successfully?
            outputConsole ( "Syntax is: set_zone <X> <Y> <Z>" ) -- inform the user what the valid syntax is
        else
            if ( theZone != false ) then -- did we already have a zone?
                destroyElement ( theZone ) -- if so, destroy it
            end
            theZone = tempCol -- and store the new zone we've made
            outputChat ( "Zone has moved!" ) -- and tell everyone
        end
    end
end

addEventHandler ( "onColShapeHit", getRootElement(), "shapeHit" ) -- add a handler for the onColShapeHit event
function shapeHit ( thePlayer ) 
    outputChatBox ( getClientName ( thePlayer ) .. " is in the zone!" ) -- display a message in everyone's chat box
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/CreateColCircle?oldid=4901"