Multi Theft Auto: Wiki - User contributions [en]

GetVehicleSirenParams

2012-05-03T14:38:23Z

Snert: /* Returns */ Hopefully cleared up the return table for this function

__NOTOC__
{{Server client function}}
{{New feature/item|4.0140|1.4|3966|
This function get the parameters of a vehicles siren.
}}

==Syntax==
<syntaxhighlight lang="lua">
table getVehicleSirenParams ( vehicle theVehicle )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle to get the siren parameters of

===Returns===
Returns a ''table'' with the siren count, siren type and a sub table for the four flags. False otherwise.

<syntaxhighlight lang="lua">
[int] SirenParams.SirenCount
[int] SirenParams.SirenType
[table] SirenParams.Flags
[bool] SirenParams.Flags["360"]
[bool] SirenParams.Flags.DoLOSCheck
[bool] SirenParams.Flags.UseRandomiser
[bool] SirenParams.Flags.Silent
</syntaxhighlight>

==Example==
<section name="Server" class="server" show="true">
This example returns the vehicle parameters when the players presses g.
<syntaxhighlight lang="lua">addEventHandler("onVehicleEnter",root,function(player,seat)
if(player)and(seat==0)then
addVehicleSirens(source,1,1)
setVehicleSirens(source,1,0,0,0,100,0,100,255,122)
bindKey(player,"g","up",getSiren,source)
end
end)

function getSiren(player,button,state,vehicle)
local sirenParams = getVehicleSirenParams(vehicle)
outputChatBox("Here's the parameters of your vehicle sirens: Siren Points: "..tostring(sirenParams.SirenCount)..", Type of Siren: "..tostring(sirenParams.SirenType)..".",player)
end

addEventHandler("onVehicleExit",root,function(player,seat)
if(player)and(seat==0)then
removeVehicleSirens(source)
unbindKey(player,"g","up",getSiren)
end
end)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.4-3966|1.4-3966|}}

==See Also==
{{Vehicle_functions}}

GetVehicleSirenParams

2012-05-03T14:29:50Z

Snert: /* Example */ To example maker: Try to figure out why an example would return nil before actually posting it. A faulty example is as good as no example at all.

__NOTOC__
{{Server client function}}
{{New feature/item|4.0140|1.4|3966|
This function get the parameters of a vehicles siren.
}}

==Syntax==
<syntaxhighlight lang="lua">
table getVehicleSirenParams ( vehicle theVehicle )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle to get the siren parameters of

===Returns===
Returns a ''table'' with the siren count, siren type and a sub table for the four flags. False otherwise.

<syntaxhighlight lang="lua">
sirenParams = { sirenCount, sirenType, { is360, doLOSCheck, useRandomiser, silent } }
</syntaxhighlight>

==Example==
<section name="Server" class="server" show="true">
This example returns the vehicle parameters when the players presses g.
<syntaxhighlight lang="lua">addEventHandler("onVehicleEnter",root,function(player,seat)
if(player)and(seat==0)then
addVehicleSirens(source,1,1)
setVehicleSirens(source,1,0,0,0,100,0,100,255,122)
bindKey(player,"g","up",getSiren,source)
end
end)

function getSiren(player,button,state,vehicle)
local sirenParams = getVehicleSirenParams(vehicle)
outputChatBox("Here's the parameters of your vehicle sirens: Siren Points: "..tostring(sirenParams.SirenCount)..", Type of Siren: "..tostring(sirenParams.SirenType)..".",player)
end

addEventHandler("onVehicleExit",root,function(player,seat)
if(player)and(seat==0)then
removeVehicleSirens(source)
unbindKey(player,"g","up",getSiren)
end
end)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.4-3966|1.4-3966|}}

==See Also==
{{Vehicle_functions}}

Shader examples

2011-08-06T11:21:55Z

Snert: /* Block world */ Added note of how to get this shader working (Can anyone with access to the original ZIP file please fix this?)

