Multi Theft Auto: Wiki - User contributions [en]

SetVehicleColor

2009-09-22T17:45:51Z

Dreft: /* Second example */

__NOTOC__
{{Server client function}}
This function will set the color of a vehicle. Each vehicle can have up to 4 colors, for different aspects of the vehicle. Most vehicles only use two of the colors.

==Syntax==
<section name="Server and Client" class="both" show="true">
<syntaxhighlight lang="lua">
bool setVehicleColor ( vehicle theVehicle, int color1, int color2, int color3, int color4 )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] that you wish to set the color of.
*'''color1:''' An integer indicating the first (main) color for the vehicle
*'''color2:''' An integer indicating the second color for the vehicle
*'''color3:''' An integer indicating the third color for the vehicle
*'''color4:''' An integer indicating the fourth color for the vehicle

The table below shows valid color ids:
{{Vehicle_colors}}

===Returns===
Returns ''true'' if vehicle's color was set, ''false'' if an invalid vehicle or invalid color ids were specified.
</section>

==Example==
<section name="Example 1" class="server" show="true">
This example implements a serverside ''set_vehicle_color'' console command.
<syntaxhighlight lang="lua">
-- Define our function that will handle the command
function consoleSetVehicleColor ( playerSource, commandName, col1, col2, col3, col4 )
-- If a player triggered this in-game
if ( playerSource ) then
-- Get the player's vehicle
playerVehicle = getPlayerOccupiedVehicle ( playerSource )
-- If the player is in a vehicle and we've got at least 1 parameter
if ( playerVehicle and col1 ) then
-- Get the vehicle's existing color and use it if fewer than 4 arguments were passed
exCol1, exCol2, exCol3, exCol4 = getVehicleColor ( playerVehicle )

if not col2 then col2 = exCol2 end
if not col3 then col3 = exCol3 end
if not col4 then col4 = exCol4 end

-- Set the vehicle's color
setVehicleColor ( playerVehicle, col1, col2, col3, col4 )
else
-- If we didn't get at least 1 parameter or the player doesn't have a vehicle, display some help text
outputConsole ( "This function will set your current vehicle's colors. A vehicle can have up to 4 colors.", playerSource )
outputConsole ( "Syntax: set_vehicle_color color1 [ color2 color3 color4 ]", playerSource )
outputConsole ( "You must be in a vehicle to use this function.", playerSource )
end
end
end

-- Register the command handler and attach it to the consoleSetVehicleColor function
addCommandHandler ( "set_vehicle_color", consoleSetVehicleColor )
</syntaxhighlight>
</section>

<section name="Example 2" class="server" show="true">
This example changes all vehicles color to random every 0.5 sec.
<syntaxhighlight lang="lua">
function randomVehColors()
for i, car in ipairs( getElementsByType( "vehicle" ) ) do
local color = {}
color[1] = math.random(0,126) -- random from 0 to 126, because colors is from 0 to 126
color[2] = math.random(0,126)
color[3] = math.random(0,126)
color[4] = math.random(0,126) -- we take 4 random numbers because setVehicleColor have parameters with 4 colors
setVehicleColor ( car, color[1], color[2], color[3], color[4] ) -- setting color to vehicle
end
end

setTimer( randomVehColors, 500, 0 ) -- timer changes all vehicles colors to random every 0.5 sec.
</syntaxhighlight>
</section>

==See Also==
{{Vehicle_functions}}

SetVehicleDoorsUndamageable

2009-09-22T17:35:50Z

Dreft: /* Example */

__NOTOC__
{{Server client function}}
This function makes a vehicle's doors undamageable, so they won't fall off when they're hit. Note that the vehicle '''has''' to be locked using [[setVehicleLocked]] for this setting to have any effect.

==Syntax==
<section name="Server and Client" class="both" show="true">
<syntaxhighlight lang="lua">
bool setVehicleDoorsUndamageable ( vehicle theVehicle, bool state )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] of which you wish to set the car door damageability.
*'''state:''' A boolean denoting whether the vehicle's doors are undamageable (''true'') or damageable (''false'').

===Returns===
Returns ''true'' if the damageability state was successfully changed, ''false'' if invalid arguments were passed.
</section>

==Example==
Here you can disable all vehicles doors damage with /nodamage, and enable it with /adddamage.
<syntaxhighlight lang="lua">
function doorsLikeGod()
for i, car in ipairs( getElementsByType ("vehicle") ) do
setVehicleDoorsUndamageable ( car, true )
end
outputChatBox("All vehicles doors is not damageable")
end
addCommandHandler("nodamage", doorsLikeGod)

function doorsNotLikeGod()
for i, car in ipairs( getElementsByType ("vehicle") ) do
setVehicleDoorsUndamageable ( car, false )
end
outputChatBox("Now everyone can kick vehicles doors and throw them away.")
end
addCommandHandler("adddamage", doorsNotLikeGod)
</syntaxhighlight>

==See Also==
{{Vehicle functions}}
[[Category:Needs Example]]

GetVehicleType

2009-09-22T17:27:53Z

Dreft: /* Second example */

__NOTOC__
{{Server client function}}
{{New feature|3|1.0|
This function retrieves the type of a vehicle (such as if it is a car or a boat).
}}
==Syntax==
<syntaxhighlight lang="lua">
string getVehicleType ( vehicle theVehicle )
</syntaxhighlight>

'''OR'''

<syntaxhighlight lang="lua">
string getVehicleType ( int modelId )
</syntaxhighlight>

===Required Arguments===
*'''vehicle:''' The vehicle element to get the type of.
*'''modelId:''' A vehicle model id

===Returns===
Returns a ''string'' with vehicle type or ''false'' if an invalid modelID has been supplied, or an empty string if the vehicle is blocked internally (some trailers).

Possible strings returned:
* '''Automobile''': Cars, vans and trucks
* '''Plane'''
* '''Bike''': Motorbikes
* '''Helicopter'''
* '''Boat'''
* '''Train'''
* '''Trailer''': A trailer for a truck
* '''BMX'''
* '''Monster Truck'''
* '''Quad''': Quadbikes

==Example==
In this example when a player enters an airplane, it displays a message welcoming the player onboard.
<syntaxhighlight lang="lua">
function enterPlane(theVehicle, seat, jacked)
if (getVehicleType(theVehicle) == "Plane") then
outputChatBox("Welcome onboard!", source)
end
end

addEventHandler("onPlayerVehicleEnter", getRootElement(), enterPlane)
</syntaxhighlight>

In this another example player gets message what type of vehicle he just entered.
<syntaxhighlight lang="lua">
function enteredVehicleType(theVehicle, seat, jacked)
outputChatBox("You entered ".. getVehicleType(theVehicle) ..".", source)
end
end

addEventHandler("onPlayerVehicleEnter", getRootElement(), enteredVehicleType)
</syntaxhighlight>

==See Also==
{{Vehicle functions}}

User:Dreft

2009-08-28T08:57:57Z

Dreft: Created page with 'w00t :o Everything is just creation...'

w00t :o

Everything is just creation...

User talk:Dreft

2009-08-28T08:57:31Z

Dreft: Created page with 'w00t :o Everything is just creation...'

w00t :o

Everything is just creation...