Multi Theft Auto: Wiki - User contributions [en]

CreateColPolygon

2010-05-11T22:27:43Z

Brophy:

__NOTOC__
{{Server client function}}
{{Note_box|For this function to work correctly, get/set your bound points in an anti-clockwise fashion.}}
This function creates a collision polygon. See [http://en.wikipedia.org/wiki/Polygon Wikipedia] for a definition of a polygon. The first set of X Y of this shape is not part of the colshape bounds, so can set anywhere in the game world, however for performance, place it somewhere within the polygon. It should be noted this shape is '''2D'''. There should be at least 3 bound points set.

==Syntax==
<syntaxhighlight lang="lua">
colshape createColPolygon ( float fX, float fY, float fX1, float fY1, float fX2, float fY2, float fX3, float fY3, ... )
</syntaxhighlight>

===Required Arguments===
*'''fX:''' The X position of the collision polygon's dummy point
*'''fY:''' The Y position of the collision polygon's dummy point
*'''fX1:''' The 1st X position of the collision polygon's bound point
*'''fY1:''' The 1st Y position of the collision polygon's bound point
*'''fX2:''' The 2nd X position of the collision polygon's bound point
*'''fY2:''' The 2nd Y position of the collision polygon's bound point
*'''fX3:''' The 3rd X position of the collision polygon's bound point
*'''fY3:''' The 3rd Y position of the collision polygon's bound point
*'''...''' From the 3rd position you can have as many points as you require to create the colshape.

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

==Example==
<section name="Server" class="server" show="true">
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">
theZone = false

function shapeHit ( thePlayer )
outputChatBox ( getPlayerName ( thePlayer ) .. " is in the zone!" ) -- display a message in everyone's chat box
end

function setZone ( playerSource, commandName, fX, fY, fX1, fY1, fX2, fY2, fX3, fY3 ) --Remember that after the 3rd position you
--can have as many points as you require to
--create the colshape.

if ( fY and fX and fX1 and fY1 and fX2 and fX3 and fY3 ) then -- check we've got the 8 args we need
local tempCol = createColPolygon ( fX, fY, fX1, fY1, fX2, fY2, fX3, fY3 ) -- create a col
if ( tempCol == false ) then -- did the col get created successfully?
outputConsole ("Syntax is: set_zone <X> <Y> <X1> <Y1> <X2> <Y2> <X3> <Y3>")-- 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
else
addEventHandler ( "onColShapeHit", theZone, shapeHit ) -- add a handler for the onColShapeHit event
end
theZone = tempCol -- and store the new zone we've made
outputChatBox ( "Zone has moved!" ) -- and tell everyone
end
end
end
addCommandHandler ( "set_zone", setZone ) -- add a console function called set_zone that will trigger the function setZone
</syntaxhighlight>
</section>

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

CreateColPolygon

2010-05-11T22:24:27Z

Brophy:

__NOTOC__
{{Server client function}}
This function creates a collision polygon. See [http://en.wikipedia.org/wiki/Polygon Wikipedia] for a definition of a polygon. The first set of X Y of this shape is not part of the colshape bounds, so can set anywhere in the game world, however for performance, place it somewhere within the polygon. It should be noted this shape is '''2D'''. There should be at least 3 bound points set.

Please Note: For this function to work correctly, get/set your bound points in an anti-clockwise fashion.

==Syntax==
<syntaxhighlight lang="lua">
colshape createColPolygon ( float fX, float fY, float fX1, float fY1, float fX2, float fY2, float fX3, float fY3, ... )
</syntaxhighlight>

===Required Arguments===
*'''fX:''' The X position of the collision polygon's dummy point
*'''fY:''' The Y position of the collision polygon's dummy point
*'''fX1:''' The 1st X position of the collision polygon's bound point
*'''fY1:''' The 1st Y position of the collision polygon's bound point
*'''fX2:''' The 2nd X position of the collision polygon's bound point
*'''fY2:''' The 2nd Y position of the collision polygon's bound point
*'''fX3:''' The 3rd X position of the collision polygon's bound point
*'''fY3:''' The 3rd Y position of the collision polygon's bound point
*'''...''' From the 3rd position you can have as many points as you require to create the colshape.

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

==Example==
<section name="Server" class="server" show="true">
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">
theZone = false

function shapeHit ( thePlayer )
outputChatBox ( getPlayerName ( thePlayer ) .. " is in the zone!" ) -- display a message in everyone's chat box
end

function setZone ( playerSource, commandName, fX, fY, fX1, fY1, fX2, fY2, fX3, fY3 ) --Remember that after the 3rd position you
--can have as many points as you require to
--create the colshape.

if ( fY and fX and fX1 and fY1 and fX2 and fX3 and fY3 ) then -- check we've got the 8 args we need
local tempCol = createColPolygon ( fX, fY, fX1, fY1, fX2, fY2, fX3, fY3 ) -- create a col
if ( tempCol == false ) then -- did the col get created successfully?
outputConsole ("Syntax is: set_zone <X> <Y> <X1> <Y1> <X2> <Y2> <X3> <Y3>")-- 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
else
addEventHandler ( "onColShapeHit", theZone, shapeHit ) -- add a handler for the onColShapeHit event
end
theZone = tempCol -- and store the new zone we've made
outputChatBox ( "Zone has moved!" ) -- and tell everyone
end
end
end
addCommandHandler ( "set_zone", setZone ) -- add a console function called set_zone that will trigger the function setZone
</syntaxhighlight>
</section>

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

Element/Vehicle

2009-12-26T17:54:23Z

Brophy:

__NOTOC__
The vehicle class represents vehicles in the GTA world. Vehicles can be occupied and controlled by players.

The element type of this class is '''"vehicle"'''.

==XML syntax==
<syntaxhighlight lang="xml">
<vehicle model="" posX="" posY="" posZ="" rotX="" rotY="" rotZ="" color="" upgrades="" paintjob="" plate="" turretX="" turretY="" health="" sirens="" landingGearDown="" specialState="" locked="" interior="" dimension=""/>
</syntaxhighlight>

===Required Attributes===
* '''model''': The [[Vehicle IDs|vehicle ID]] of the vehicle being created.
* '''posX''': A float representing the X position of the vehicle.
* '''posY''': A float representing the Y position of the vehicle.
* '''posZ''': A float representing the Z position of the vehicle.

===Optional Attributes===
* '''rotX''': A float representing the X rotation of the vehicle.
* '''rotY''': A float representing the Y rotation of the vehicle.
* '''rotZ''': A float representing the Z rotation of the vehicle.
* '''color''': An integer indicating the vehicle's [[Vehicle Colors|color(s)]] (seperated by commas).
* '''upgrades''': An integer representing the vehicle's mod upgrade(s) (seperated by commas), defined in San Andreas\data\maps\veh_mods\veh_mods.ide
* '''paintjob''': An integer indicating the vehicle's paint job (only works on certain vehicles).
* '''plate''': A set of up to 8 characters that will be shown on the vehicle's license plate.
* '''turretX''': the vehicle's turret's rotation around the Z axis, in radians. Relative to the vehicle's rotation, i.e. turretX=0 will always make the turret point in the same direction as the vehicle.
* '''turretY''': the vehicle's turret's rotation around the X axis, in radians. 0 means horizontal, positive values will make it point up and negative values point it down.
* '''health''': the vehicle's health. A value of 1000 means completely healthy, although higher values are allowed.
* '''sirens''': whether or not the vehicle's sirens are on (e.g. police cars and ambulances). Possible values are "true" and "false".
* '''landingGearDown''': whether or not the vehicle's landing gear is down (only applicable to planes). Possible values are "true" and "false".
* '''locked''': whether or not the vehicle's doors are locked. "true" or "false".
* '''interior''': the interior number of the vehicle
* '''dimension''': the dimension number of the vehicle

==Related scripting functions==
{{Vehicle functions}}
[[Category:Element Types]]

[[it:Elemento/Veicolo]]

User:Brophy

2009-08-30T10:10:55Z

Brophy: Created page with 'IJs and ChrML fear BrophY <br /><br /> Image:BatChild.jpg'

IJs and ChrML fear BrophY
<br /><br />
[[Image:BatChild.jpg]]