This page contains some example shader resources to try in 1.1. If you are looking to make your own, please be sure to read about the [[Shader|shader element]] as well.
<br>
__TOC__
==Road shine==
[[Image:RoadShineScreen.jpg|200px|thumb|left|Road shine]]
<table border=0><tr><td valign=top height=170>
[http://nightly.mtasa.com/files/shaders/shader_roadshine.zip Download shader_roadshine.zip]   ''Requires Shader Model 2 graphics card''
<br><br>
This resource creates a light reflection effect on the ground (looks best when moving).
It uses a custom flag in the effect file to generate [http://en.wikipedia.org/wiki/Surface_normal surface normals] for the ground model:
<syntaxhighlight lang="lua">
int CUSTOMFLAGS
<
string createNormals = "yes";
>;</syntaxhighlight>
Surface normals are not usually present in the ground and building models, but are useful for creating lighting effects such as these.
</td></tr></table>

==Road shine 2==
[[Image:RoadShine2Screen.jpg|200px|thumb|left|Road shine 2]]
<table border=0><tr><td valign=top height=170>
[http://nightly.mtasa.com/files/shaders/shader_roadshine2.zip Download shader_roadshine2.zip]   ''Requires Shader Model 2 graphics card''
<br><br>
Bit more complicated than the first Road shine, as it tracks the sun or moon to calculate the position of the highlight.
The effect can be hard to see depending on the time of day.
<br><br>
Best used with the play resource as the model it modifies is near the initial spawn point.
</td></tr></table>

==UV scroll==
[[Image:UVScollScreen.jpg|200px|thumb|left|UV scroll]]
<table border=0><tr><td valign=top height=170>
[http://nightly.mtasa.com/files/shaders/shader_uv_scroll.zip Download shader_uv_scroll.zip]
<br><br>
This resource scrolls a texture from left to right. It doesn't use vertex or pixels shaders, so it should work on all hardware.
</td></tr></table>

==UV scripted==
[[Image:UVScriptedScreen.jpg|200px|thumb|left|UV scripted]]
<table border=0><tr><td valign=top height=170>
[http://nightly.mtasa.com/files/shaders/shader_uv_scripted.zip Download shader_uv_scripted.zip]
<br><br>
This resource controls a texture's UVs using Lua. It shows that anything is possible if you can imagine it.
</td></tr></table>

==Ped morph==
[[Image:PedMorphScreen.jpg|200px|thumb|left|Ped morph]]
<table border=0><tr><td valign=top height=170>
[http://nightly.mtasa.com/files/shaders/shader_ped_morph.zip Download shader_ped_morph.zip]   ''Requires Shader Model 2 graphics card''
<br><br>
This resource uses a vertex shader to modify the geometry of a ped model as it is rendered.
<br><br>
When the resource has started, use the 'k' and 'l' keys to change morph size. If you change your player's skin, restart the resource to modify the new model.
</td></tr></table>

==Ped shell==
[[Image:PedShellScreen.jpg|200px|thumb|left|Ped shell]]
<table border=0><tr><td valign=top height=170>
[http://nightly.mtasa.com/files/shaders/shader_ped_shell.zip Download shader_ped_shell.zip]   ''Requires Shader Model 2 graphics card''
<br><br>
This resource draws a translucent effect in a second render pass. The first pass is done by GTA, and the vertex shader is only applied in the second to add the effect 'on top' of the standard output.
<br><br>
When the resource has started, use the 'k' key to see the shell effect. If you change your player's skin, restart the resource to see the effect applied to the new model.
</td></tr></table>

==Car paint==
[[Image:CarPaintScreen.jpg|200px|thumb|left|Car paint]]
<table border=0><tr><td valign=top height=170>
[http://nightly.mtasa.com/files/shaders/shader_car_paint.zip Download shader_car_paint.zip]   ''Requires Shader Model 2 graphics card''
<br><br>
This resource shows you how to apply a shader to the vehicle models. The shader itself is not that great, so don't get your hopes up.
</td></tr></table>

==Water==
[[Image:WaterScreen.jpg|200px|thumb|left|Water]]
<table border=0><tr><td valign=top height=170>
[http://nightly.mtasa.com/files/shaders/shader_water.zip Download shader_water.zip]   ''Requires Shader Model 2 graphics card''
<br><br>
This resource applies a shader to the GTA world water. The Lua script shows how to use a timer to transfer the conventional water color setting to the shader.
</td></tr></table>

==Bloom==
[[Image:BloomScreen.jpg|200px|thumb|left|Bloom]]
<table border=0><tr><td valign=top height=170>
[http://nightly.mtasa.com/files/shaders/shader_bloom.zip Download shader_bloom.zip]   ''Requires Shader Model 2 graphics card''
<br><br>
This resource shows you how 'bounce' full screen effects using a render target pool. It also uses the new ''onClientHUDRender'' event to exclude the HUD from the effect.
</td></tr></table>

==Block world==
[[Image:BlockWorld.jpg|200px|thumb|left|Block world]]
<table border=0><tr><td valign=top height=170>
[http://nightly.mtasa.com/files/shaders/shader_block_world.zip Download block_world.zip]   ''Requires Shader Model 2 graphics card''
<br><br>
This resource makes the textures look all blocky. It also changes colors when the 'k' key is pressed.
<br><br>
'''Note:''' The script currently uses the wrong name for the shader file. To fix this, replace the two instances of:

color_world.fx

with:

block_world.fx
</td></tr></table>

OnClientHUDRender

2011-08-01T10:28:18Z

Snert: Created page with "__NOTOC__ {{Client event}} This event is triggered before GTA renders the HUD. This is particularly useful if you want to use dxUpdateScreenSource to capture the screen onto..."

__NOTOC__
{{Client event}}
This event is triggered before GTA renders the HUD. This is particularly useful if you want to use [[dxUpdateScreenSource]] to capture the screen onto a texture without capturing the HUD, or to alter HUD textures using [[Element/Shader|shaders]] before they are drawn onto the screen.

==Parameters==
''None''

==Source==
The [[event system#Event source|source]] of this event is the client's [[root element]].

==Example==
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>

==See Also==
===Other client events===
{{Client_other_events}}
===Client event functions===
{{Client_event_functions}}

[[Category:Needs Example]]

DxSetRenderTarget

2011-08-01T10:18:46Z

Snert:

{{Client function}}
__NOTOC__
{{New feature|3.0110|1.1|
Only available in 1.1
}}
This function changes the drawing destination for the dx functions. It can be used to select a previously created render target, or if called with no arguments, restore drawing directly to the screen.

==Syntax==
<syntaxhighlight lang="lua">
bool dxSetRenderTarget ( [ element renderTarget, bool clear = false ] )
</syntaxhighlight>

If no arguments are supplied, the screen is restored as the drawing destination.

===Optional Arguments===
*'''renderTarget:''' The render target element whose pixels we want to draw on.
*'''clear:''' If set to true, the render target will also be cleared.

===Returns===
Returns ''true'' if the render target was successfully changed, ''false'' otherwise.

==Usage restrictions==
*dxSetRenderTarget can only be called during the [[onClientRender]] and [[onClientHUDRender]] events.
*Items drawn with ''postGUI'' set to ''true'' will not appear on a custom render target.

==Example==
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot,
function()
myRenderTarget = dxCreateRenderTarget( 80, 100 ) -- Create a render target texture which is 80 x 100 pixels
end
)

addEventHandler( "onClientRender", root,
function()
if myRenderTarget then
dxSetRenderTarget( myRenderTarget ) -- Select custom render target
dxDrawText ( "Hello", 10, 20 ) -- The message 'Hello' will be drawn on myRenderTarget

dxSetRenderTarget() -- Select default render target
dxDrawText ( "Goodbye", 10, 20 ) -- The message 'Goodbye' will be drawn directly to the screen
end
end
)
</syntaxhighlight>

==See Also==
{{Drawing_functions}}

GetWaterColor

2011-06-25T22:22:31Z

Snert: Undo revision 26172 by Kamek (talk)

__NOTOC__
{{Server client function}}
This function returns the water color of the GTA world.

'''Note:''' The server can only return the water color, if it has actually been set by script.

==Syntax==
<syntaxhighlight lang="lua">
int, int, int, int getWaterColor ( )
</syntaxhighlight>

===Returns===
Returns 4 [[int|ints]], indicating the color of the water. (RGBA)

==Example==
<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>

==See Also==
{{Client water functions}}

2010-12-19T23:22:56Z

Template:Server events

2010-11-28T20:15:47Z

Snert:

*[[onBan]]
{{New feature|3.0110|1.1|
*[[onDebugMessage]]
*[[onSettingChange]]
}}
*[[onUnban]]

2010-11-27T18:00:52Z

Snert: Created page with "__NOTOC__ {{Server client function}} This function returns the water color of the GTA world. '''Note:''' The server can only return the water color, if it has actually been set ..."

Template:World functions

2010-11-27T17:55:14Z

Snert:

{{New feature|3.0110|1.1|
* [[areTrafficLightsLocked]]
}}
*[[getCloudsEnabled]]
*[[getGameSpeed]]
*[[getGravity]]
{{New feature|3.0110|1.1|
* [[getSkyGradient]]
}}
*[[getTime]]
{{New feature|3.0110|1.1|
* [[getTrafficLightState]]
* [[getWaterColor]]
}}
*[[getWeather]]
*[[getZoneName]]
*[[isGarageOpen]]
*[[resetSkyGradient]]
*[[setCloudsEnabled]]
*[[setGameSpeed]]
*[[setGarageOpen]]
*[[setGravity]]
*[[setMinuteDuration]]
*[[setSkyGradient]]
*[[setTime]]
{{New feature|3.0110|1.1|
* [[setTrafficLightState]]
* [[setTrafficLightsLocked]]
* [[setWaterColor]]
}}
*[[setWeather]]
*[[setWeatherBlended]]

SetWaterColor

2010-11-27T17:53:03Z

Snert:

__NOTOC__
{{Server client function}}
This function changes the water color of the GTA world.

{{New_feature|3.0110|1.1|
setWaterColor will work server-side as well. In 1.0.4 and lower, setWaterColor is only available client-side.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setWaterColor ( int red, int green, int blue, [ int alpha = 200 ] )
</syntaxhighlight>

===Required Arguments===
*'''red:''' The ''red'' value of the water, from 0 to 255.
*'''green:''' The ''green'' value of the water, from 0 to 255.
*'''blue:''' The ''blue'' value of the water, from 0 to 255.

===Optional Arguments===
{{OptionalArg}}
*'''alpha:''' The ''alpha'' (visibility) value of the water, from 0 to 255. Defaults to 200 if not declared.

===Returns===
Returns ''true'' if water color was set correctly, ''false'' if invalid values were passed.

==Example==
This example adds a command ''watercolor'' with which a player can change the water colour.
<syntaxhighlight lang="lua">
function changeWaterColor ( commandName, red, green, blue, alpha )
-- if alpha is input, then include it too
alpha = tonumber ( alpha ) or 200
red = tonumber ( red )
green = tonumber ( green )
blue = tonumber ( blue )
-- check if the colour values for red, green and blue are valid
if red and green and blue then
setWaterColor ( red, green, blue, alpha )
else
outputChatBox ( "Failed to change the water colour!" )
end
end
addCommandHandler ( "watercolor", changeWaterColor )
</syntaxhighlight>

==See Also==
{{Client water functions}}