https://wiki.multitheftauto.com/api.php?action=feedcontributions&feedformat=atom&user=TEDERIsMulti Theft Auto: Wiki - User contributions [en]2026-04-17T19:30:49ZUser contributionsMediaWiki 1.39.3https://wiki.multitheftauto.com/index.php?title=EngineLoadIMG&diff=81704EngineLoadIMG2025-01-13T07:31:57Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
{{New feature/item|3.0161|1.6.0|21708|This function loads an IMG container into GTA.<br />
}}<br />
{{Note|<br />
If you're experiencing crashes/game hangs with default values, try to adjust memory/buffer/cache sizes with [[engineStreamingSetMemorySize]], [[engineStreamingSetBufferSize]] and/or [[engineStreamingSetModelCacheLimits]].}}<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
img engineLoadIMG ( string img_file )<br />
</syntaxhighlight><br />
{{OOP||[[DFF|EngineIMG]]}}<br />
===Required Arguments===<br />
* '''img_file''': The [[filepath]] to the [[IMG]] file you want to load.<br />
<br />
===Returns===<br />
Returns an [[IMG]] element if the [[IMG]] file loaded, ''false'' otherwise.<br />
<br />
===Examples===<br />
This example loads IMG file from directory and then prints number of files in it<br />
<syntaxhighlight lang="lua"><br />
local img = engineLoadIMG('file.img')<br />
<br />
iprint('Number of files: ',#engineImageGetFiles(img))<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Engine_functions}}<br />
<br />
[[Category:Changes in 1.6.0]]</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=CreateTeam&diff=81693CreateTeam2025-01-11T11:19:46Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__<br />
{{Server function}}<br />
This function is for creating a new [[team]], which can be used to group players. Players will not join the team until they are respawned.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
team createTeam ( string teamName [, int colorR = 235, int colorG = 221, int colorB = 178 ] )<br />
</syntaxhighlight><br />
{{OOP||Team.create||}}<br />
===Required Arguments===<br />
*'''teamName:''' A string representing the teams name.<br />
===Optional Arguments=== <br />
*'''colorR:''' An integer representing the red color value.<br />
*'''colorG:''' An integer representing the green color value.<br />
*'''colorB:''' An integer representing the blue color value.<br />
<br />
===Returns===<br />
Returns a team element if it was successfully created, ''false'' if invalid arguments are passed or a team with that name already exists.<br />
<br />
==Example==<br />
'''Example 1:''' This example creates a new team for a player, then adds him to it.<br />
<syntaxhighlight lang="lua"><br />
function gimmeATeam(source, commandName, teamName)<br />
local newTeam = createTeam(teamName) -- create a new team with the specified name<br />
if newTeam then -- if it was successfully created<br />
setPlayerTeam(source, newTeam) -- add the player to the new team<br />
end<br />
end<br />
addCommandHandler("giveteam", gimmeATeam)<br />
</syntaxhighlight><br />
<br />
'''Example 2:''' This example creates two teams, one for Admin and one for Freeroamers, when the resource this script is in is started.<br />
<syntaxhighlight lang="lua"><br />
function createTeamsOnStart()<br />
teamAdmmin = createTeam("Admin", 0, 255, 0) -- change the 3 numbers(0,255,0), the first number is ColourR, the second is ColourG, and the last one is ColourB<br />
teamFreeroamers = createTeam("Freeroamer", 200, 0, 100)<br />
end<br />
addEventHandler("onResourceStart", resourceRoot, createTeamsOnStart) -- we attach the function to this resource's root element<br />
</syntaxhighlight><br />
<br />
'''Example 3:''' This example creates a team for Admin and when an admin logs in, he will be set in the Admin team.<br />
<syntaxhighlight lang="lua"><br />
function createAdminTeamOnStart()<br />
AdminTeam = createTeam("Admin", 0, 255, 0) -- create a new team and name it 'Admin'<br />
end<br />
addEventHandler("onResourceStart", resourceRoot, createAdminTeamOnStart) -- add an event handler<br />
<br />
function setAdminTeam()<br />
if isObjectInACLGroup("user." .. getAccountName(getPlayerAccount(source)), aclGetGroup("Admin")) then -- if he is admin<br />
setPlayerTeam(source, AdminTeam) -- set him to admin team<br />
end<br />
end<br />
addEventHandler("onPlayerLogin", root, setAdminTeam) -- add an event handler<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Team_functions|server}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxDrawModel3D&diff=81629DxDrawModel3D2025-01-03T16:10:49Z<p>TEDERIs: /* Syntax */</p>
<hr />
<div>__NOTOC__ <br />
{{Client function}} <br />
{{Important Note|You can not use this function to draw vehicles and ped}}<br />
{{Important Note|This function doesn't obey any streaming limits, you can draw as many models as you want}}<br />
{{Important Note|You can not render model to render target.}}<br />
{{New feature/item|3.0161|1.6.0|22708|<br />
This function draws a 3D model - rendered for '''one''' frame. Drawn models are indistinguishable from this one created by [[createObject]] function. This should be used in conjunction with [[onClientRender]] or [[onClientPreRender]] in order to display continuously. Note that a model must be loaded at the time this function is called. A model can be loaded and unloaded with the help of [[engineStreamingRequestModel]] and [[engineStreamingReleaseModel]] functions.<br />
}}<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool dxDrawModel3D( int modelId, float positionX, float positionY, float positionZ, float rotationX, float rotationY, float rotationZ [, float scaleX = 1, float scaleY = 1, float scaleZ = 1, float lighting = 0 ])<br />
</syntaxhighlight><br />
<br />
[[Image:DxDrawModel3D_at_day.png|thumb|Model during day]]<br />
[[Image:DxDrawModel3D_at_night.png|thumb|Model during night]]<br />
<br />
===Required Arguments=== <br />
* '''modelId:''' Model you want to draw, must be regular object, you can not draw vehicles and peds<br />
* '''positionX/Y/Z:''' Position of model<br />
* '''rotationX/Y/Z:''' Rotation of model<br />
<br />
===Optional Arguments===<br />
* '''scaleX/Y/Z:''' Scale of model, by default {1,1,1}<br />
{{New feature/item|3.0161|1.6.0|22862|<br />
*'''lighting:''' Lighting of model. Allowed range is [0, 1].<br />
}}<br />
<br />
<br />
===Returns===<br />
Returns true if the operation was successful, false otherwise.<br />
<br />
==Example== <br />
<section name="Client" class="client" show="true"><br />
Simple example<br />
<syntaxhighlight lang="lua"><br />
addEventHandler("onClientPreRender", root, function()<br />
engineStreamingRequestModel(3276)<br />
dxDrawModel3D(3276, -719.64984, 951.26685, 12.13281, 0, 0,90)<br />
end)<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Drawing_functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxDrawModel3D&diff=81628DxDrawModel3D2025-01-03T16:10:15Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}} <br />
{{Important Note|You can not use this function to draw vehicles and ped}}<br />
{{Important Note|This function doesn't obey any streaming limits, you can draw as many models as you want}}<br />
{{Important Note|You can not render model to render target.}}<br />
{{New feature/item|3.0161|1.6.0|22708|<br />
This function draws a 3D model - rendered for '''one''' frame. Drawn models are indistinguishable from this one created by [[createObject]] function. This should be used in conjunction with [[onClientRender]] or [[onClientPreRender]] in order to display continuously. Note that a model must be loaded at the time this function is called. A model can be loaded and unloaded with the help of [[engineStreamingRequestModel]] and [[engineStreamingReleaseModel]] functions.<br />
}}<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"> =<br />
bool dxDrawModel3D( int modelId, float positionX, float positionY, float positionZ, float rotationX, float rotationY, float rotationZ [, float scaleX = 1, float scaleY = 1, float scaleZ = 1, float lighting = 0 ])<br />
</syntaxhighlight><br />
<br />
[[Image:DxDrawModel3D_at_day.png|thumb|Model during day]]<br />
[[Image:DxDrawModel3D_at_night.png|thumb|Model during night]]<br />
<br />
===Required Arguments=== <br />
* '''modelId:''' Model you want to draw, must be regular object, you can not draw vehicles and peds<br />
* '''positionX/Y/Z:''' Position of model<br />
* '''rotationX/Y/Z:''' Rotation of model<br />
<br />
===Optional Arguments===<br />
* '''scaleX/Y/Z:''' Scale of model, by default {1,1,1}<br />
{{New feature/item|3.0161|1.6.0|22862|<br />
*'''lighting:''' Lighting of model. Allowed range is [0, 1].<br />
}}<br />
<br />
<br />
===Returns===<br />
Returns true if the operation was successful, false otherwise.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
==Example== <br />
<section name="Client" class="client" show="true"><br />
Simple example<br />
<syntaxhighlight lang="lua"><br />
addEventHandler("onClientPreRender", root, function()<br />
engineStreamingRequestModel(3276)<br />
dxDrawModel3D(3276, -719.64984, 951.26685, 12.13281, 0, 0,90)<br />
end)<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Drawing_functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxDrawModel3D&diff=80120DxDrawModel3D2024-09-05T12:37:44Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}} <br />
{{Important Note|You can not use this function to draw vehicles and ped}}<br />
{{Important Note|This function doesn't obey any streaming limits, you can draw as many models as you want}}<br />
{{Important Note|You can not render model to render target.}}<br />
{{New feature/item|3.0161|1.6.0|22708|<br />
This function draws a 3D model - rendered for '''one''' frame. Drawn models are indistinguishable from this one created by [[createObject]] function. This should be used in conjunction with [[onClientRender]] or [[onClientPreRender]] in order to display continuously. Note that a model must be loaded at the time this function is called. A model can be loaded and unloaded with the help of [[engineStreamingRequestModel]] and [[engineStreamingReleaseModel]] functions.<br />
}}<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool dxDrawModel3D( int modelId, float positionX, float positionY, float positionZ, float rotationX, float rotationY, float rotationZ [, float scaleX, float scaleY, float scaleZ ])<br />
</syntaxhighlight><br />
<br />
[[Image:DxDrawModel3D_at_day.png|thumb|Model during day]]<br />
[[Image:DxDrawModel3D_at_night.png|thumb|Model during night]]<br />
<br />
===Required Arguments=== <br />
* '''modelId:''' Model you want to draw, must be regular object, you can not draw vehicles and peds<br />
* '''positionX/Y/Z:''' Position of model<br />
* '''rotationX/Y/Z:''' Rotation of model<br />
<br />
===Optional Arguments===<br />
* '''scaleX/Y/Z:''' Scale of model, by default {1,1,1}<br />
<br />
===Returns===<br />
Returns true if the operation was successful, false otherwise.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
==Example== <br />
<section name="Client" class="client" show="true"><br />
Simple example<br />
<syntaxhighlight lang="lua"><br />
addEventHandler("onClientPreRender", root, function()<br />
engineStreamingRequestModel(3276)<br />
dxDrawModel3D(3276, -719.64984, 951.26685, 12.13281, 0, 0,90)<br />
end)<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Drawing_functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxDrawModel3D&diff=80119DxDrawModel3D2024-09-05T12:31:24Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}} <br />
{{Important Note|You can not use this function to draw vehicles and ped}}<br />
{{Important Note|This function doesn't obey any streaming limits, you can draw as many models as you want}}<br />
{{Important Note|You can not render model to render target.}}<br />
{{New feature/item|3.0161|1.6.0|22708|<br />
This function draws a 3D model - rendered for '''one''' frame. Drawn models are indistinguishable from this one created by [[createObject]] function. This should be used in conjunction with [[onClientRender]] or [[onClientPreRender]] in order to display continuously. <br />
}}<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool dxDrawModel3D( int modelId, float positionX, float positionY, float positionZ, float rotationX, float rotationY, float rotationZ [, float scaleX, float scaleY, float scaleZ ])<br />
</syntaxhighlight><br />
<br />
[[Image:DxDrawModel3D_at_day.png|thumb|Model during day]]<br />
[[Image:DxDrawModel3D_at_night.png|thumb|Model during night]]<br />
<br />
===Required Arguments=== <br />
* '''modelId:''' Model you want to draw, must be regular object, you can not draw vehicles and peds<br />
* '''positionX/Y/Z:''' Position of model<br />
* '''rotationX/Y/Z:''' Rotation of model<br />
<br />
===Optional Arguments===<br />
* '''scaleX/Y/Z:''' Scale of model, by default {1,1,1}<br />
<br />
===Returns===<br />
Returns true if the operation was successful, false otherwise.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
==Example== <br />
<section name="Client" class="client" show="true"><br />
Simple example<br />
<syntaxhighlight lang="lua"><br />
addEventHandler("onClientPreRender", root, function()<br />
dxDrawModel3D(3276, -719.64984, 951.26685, 12.13281, 0, 0,90)<br />
end)<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Drawing_functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxDrawModel3D&diff=80118DxDrawModel3D2024-09-05T12:30:25Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}} <br />
{{Important Note|You can not use this function to draw vehicles and ped}}<br />
{{Important Note|This function doesn't obey any streaming limits, you can draw as many models as you want}}<br />
{{Important Note|You can not render model to render target.}}<br />
{{New feature/item|3.0161|1.6.0|22271|<br />
This function draws a 3D model - rendered for '''one''' frame. Drawn models are indistinguishable from this one created by [[createObject]] function. This should be used in conjunction with [[onClientRender]] or [[onClientPreRender]] in order to display continuously. <br />
}}<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool dxDrawModel3D( int modelId, float positionX, float positionY, float positionZ, float rotationX, float rotationY, float rotationZ [, float scaleX, float scaleY, float scaleZ ])<br />
</syntaxhighlight><br />
<br />
[[Image:DxDrawModel3D_at_day.png|thumb|Model during day]]<br />
[[Image:DxDrawModel3D_at_night.png|thumb|Model during night]]<br />
<br />
===Required Arguments=== <br />
* '''modelId:''' Model you want to draw, must be regular object, you can not draw vehicles and peds<br />
* '''positionX/Y/Z:''' Position of model<br />
* '''rotationX/Y/Z:''' Rotation of model<br />
<br />
===Optional Arguments===<br />
* '''scaleX/Y/Z:''' Scale of model, by default {1,1,1}<br />
<br />
===Returns===<br />
Returns true if the operation was successful, false otherwise.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
==Example== <br />
<section name="Client" class="client" show="true"><br />
Simple example<br />
<syntaxhighlight lang="lua"><br />
addEventHandler("onClientPreRender", root, function()<br />
dxDrawModel3D(3276, -719.64984, 951.26685, 12.13281, 0, 0,90)<br />
end)<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Drawing_functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxDrawModel3D&diff=80117DxDrawModel3D2024-09-05T12:29:55Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}} <br />
{{Important Note|You can not use this function to draw vehicles and ped}}<br />
{{Important Note|This function doesn't obey any streaming limits, you can draw as many models as you want}}<br />
{{Important Note|You can not render model to render target.}}<br />
{{New feature/item|3.0161|1.6.0|22271|<br />
This function draws a 3D model - rendered for '''one''' frame. Drawn models are indistinguishable from this one created by [[createObject]] function. This should be used in conjunction with [[onClientRender]] in order to display continuously. <br />
}}<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool dxDrawModel3D( int modelId, float positionX, float positionY, float positionZ, float rotationX, float rotationY, float rotationZ [, float scaleX, float scaleY, float scaleZ ])<br />
</syntaxhighlight><br />
<br />
[[Image:DxDrawModel3D_at_day.png|thumb|Model during day]]<br />
[[Image:DxDrawModel3D_at_night.png|thumb|Model during night]]<br />
<br />
===Required Arguments=== <br />
* '''modelId:''' Model you want to draw, must be regular object, you can not draw vehicles and peds<br />
* '''positionX/Y/Z:''' Position of model<br />
* '''rotationX/Y/Z:''' Rotation of model<br />
<br />
===Optional Arguments===<br />
* '''scaleX/Y/Z:''' Scale of model, by default {1,1,1}<br />
<br />
===Returns===<br />
Returns true if the operation was successful, false otherwise.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
==Example== <br />
<section name="Client" class="client" show="true"><br />
Simple example<br />
<syntaxhighlight lang="lua"><br />
addEventHandler("onClientPreRender", root, function()<br />
dxDrawModel3D(3276, -719.64984, 951.26685, 12.13281, 0, 0,90)<br />
end)<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Drawing_functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxDrawPrimitive3D&diff=79444DxDrawPrimitive3D2024-05-27T04:41:38Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
This function draws a 3D primitive in the 3D world - rendered for '''one''' frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.<br />
<br />
{{Deprecated items|3.0159|1.5.9|<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool dxDrawPrimitive3D ( string primitiveType, bool postGUI, table vertex1, table vertex2, table vertex3 [, table vertex4, ...] )<br />
</syntaxhighlight><br />
<br />
[[File:Primitive.png|thumb|A four vertex primitive example using "trianglefan"]]<br />
<br />
===Required Arguments=== <br />
* '''primitiveType:''' The type of primitive to be drawn. This could be:<br />
"pointlist"<br />
"linelist"<br />
"linestrip"<br />
"trianglefan"<br />
"trianglelist"<br />
"trianglestrip"<br />
* '''postGUI:''' A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).<br />
* '''vertex1:''' A table with the coordinates of the vertex plus its color.<br />
* '''vertex2:''' A table with the coordinates of the vertex plus its color.<br />
* '''vertex3:''' A table with the coordinates of the vertex plus its color.<br />
<br />
The vertex should be passed like this:<br />
<syntaxhighlight lang="lua"><br />
{x, y, z, color}<br />
</syntaxhighlight><br />
<br />
==Optional Arguments==<br />
{{OptionalArg}}<br />
* '''vertexN:''' A table with the coordinates of the vertex plus its color. You can add as much as you want.<br />
<br />
===Returns===<br />
Returns a ''true'' if the operation was successful, ''false'' otherwise.<br />
|22465}}<br />
<br />
{{Updated feature/item|1.5.9|1.5.9|22465|<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool dxDrawPrimitive3D ( string primitiveType, string stage, table vertex1, table vertex2, table vertex3 [, table vertex4, ...] )<br />
</syntaxhighlight><br />
<br />
[[File:Primitive.png|thumb|A four vertex primitive example using "trianglefan"]]<br />
<br />
===Required Arguments=== <br />
* '''primitiveType:''' The type of primitive to be drawn. This could be:<br />
"pointlist"<br />
"linelist"<br />
"linestrip"<br />
"trianglefan"<br />
"trianglelist"<br />
"trianglestrip"<br />
* '''stage:''' A string representing a stage at which the actual drawcall should happen:<br />
** prefx - Primitives are rendered before the color correction. This stage makes primitives look natural to SA but colors could be distorted.<br />
** postfx - Primitives are rendered after the color correction. This stage conveys a color from the function to a screen without distortions.<br />
** postgui - Primitives are rendered after GUI. The primitive should be drawn on top of or behind any ingame GUI (rendered by CEGUI).<br />
* '''vertex1:''' A table with the coordinates of the vertex plus its color.<br />
* '''vertex2:''' A table with the coordinates of the vertex plus its color.<br />
* '''vertex3:''' A table with the coordinates of the vertex plus its color.<br />
<br />
The vertex should be passed like this:<br />
<syntaxhighlight lang="lua"><br />
{x, y, z, color}<br />
</syntaxhighlight><br />
<br />
==Optional Arguments==<br />
{{OptionalArg}}<br />
* '''vertexN:''' A table with the coordinates of the vertex plus its color. You can add as much as you want.<br />
<br />
===Returns===<br />
Returns a ''true'' if the operation was successful, ''false'' otherwise.<br />
}}<br />
<br />
==Example== <br />
This is a small example of creating 3D Primitive object with 4 vertex that will spawn on 'The Well Stacked Pizza Co.' in Idlewood.<br />
<syntaxhighlight lang="lua"><br />
local primitive = {<br />
{2087.8, -1804.2, 13.5, tocolor(255, 0, 0)}, <br />
{2087.7, -1810.5, 13.5, tocolor(0, 255, 0)}, <br />
{2092.7, -1813.6, 17.7, tocolor(0, 0, 255)},<br />
{2097.5, -1806.8, 16, tocolor(255, 255, 255)}<br />
}<br />
<br />
function draw()<br />
dxDrawPrimitive3D("trianglefan", false, unpack(primitive))<br />
end<br />
addEventHandler("onClientRender", root, draw)<br />
</syntaxhighlight><br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.5.7-9.19626|}}<br />
<br />
==See Also==<br />
{{Drawing_functions}}<br />
<br />
[[hu:dxDrawLine3D]]</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxDrawMaterialPrimitive3D&diff=79443DxDrawMaterialPrimitive3D2024-05-27T04:41:15Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}} <br />
This function draws a 3D primitive shape with material applied to it in the 3D world - rendered for one frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.<br />
If image file is used, it should ideally have dimensions that are a power of two, to prevent possible blurring.<br />
Power of two: 2px, 4px, 8px, 16px, 32px, 64px, 128px, 256px, 512px, 1024px...<br />
<br />
{{Deprecated items|3.0159|1.5.9|<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool dxDrawMaterialPrimitive3D ( primitiveType pType, mixed material, bool postGUI, table vertex1 [, table vertex2, ...] )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
* '''pType:''' Type of primitive to be drawn.<br />
* '''image:''' Either a [[material]] element or a [[filepath]] of the image which is going to be drawn. (.dds images are also supported). Image files should ideally have dimensions that are a power of two, to prevent possible blurring. Use a texture created with [[dxCreateTexture]] to '''speed up drawing'''.<br />
* '''postGUI:''' A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).<br />
* '''vertices:''' Tables representing each primitive vertex, required amount of them is determined by primitive type.<br />
<br />
==Allowed types==<br />
[[Image:MTAsa_primitives.png|thumb|240px|Available primitive types.]]<br />
More info on primitives may be found on [https://msdn.microsoft.com/en-us/library/windows/desktop/bb147291.aspx this MSDN site] <br />
* '''pointlist:''' Renders the vertices as a collection of isolated points.<br />
* '''linelist:''' Renders the vertices as a list of isolated straight line segments.<br />
* '''linestrip:''' Renders the vertices as a single polyline.<br />
* '''trianglelist:''' Renders the specified vertices as a sequence of isolated triangles. Each group of three vertices defines a separate triangle.<br />
* '''trianglestrip:''' Renders the vertices as a triangle strip.<br />
* '''trianglefan:''' Renders the vertices as a triangle fan.<br />
<br />
==Vertices format==<br />
* '''posX:''' An float representing the X position of the vertex in the GTA world.<br />
* '''posY:''' An float representing the Y position of the vertex in the GTA world.<br />
* '''posZ:''' An float representing the Z position of the vertex in the GTA world.<br />
* '''color (optional):''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB. If it's not specified, white color is used.<br />
* '''u:''' An float representing the relative X coordinate of the top left corner of the material which should be drawn from image<br />
* '''v:''' An float representing the relative Y coordinate of the top left corner of the material which should be drawn from image<br />
<br />
===Returns===<br />
Returns a ''true'' if the operation was successful, ''false'' otherwise.<br />
|22465}}<br />
<br />
{{Updated feature/item|1.5.9|1.5.9|22465|<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool dxDrawMaterialPrimitive3D ( primitiveType pType, mixed material, string stage, table vertex1 [, table vertex2, ...] )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
* '''pType:''' Type of primitive to be drawn.<br />
* '''image:''' Either a [[material]] element or a [[filepath]] of the image which is going to be drawn. (.dds images are also supported). Image files should ideally have dimensions that are a power of two, to prevent possible blurring. Use a texture created with [[dxCreateTexture]] to '''speed up drawing'''.<br />
* '''stage:''' A string representing a stage at which the actual drawcall should happen:<br />
** prefx - Primitives are rendered before the color correction. This stage makes primitives look natural to SA but colors could be distorted.<br />
** postfx - Primitives are rendered after the color correction. This stage conveys a color from the function to a screen without distortions.<br />
** postgui - Primitives are rendered after GUI. The primitives should be drawn on top of or behind any ingame GUI (rendered by CEGUI).<br />
* '''vertices:''' Tables representing each primitive vertex, required amount of them is determined by primitive type.<br />
<br />
==Allowed types==<br />
[[Image:MTAsa_primitives.png|thumb|240px|Available primitive types.]]<br />
More info on primitives may be found on [https://msdn.microsoft.com/en-us/library/windows/desktop/bb147291.aspx this MSDN site] <br />
* '''pointlist:''' Renders the vertices as a collection of isolated points.<br />
* '''linelist:''' Renders the vertices as a list of isolated straight line segments.<br />
* '''linestrip:''' Renders the vertices as a single polyline.<br />
* '''trianglelist:''' Renders the specified vertices as a sequence of isolated triangles. Each group of three vertices defines a separate triangle.<br />
* '''trianglestrip:''' Renders the vertices as a triangle strip.<br />
* '''trianglefan:''' Renders the vertices as a triangle fan.<br />
<br />
==Vertices format==<br />
* '''posX:''' An float representing the X position of the vertex in the GTA world.<br />
* '''posY:''' An float representing the Y position of the vertex in the GTA world.<br />
* '''posZ:''' An float representing the Z position of the vertex in the GTA world.<br />
* '''color (optional):''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB. If it's not specified, white color is used.<br />
* '''u:''' An float representing the relative X coordinate of the top left corner of the material which should be drawn from image<br />
* '''v:''' An float representing the relative Y coordinate of the top left corner of the material which should be drawn from image<br />
<br />
===Returns===<br />
Returns a ''true'' if the operation was successful, ''false'' otherwise.<br />
}}<br />
<br />
==Remarks==<br />
When a 3D draw call is issued by any such material MTA function then the principle to [https://github.com/multitheftauto/mtasa-blue/blob/16769b8d1c94e2b9fe6323dcba46d1305f87a190/Client/core/Graphics/CMaterialPrimitive3DBatcher.cpp#L42 push it directly to the 3D adapter] does apply. To achieve this there is '''no software-side 3D clipping mathematics''' being performed. This way the vertex data is always being pushed to the vertex shader, leaving the entire freedom to the developer on how to interpret this vertex data in the shader. For example, even though this function does imply an use in 3D world space, the vertex coordinates could be translated directly into Direct3D 9 screen space instead, effectively discarding any multiplication with the camera projection matrix. The mathematical model for translation into valid Direct3D 9 screen-space coordinates is described [https://docs.microsoft.com/en-us/windows/win32/direct3d9/viewports-and-clipping here]. Let's assume that you are drawing the rectangle on a classic sheet of paper with a mathematical 2D X,Y coordinate system.<br />
<br />
[[File:D3d9_screen_space_transformation.png|frameless|center|Direct3D 9 screen-space transformation]]<br />
<br />
To transform the coordinates you first have to flip the Y coordinate using negation and then apply the Direct3D 9 screen-space rasterization cross-hair by using the screen dimensions (sw, sh). Since linear shapes are being preserved across linear translations, you can simplify each vertex-based figure into it's set of vertices for the purpose shown above. By using this function in such a way it can perform all the operations in the same quality such as the simpler [[dxDrawMaterialPrimitive]] function.<br />
<br />
==Example==<br />
This example draws the picture with the file name 'test.png' on the ground of Grove Street and adds a /flip command to flip it. The 'test.png' file needs to be included in the [[meta.xml]] in order for this example to work.<br />
<syntaxhighlight lang="lua"><br />
local picture = "test.png"<br />
local worldRenderPositions = { -- create a table with all the world positions<br />
<br />
{ 2483, -1663, 12.4, 0, 0 }, -- top left<br />
{ 2493, -1663, 12.4, 1, 0 }, -- top right<br />
{ 2483, -1673, 12.4, 0, 1 }, -- bottom left<br />
{ 2493, -1673, 12.4, 1, 1 }, -- bottom right<br />
<br />
}<br />
<br />
function renderPicture()<br />
dxDrawMaterialPrimitive3D( "trianglestrip", picture, false, unpack(worldRenderPositions) ) -- use unpack() to separate the points<br />
end<br />
addEventHandler( "onClientRender", root, renderPicture )<br />
<br />
function flipPicture()<br />
for index, point in ipairs(worldRenderPositions) do<br />
if point[4] == 1 then<br />
point[4] = 0<br />
else<br />
point[4] = 1<br />
end<br />
if point[5] == 1 then<br />
point[5] = 0<br />
else<br />
point[5] = 1<br />
end<br />
end<br />
end<br />
addCommandHandler( "flip", flipPicture )<br />
</syntaxhighlight><br />
<br />
This function can be used to draw billboards in the game world. You have to [https://forum.mtasa.com/topic/133065-naruto-jutsus-help-me/?do=findComment&comment=1003073 understand the mathematical models about the human vision] to calculate the proper vertices.<br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.5.7-9.19626|}}<br />
<br />
==See Also==<br />
{{Drawing_functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxDrawPrimitive3D&diff=79442DxDrawPrimitive3D2024-05-27T04:32:52Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
This function draws a 3D primitive in the 3D world - rendered for '''one''' frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.<br />
<br />
{{Deprecated items|3.0159|1.5.9|<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool dxDrawPrimitive3D ( string primitiveType, bool postGUI, table vertex1, table vertex2, table vertex3 [, table vertex4, ...] )<br />
</syntaxhighlight><br />
<br />
[[File:Primitive.png|thumb|A four vertex primitive example using "trianglefan"]]<br />
<br />
===Required Arguments=== <br />
* '''primitiveType:''' The type of primitive to be drawn. This could be:<br />
"pointlist"<br />
"linelist"<br />
"linestrip"<br />
"trianglefan"<br />
"trianglelist"<br />
"trianglestrip"<br />
* '''postGUI:''' A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).<br />
* '''vertex1:''' A table with the coordinates of the vertex plus its color.<br />
* '''vertex2:''' A table with the coordinates of the vertex plus its color.<br />
* '''vertex3:''' A table with the coordinates of the vertex plus its color.<br />
<br />
The vertex should be passed like this:<br />
<syntaxhighlight lang="lua"><br />
{x, y, z, color}<br />
</syntaxhighlight><br />
<br />
==Optional Arguments==<br />
{{OptionalArg}}<br />
* '''vertexN:''' A table with the coordinates of the vertex plus its color. You can add as much as you want.<br />
<br />
===Returns===<br />
Returns a ''true'' if the operation was successful, ''false'' otherwise.<br />
|22465}}<br />
<br />
{{Updated feature/item|1.5.9|1.5.9|22465|<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool dxDrawPrimitive3D ( string primitiveType, string stage="postfx", table vertex1, table vertex2, table vertex3 [, table vertex4, ...] )<br />
</syntaxhighlight><br />
<br />
[[File:Primitive.png|thumb|A four vertex primitive example using "trianglefan"]]<br />
<br />
===Required Arguments=== <br />
* '''primitiveType:''' The type of primitive to be drawn. This could be:<br />
"pointlist"<br />
"linelist"<br />
"linestrip"<br />
"trianglefan"<br />
"trianglelist"<br />
"trianglestrip"<br />
* '''stage:''' A string representing a stage at which the actual drawcall should happen:<br />
** prefx - Primitives are rendered before the color correction. This stage makes primitives look natural to SA but colors could be distorted.<br />
** postfx - Primitives are rendered after the color correction. This stage conveys a color from the function to a screen without distortions.<br />
** postgui - Primitives are rendered after GUI. The primitive should be drawn on top of or behind any ingame GUI (rendered by CEGUI).<br />
* '''vertex1:''' A table with the coordinates of the vertex plus its color.<br />
* '''vertex2:''' A table with the coordinates of the vertex plus its color.<br />
* '''vertex3:''' A table with the coordinates of the vertex plus its color.<br />
<br />
The vertex should be passed like this:<br />
<syntaxhighlight lang="lua"><br />
{x, y, z, color}<br />
</syntaxhighlight><br />
<br />
==Optional Arguments==<br />
{{OptionalArg}}<br />
* '''vertexN:''' A table with the coordinates of the vertex plus its color. You can add as much as you want.<br />
<br />
===Returns===<br />
Returns a ''true'' if the operation was successful, ''false'' otherwise.<br />
}}<br />
<br />
==Example== <br />
This is a small example of creating 3D Primitive object with 4 vertex that will spawn on 'The Well Stacked Pizza Co.' in Idlewood.<br />
<syntaxhighlight lang="lua"><br />
local primitive = {<br />
{2087.8, -1804.2, 13.5, tocolor(255, 0, 0)}, <br />
{2087.7, -1810.5, 13.5, tocolor(0, 255, 0)}, <br />
{2092.7, -1813.6, 17.7, tocolor(0, 0, 255)},<br />
{2097.5, -1806.8, 16, tocolor(255, 255, 255)}<br />
}<br />
<br />
function draw()<br />
dxDrawPrimitive3D("trianglefan", false, unpack(primitive))<br />
end<br />
addEventHandler("onClientRender", root, draw)<br />
</syntaxhighlight><br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.5.7-9.19626|}}<br />
<br />
==See Also==<br />
{{Drawing_functions}}<br />
<br />
[[hu:dxDrawLine3D]]</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxDrawMaterialPrimitive3D&diff=79441DxDrawMaterialPrimitive3D2024-05-27T04:29:14Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}} <br />
This function draws a 3D primitive shape with material applied to it in the 3D world - rendered for one frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.<br />
If image file is used, it should ideally have dimensions that are a power of two, to prevent possible blurring.<br />
Power of two: 2px, 4px, 8px, 16px, 32px, 64px, 128px, 256px, 512px, 1024px...<br />
<br />
{{Deprecated items|3.0159|1.5.9|<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool dxDrawMaterialPrimitive3D ( primitiveType pType, mixed material, bool postGUI, table vertex1 [, table vertex2, ...] )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
* '''pType:''' Type of primitive to be drawn.<br />
* '''image:''' Either a [[material]] element or a [[filepath]] of the image which is going to be drawn. (.dds images are also supported). Image files should ideally have dimensions that are a power of two, to prevent possible blurring. Use a texture created with [[dxCreateTexture]] to '''speed up drawing'''.<br />
* '''postGUI:''' A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).<br />
* '''vertices:''' Tables representing each primitive vertex, required amount of them is determined by primitive type.<br />
<br />
==Allowed types==<br />
[[Image:MTAsa_primitives.png|thumb|240px|Available primitive types.]]<br />
More info on primitives may be found on [https://msdn.microsoft.com/en-us/library/windows/desktop/bb147291.aspx this MSDN site] <br />
* '''pointlist:''' Renders the vertices as a collection of isolated points.<br />
* '''linelist:''' Renders the vertices as a list of isolated straight line segments.<br />
* '''linestrip:''' Renders the vertices as a single polyline.<br />
* '''trianglelist:''' Renders the specified vertices as a sequence of isolated triangles. Each group of three vertices defines a separate triangle.<br />
* '''trianglestrip:''' Renders the vertices as a triangle strip.<br />
* '''trianglefan:''' Renders the vertices as a triangle fan.<br />
<br />
==Vertices format==<br />
* '''posX:''' An float representing the X position of the vertex in the GTA world.<br />
* '''posY:''' An float representing the Y position of the vertex in the GTA world.<br />
* '''posZ:''' An float representing the Z position of the vertex in the GTA world.<br />
* '''color (optional):''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB. If it's not specified, white color is used.<br />
* '''u:''' An float representing the relative X coordinate of the top left corner of the material which should be drawn from image<br />
* '''v:''' An float representing the relative Y coordinate of the top left corner of the material which should be drawn from image<br />
<br />
===Returns===<br />
Returns a ''true'' if the operation was successful, ''false'' otherwise.<br />
|22465}}<br />
<br />
{{Updated feature/item|1.5.9|1.5.9|22465|<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool dxDrawMaterialPrimitive3D ( primitiveType pType, mixed material, string stage="postfx", table vertex1 [, table vertex2, ...] )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
* '''pType:''' Type of primitive to be drawn.<br />
* '''image:''' Either a [[material]] element or a [[filepath]] of the image which is going to be drawn. (.dds images are also supported). Image files should ideally have dimensions that are a power of two, to prevent possible blurring. Use a texture created with [[dxCreateTexture]] to '''speed up drawing'''.<br />
* '''stage:''' A string representing a stage at which the actual drawcall should happen:<br />
** prefx - Primitives are rendered before the color correction. This stage makes primitives look natural to SA but colors could be distorted.<br />
** postfx - Primitives are rendered after the color correction. This stage conveys a color from the function to a screen without distortions.<br />
** postgui - Primitives are rendered after GUI. The primitives should be drawn on top of or behind any ingame GUI (rendered by CEGUI).<br />
* '''vertices:''' Tables representing each primitive vertex, required amount of them is determined by primitive type.<br />
<br />
==Allowed types==<br />
[[Image:MTAsa_primitives.png|thumb|240px|Available primitive types.]]<br />
More info on primitives may be found on [https://msdn.microsoft.com/en-us/library/windows/desktop/bb147291.aspx this MSDN site] <br />
* '''pointlist:''' Renders the vertices as a collection of isolated points.<br />
* '''linelist:''' Renders the vertices as a list of isolated straight line segments.<br />
* '''linestrip:''' Renders the vertices as a single polyline.<br />
* '''trianglelist:''' Renders the specified vertices as a sequence of isolated triangles. Each group of three vertices defines a separate triangle.<br />
* '''trianglestrip:''' Renders the vertices as a triangle strip.<br />
* '''trianglefan:''' Renders the vertices as a triangle fan.<br />
<br />
==Vertices format==<br />
* '''posX:''' An float representing the X position of the vertex in the GTA world.<br />
* '''posY:''' An float representing the Y position of the vertex in the GTA world.<br />
* '''posZ:''' An float representing the Z position of the vertex in the GTA world.<br />
* '''color (optional):''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB. If it's not specified, white color is used.<br />
* '''u:''' An float representing the relative X coordinate of the top left corner of the material which should be drawn from image<br />
* '''v:''' An float representing the relative Y coordinate of the top left corner of the material which should be drawn from image<br />
<br />
===Returns===<br />
Returns a ''true'' if the operation was successful, ''false'' otherwise.<br />
}}<br />
<br />
==Remarks==<br />
When a 3D draw call is issued by any such material MTA function then the principle to [https://github.com/multitheftauto/mtasa-blue/blob/16769b8d1c94e2b9fe6323dcba46d1305f87a190/Client/core/Graphics/CMaterialPrimitive3DBatcher.cpp#L42 push it directly to the 3D adapter] does apply. To achieve this there is '''no software-side 3D clipping mathematics''' being performed. This way the vertex data is always being pushed to the vertex shader, leaving the entire freedom to the developer on how to interpret this vertex data in the shader. For example, even though this function does imply an use in 3D world space, the vertex coordinates could be translated directly into Direct3D 9 screen space instead, effectively discarding any multiplication with the camera projection matrix. The mathematical model for translation into valid Direct3D 9 screen-space coordinates is described [https://docs.microsoft.com/en-us/windows/win32/direct3d9/viewports-and-clipping here]. Let's assume that you are drawing the rectangle on a classic sheet of paper with a mathematical 2D X,Y coordinate system.<br />
<br />
[[File:D3d9_screen_space_transformation.png|frameless|center|Direct3D 9 screen-space transformation]]<br />
<br />
To transform the coordinates you first have to flip the Y coordinate using negation and then apply the Direct3D 9 screen-space rasterization cross-hair by using the screen dimensions (sw, sh). Since linear shapes are being preserved across linear translations, you can simplify each vertex-based figure into it's set of vertices for the purpose shown above. By using this function in such a way it can perform all the operations in the same quality such as the simpler [[dxDrawMaterialPrimitive]] function.<br />
<br />
==Example==<br />
This example draws the picture with the file name 'test.png' on the ground of Grove Street and adds a /flip command to flip it. The 'test.png' file needs to be included in the [[meta.xml]] in order for this example to work.<br />
<syntaxhighlight lang="lua"><br />
local picture = "test.png"<br />
local worldRenderPositions = { -- create a table with all the world positions<br />
<br />
{ 2483, -1663, 12.4, 0, 0 }, -- top left<br />
{ 2493, -1663, 12.4, 1, 0 }, -- top right<br />
{ 2483, -1673, 12.4, 0, 1 }, -- bottom left<br />
{ 2493, -1673, 12.4, 1, 1 }, -- bottom right<br />
<br />
}<br />
<br />
function renderPicture()<br />
dxDrawMaterialPrimitive3D( "trianglestrip", picture, false, unpack(worldRenderPositions) ) -- use unpack() to separate the points<br />
end<br />
addEventHandler( "onClientRender", root, renderPicture )<br />
<br />
function flipPicture()<br />
for index, point in ipairs(worldRenderPositions) do<br />
if point[4] == 1 then<br />
point[4] = 0<br />
else<br />
point[4] = 1<br />
end<br />
if point[5] == 1 then<br />
point[5] = 0<br />
else<br />
point[5] = 1<br />
end<br />
end<br />
end<br />
addCommandHandler( "flip", flipPicture )<br />
</syntaxhighlight><br />
<br />
This function can be used to draw billboards in the game world. You have to [https://forum.mtasa.com/topic/133065-naruto-jutsus-help-me/?do=findComment&comment=1003073 understand the mathematical models about the human vision] to calculate the proper vertices.<br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.5.7-9.19626|}}<br />
<br />
==See Also==<br />
{{Drawing_functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxDrawMaterialSectionLine3D&diff=79440DxDrawMaterialSectionLine3D2024-05-27T04:17:47Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}} <br />
This function draws a textured 3D line between two points in the 3D world - rendered for one frame. This should be used in conjunction with [[onClientPreRender]] in order to display continuously.<br />
<br />
The 3D line with a large width value effectively becomes a rectangle, so it it possible to construct basic shapes such as boxes with several large width lines and the appropriate values for 'faceToward'.<br />
<br />
{{Deprecated items|3.0159|1.5.9|<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool dxDrawMaterialSectionLine3D ( float startX, float startY, float startZ, float endX, float endY, float endZ,<br />
float u, float v, float usize, float vsize, [ bool flipUV = false, ] element material, float width,<br />
[ int color = white, [ bool postGUI = false, ] float faceTowardX, float faceTowardY, float faceTowardZ ] )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
* '''startX/Y/Z:''' The start position of the 3D line, representing a coordinate in the GTA world.<br />
* '''endX/Y/Z:''' The end position of the 3D line, representing a coordinate in the GTA world.<br />
*'''u:''' the absolute X coordinate of the top left corner of the section <br />
*'''v:''' the absolute Y coordinate of the top left corner of the section <br />
*'''usize:''' the absolute width of the section<br />
*'''vsize:''' the absolute height of the section<br />
* '''material:''' A [[material]] to draw the line with.<br />
* '''width:''' The width/thickness of the line in GTA world units. (This is 1/75th of the width used in dxDrawLine3D)<br />
<br />
==Optional Arguments==<br />
{{Added feature/item|1.5.9|1.5.8|20862|<br />
* '''flipUV''': A bool representing whether a UV orientation should be flipped.<br />
}}<br />
* '''color:''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB.<br />
* '''postGUI''': A bool representing whether the line should be drawn on top of or behind any ingame GUI.<br />
* '''faceTowardX/Y/Z:''' The direction the front of the line should face towards. If this is not set, the front of the line always faces toward the camera.<br />
<br />
===Returns===<br />
Returns a ''true'' if the operation was successful, ''false'' otherwise.<br />
|22465}}<br />
<br />
{{Updated feature/item|1.5.9|1.5.9|22465|<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool dxDrawMaterialSectionLine3D ( float startX, float startY, float startZ, float endX, float endY, float endZ,<br />
float u, float v, float usize, float vsize, [ bool flipUV = false, ] element material, float width,<br />
[ int color = white, [ bool stage = "postfx", ] float faceTowardX, float faceTowardY, float faceTowardZ ] )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
* '''startX/Y/Z:''' The start position of the 3D line, representing a coordinate in the GTA world.<br />
* '''endX/Y/Z:''' The end position of the 3D line, representing a coordinate in the GTA world.<br />
*'''u:''' the absolute X coordinate of the top left corner of the section <br />
*'''v:''' the absolute Y coordinate of the top left corner of the section <br />
*'''usize:''' the absolute width of the section<br />
*'''vsize:''' the absolute height of the section<br />
* '''material:''' A [[material]] to draw the line with.<br />
* '''width:''' The width/thickness of the line in GTA world units. (This is 1/75th of the width used in dxDrawLine3D)<br />
<br />
==Optional Arguments==<br />
{{Added feature/item|1.5.9|1.5.8|20862|<br />
* '''flipUV''': A bool representing whether a UV orientation should be flipped.<br />
}}<br />
* '''color:''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB.<br />
* '''stage:''' A string representing a stage at which the actual drawcall should happen:<br />
** prefx - Lines are rendered before the color correction. This stage makes lines look natural to SA but colors could be distorted.<br />
** postfx - Lines are rendered after the color correction. This stage conveys a color from the function to a screen without distortions.<br />
** postgui - Lines are rendered after GUI. The line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).<br />
* '''faceTowardX/Y/Z:''' The direction the front of the line should face towards. If this is not set, the front of the line always faces toward the camera.<br />
<br />
===Returns===<br />
Returns a ''true'' if the operation was successful, ''false'' otherwise.<br />
}}<br />
<br />
==Example== <br />
This example draws corona like effects near the player<br />
<syntaxhighlight lang="lua"><br />
coronaTexture = dxCreateTexture("corona.png")<br />
red = tocolor(255,0,0)<br />
green = tocolor(0,255,0)<br />
blue = tocolor(0,0,255)<br />
<br />
addEventHandler("onClientPreRender",root,<br />
function()<br />
local x,y,z = getElementPosition(localPlayer)<br />
<br />
dxSetBlendMode("add") -- Add blend mode looks best for corona effects<br />
drawCorona( x+2, y+2, z+1, 1, red )<br />
drawCorona( x+1, y+3, z+2, 1, green )<br />
drawCorona( x-1, y+2, z+3, 1, blue )<br />
dxSetBlendMode("blend") -- Restore default<br />
end<br />
)<br />
<br />
-- Draw the corona texture<br />
function drawCorona( x, y, z, size, color )<br />
dxDrawMaterialSectionLine3D ( x, y, z+size,<br />
x, y, z-size,<br />
0,0,1,1, coronaTexture, size, color)<br />
end<br />
<br />
</syntaxhighlight><br />
<br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.3.0-9.03931|}}<br />
<br />
==Changelog==<br />
{{ChangelogHeader}}<br />
{{ChangelogItem|1.5.5-9.11998|Added ''postGUI'' argument}}<br />
{{ChangelogItem|1.5.8-9.20862|Added ''flipUV'' argument}}<br />
<br />
==See Also==<br />
{{Drawing_functions}}<br />
<br />
[[hu:dxDrawMaterialSectionLine3D]]</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxDrawMaterialLine3D&diff=79439DxDrawMaterialLine3D2024-05-27T04:15:29Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
This function draws a textured 3D line between two points in the 3D world - rendered for one frame. This should be used in conjunction with [[onClientPreRender]] in order to display continuously.<br />
<br />
The 3D line with a large width value effectively becomes a rectangle, so it it possible to construct basic shapes such as boxes with several large width lines and the appropriate values for 'faceToward'.<br />
<br />
3D lines are drawn at a particular place in the [[Game_Processing_Order|game processing order]], so use [[onClientPreRender]] for drawing if you are attaching them to world elements.<br />
<br />
{{Deprecated items|3.0159|1.5.9|<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool dxDrawMaterialLine3D ( float startX, float startY, float startZ, float endX, float endY, float endZ, [ bool flipUV = false, ] element material, float width,<br />
[ int color = white, [ bool postGUI = false, ] float faceTowardX, float faceTowardY, float faceTowardZ ] )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
* '''startX/Y/Z:''' The start position of the 3D line, representing a coordinate in the GTA world.<br />
* '''endX/Y/Z:''' The end position of the 3D line, representing a coordinate in the GTA world.<br />
* '''material:''' A [[material]] to draw the line with.<br />
* '''width:''' The width/thickness of the line in GTA world units. (This is 1/75th of the width used in dxDrawLine3D)<br />
<br />
==Optional Arguments==<br />
{{OptionalArg}}<br />
{{Added feature/item|1.5.9|1.5.8|20862|<br />
* '''flipUV''': A bool representing whether a UV orientation should be flipped.<br />
}}<br />
* '''color:''' An [[int|integer]] of the hex color, produced using [[tocolor]] or 0xAARRGGBB.<br />
* '''postGUI''': A bool representing whether the line should be drawn on top of or behind any ingame GUI.<br />
* '''faceTowardX/Y/Z:''' The position the front of the line should face towards. If this is not set, the camera position is used, so the front of the line faces toward the camera.<br />
<br />
===Returns===<br />
Returns a ''true'' if the operation was successful, ''false'' otherwise.<br />
|22465}}<br />
<br />
{{Updated feature/item|1.5.9|1.5.9|22465|<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool dxDrawMaterialLine3D ( float startX, float startY, float startZ, float endX, float endY, float endZ, [ bool flipUV = false, ] element material, float width,<br />
[ int color = white, [ string stage = "postfx", ] float faceTowardX, float faceTowardY, float faceTowardZ ] )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
* '''startX/Y/Z:''' The start position of the 3D line, representing a coordinate in the GTA world.<br />
* '''endX/Y/Z:''' The end position of the 3D line, representing a coordinate in the GTA world.<br />
* '''material:''' A [[material]] to draw the line with.<br />
* '''width:''' The width/thickness of the line in GTA world units. (This is 1/75th of the width used in dxDrawLine3D)<br />
<br />
==Optional Arguments==<br />
{{OptionalArg}}<br />
{{Added feature/item|1.5.9|1.5.8|20862|<br />
* '''flipUV''': A bool representing whether a UV orientation should be flipped.<br />
}}<br />
* '''color:''' An [[int|integer]] of the hex color, produced using [[tocolor]] or 0xAARRGGBB.<br />
* '''stage:''' A string representing a stage at which the actual drawcall should happen:<br />
** prefx - Lines are rendered before the color correction. This stage makes lines look natural to SA but colors could be distorted.<br />
** postfx - Lines are rendered after the color correction. This stage conveys a color from the function to a screen without distortions.<br />
** postgui - Lines are rendered after GUI. The line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).<br />
* '''faceTowardX/Y/Z:''' The position the front of the line should face towards. If this is not set, the camera position is used, so the front of the line faces toward the camera.<br />
<br />
===Returns===<br />
Returns a ''true'' if the operation was successful, ''false'' otherwise.<br />
}}<br />
<br />
==Example== <br />
Draws [[:File:DxDrawMaterialLine3D-example.png|an image]] in coordiantes -2422.68555, -608.78986, 132.56250:<br />
<syntaxhighlight lang="lua"><br />
local redcircle = dxCreateTexture("red.png")<br />
<br />
x,y,z = -2422.68555, -608.78986, 132.56250<br />
<br />
size = 1<br />
<br />
addEventHandler("onClientRender", root, function()<br />
dxDrawMaterialLine3D(x+size, y+size, z-0.95, x-size, y-size, z-0.95, redcircle, size*2,tocolor(255, 255, 255, 255), false, x, y, z)<br />
end)<br />
</syntaxhighlight><br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.3.0-9.03931|}}<br />
<br />
==Changelog==<br />
{{ChangelogHeader}}<br />
{{ChangelogItem|1.5.5-9.11998|Added ''postGUI'' argument}}<br />
{{ChangelogItem|1.5.8-9.20862|Added ''flipUV'' argument}}<br />
<br />
==See Also==<br />
{{Drawing_functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxDrawMaterialLine3D&diff=79438DxDrawMaterialLine3D2024-05-27T04:15:10Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
This function draws a textured 3D line between two points in the 3D world - rendered for one frame. This should be used in conjunction with [[onClientPreRender]] in order to display continuously.<br />
<br />
The 3D line with a large width value effectively becomes a rectangle, so it it possible to construct basic shapes such as boxes with several large width lines and the appropriate values for 'faceToward'.<br />
<br />
3D lines are drawn at a particular place in the [[Game_Processing_Order|game processing order]], so use [[onClientPreRender]] for drawing if you are attaching them to world elements.<br />
<br />
{{Deprecated items|3.0159|1.5.9|<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool dxDrawMaterialLine3D ( float startX, float startY, float startZ, float endX, float endY, float endZ, [ bool flipUV = false, ] element material, float width,<br />
[ int color = white, [ bool postGUI = false, ] float faceTowardX, float faceTowardY, float faceTowardZ ] )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
* '''startX/Y/Z:''' The start position of the 3D line, representing a coordinate in the GTA world.<br />
* '''endX/Y/Z:''' The end position of the 3D line, representing a coordinate in the GTA world.<br />
* '''material:''' A [[material]] to draw the line with.<br />
* '''width:''' The width/thickness of the line in GTA world units. (This is 1/75th of the width used in dxDrawLine3D)<br />
<br />
==Optional Arguments==<br />
{{OptionalArg}}<br />
{{Added feature/item|1.5.9|1.5.8|20862|<br />
* '''flipUV''': A bool representing whether a UV orientation should be flipped.<br />
}}<br />
* '''color:''' An [[int|integer]] of the hex color, produced using [[tocolor]] or 0xAARRGGBB.<br />
* '''postGUI''': A bool representing whether the line should be drawn on top of or behind any ingame GUI.<br />
* '''faceTowardX/Y/Z:''' The position the front of the line should face towards. If this is not set, the camera position is used, so the front of the line faces toward the camera.<br />
<br />
===Returns===<br />
Returns a ''true'' if the operation was successful, ''false'' otherwise.<br />
|22465}}<br />
<br />
{{Updated feature/item|1.5.9|1.5.9|22465|<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool dxDrawMaterialLine3D ( float startX, float startY, float startZ, float endX, float endY, float endZ, [ bool flipUV = false, ] element material, float width,<br />
[ int color = white, [ string postGUI = "postfx", ] float faceTowardX, float faceTowardY, float faceTowardZ ] )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
* '''startX/Y/Z:''' The start position of the 3D line, representing a coordinate in the GTA world.<br />
* '''endX/Y/Z:''' The end position of the 3D line, representing a coordinate in the GTA world.<br />
* '''material:''' A [[material]] to draw the line with.<br />
* '''width:''' The width/thickness of the line in GTA world units. (This is 1/75th of the width used in dxDrawLine3D)<br />
<br />
==Optional Arguments==<br />
{{OptionalArg}}<br />
{{Added feature/item|1.5.9|1.5.8|20862|<br />
* '''flipUV''': A bool representing whether a UV orientation should be flipped.<br />
}}<br />
* '''color:''' An [[int|integer]] of the hex color, produced using [[tocolor]] or 0xAARRGGBB.<br />
* '''stage:''' A string representing a stage at which the actual drawcall should happen:<br />
** prefx - Lines are rendered before the color correction. This stage makes lines look natural to SA but colors could be distorted.<br />
** postfx - Lines are rendered after the color correction. This stage conveys a color from the function to a screen without distortions.<br />
** postgui - Lines are rendered after GUI. The line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).<br />
* '''faceTowardX/Y/Z:''' The position the front of the line should face towards. If this is not set, the camera position is used, so the front of the line faces toward the camera.<br />
<br />
===Returns===<br />
Returns a ''true'' if the operation was successful, ''false'' otherwise.<br />
}}<br />
<br />
==Example== <br />
Draws [[:File:DxDrawMaterialLine3D-example.png|an image]] in coordiantes -2422.68555, -608.78986, 132.56250:<br />
<syntaxhighlight lang="lua"><br />
local redcircle = dxCreateTexture("red.png")<br />
<br />
x,y,z = -2422.68555, -608.78986, 132.56250<br />
<br />
size = 1<br />
<br />
addEventHandler("onClientRender", root, function()<br />
dxDrawMaterialLine3D(x+size, y+size, z-0.95, x-size, y-size, z-0.95, redcircle, size*2,tocolor(255, 255, 255, 255), false, x, y, z)<br />
end)<br />
</syntaxhighlight><br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.3.0-9.03931|}}<br />
<br />
==Changelog==<br />
{{ChangelogHeader}}<br />
{{ChangelogItem|1.5.5-9.11998|Added ''postGUI'' argument}}<br />
{{ChangelogItem|1.5.8-9.20862|Added ''flipUV'' argument}}<br />
<br />
==See Also==<br />
{{Drawing_functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxDrawLine3D&diff=79437DxDrawLine3D2024-05-27T04:12:06Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}} <br />
This function draws a 3D line between two points in the 3D world - rendered for '''one''' frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.<br />
<br />
{{Deprecated items|3.0159|1.5.9|<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool dxDrawLine3D ( float startX, float startY, float startZ, float endX, float endY, float endZ [, int color = 0xFFFFFFFF, float width = 1.0, bool postGUI = false ] )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
* '''startX:''' The start X position of the 3D line, representing a coordinate in the GTA world.<br />
* '''startY:''' The start Y position of the 3D line, representing a coordinate in the GTA world.<br />
* '''startZ:''' The start Z position of the 3D line, representing a coordinate in the GTA world.<br />
* '''endX:''' The end X position of the 3D line, representing a coordinate in the GTA world.<br />
* '''endY:''' The end Y position of the 3D line, representing a coordinate in the GTA world.<br />
* '''endZ:''' The end Z position of the 3D line, representing a coordinate in the GTA world.<br />
<br />
==Optional Arguments==<br />
{{OptionalArg}}<br />
* '''color:''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB.<br />
* '''width:''' The width/thickness of the line<br />
* '''postGUI:''' A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).<br />
<br />
===Returns===<br />
Returns a ''true'' if the operation was successful, ''false'' otherwise.<br />
|22465}}<br />
<br />
{{Updated feature/item|1.5.9|1.5.9|22465|<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool dxDrawLine3D ( float startX, float startY, float startZ, float endX, float endY, float endZ [, int color = 0xFFFFFFFF, float width = 1.0, string stage = "postfx" ] )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
* '''startX:''' The start X position of the 3D line, representing a coordinate in the GTA world.<br />
* '''startY:''' The start Y position of the 3D line, representing a coordinate in the GTA world.<br />
* '''startZ:''' The start Z position of the 3D line, representing a coordinate in the GTA world.<br />
* '''endX:''' The end X position of the 3D line, representing a coordinate in the GTA world.<br />
* '''endY:''' The end Y position of the 3D line, representing a coordinate in the GTA world.<br />
* '''endZ:''' The end Z position of the 3D line, representing a coordinate in the GTA world.<br />
<br />
==Optional Arguments==<br />
{{OptionalArg}}<br />
* '''color:''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB.<br />
* '''width:''' The width/thickness of the line<br />
* '''stage:''' A string representing a stage at which the actual drawcall should happen:<br />
** prefx - Lines are rendered before the color correction. This stage makes lines look natural to SA but colors could be distorted.<br />
** postfx - Lines are rendered after the color correction. This stage conveys a color from the function to a screen without distortions.<br />
** postgui - Lines are rendered after GUI. The line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).<br />
<br />
===Returns===<br />
Returns a ''true'' if the operation was successful, ''false'' otherwise.<br />
}}<br />
<br />
==Example== <br />
This is a small example of creating 3D Line / "Rope" between vehicle and player.<br />
<syntaxhighlight lang="lua"><br />
function makeLineAppear()<br />
testVehicle = createVehicle ( 411, 0, 0, 5 ) -- Create our test vehicle.<br />
addEventHandler("onClientRender", root, createLine) -- onClientRender keeps the 3D Line visible.<br />
end<br />
function createLine ( )<br />
x1, y1, z1 = getElementPosition ( testVehicle ) -- Get test vehicles position.<br />
x2, y2, z2 = getElementPosition ( localPlayer ) -- Get local players position.<br />
dxDrawLine3D ( x1, y1, z1, x2, y2, z2, tocolor ( 0, 255, 0, 230 ), 2) -- Create 3D Line between test vehicle and local player.<br />
end<br />
addCommandHandler("line", makeLineAppear)<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Drawing_functions}}<br />
<br />
[[hu:dxDrawLine3D]]</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=Template:Client_world_functions&diff=77211Template:Client world functions2023-07-26T01:48:10Z<p>TEDERIs: </p>
<hr />
<div>* [[areTrafficLightsLocked]]<br />
* [[createSWATRope]]<br />
* [[getAircraftMaxHeight]]<br />
* [[getAircraftMaxVelocity]]<br />
* [[getBirdsEnabled]]<br />
* [[getCloudsEnabled]]<br />
* [[getCoronaReflectionsEnabled]]<br />
* [[getFarClipDistance]]<br />
* [[getFogDistance]]<br />
* [[getGameSpeed]]<br />
* [[getGarageBoundingBox]]<br />
* [[getGaragePosition]]<br />
* [[getGarageSize]]<br />
* [[getGravity]]<br />
* [[getGroundPosition]]<br />
* [[getHeatHaze]]<br />
* [[getInteriorFurnitureEnabled]]<br />
* [[getInteriorSoundsEnabled]]<br />
* [[getJetpackMaxHeight]]<br />
* [[getMinuteDuration]]<br />
* [[getMoonSize]]<br />
* [[getNearClipDistance]]<br />
* [[getOcclusionsEnabled]]<br />
* [[getPedsLODDistance]]<br />
* [[getPlayerBlurLevel]]<br />
* [[getRainLevel]]<br />
{{Added feature/item|1.5.9|1.5.8|20675|<br />
* [[getRoofPosition]]<br />
}}<br />
* [[getScreenFromWorldPosition]]<br />
* [[getSunColor]]<br />
* [[getSunSize]]<br />
* [[getTime]]<br />
* [[getTrafficLightState]]<br />
* [[getVehiclesLODDistance]]<br />
* [[getWeather]]<br />
* [[getWindVelocity]]<br />
* [[getWorldFromScreenPosition]]<br />
* [[getZoneName]]<br />
* [[isAmbientSoundEnabled]]<br />
* [[isGarageOpen]]<br />
* [[isLineOfSightClear]]<br />
* [[isWorldSoundEnabled]]<br />
* [[isWorldSpecialPropertyEnabled]]<br />
* [[processLineOfSight]]<br />
* [[removeWorldModel]]<br />
* [[resetAmbientSounds]]<br />
* [[resetBlurLevel]]<br />
* [[resetColorFilter]]<br />
* [[resetCoronaReflectionsEnabled]]<br />
* [[resetFarClipDistance]]<br />
* [[resetFogDistance]]<br />
* [[resetHeatHaze]]<br />
* [[resetMoonSize]]<br />
* [[resetNearClipDistance]]<br />
* [[resetPedsLODDistance]]<br />
* [[resetRainLevel]]<br />
* [[resetSkyGradient]]<br />
* [[resetSunColor]]<br />
* [[resetSunSize]]<br />
* [[resetVehiclesLODDistance]]<br />
* [[resetWindVelocity]]<br />
* [[resetWorldSounds]]<br />
* [[restoreAllWorldModels]]<br />
* [[restoreWorldModel]]<br />
* [[setAircraftMaxHeight]]<br />
* [[setAircraftMaxVelocity]]<br />
* [[setAmbientSoundEnabled]]<br />
* [[setBirdsEnabled]]<br />
* [[setCloudsEnabled]]<br />
* [[setColorFilter]]<br />
* [[setCoronaReflectionsEnabled]]<br />
* [[setFarClipDistance]]<br />
* [[setFogDistance]]<br />
* [[setGameSpeed]]<br />
* [[setGarageOpen]]<br />
* [[setGravity]]<br />
* [[setHeatHaze]]<br />
* [[setInteriorFurnitureEnabled]]<br />
* [[setInteriorSoundsEnabled]]<br />
* [[setJetpackMaxHeight]]<br />
* [[setMinuteDuration]]<br />
* [[setMoonSize]]<br />
* [[setNearClipDistance]]<br />
* [[setOcclusionsEnabled]]<br />
* [[setPedsLODDistance]]<br />
* [[setPlayerBlurLevel]]<br />
* [[setRainLevel]]<br />
* [[setSkyGradient]]<br />
* [[setSunColor]]<br />
* [[setSunSize]]<br />
* [[setTime]]<br />
* [[setTrafficLightsLocked]]<br />
* [[setTrafficLightState]]<br />
* [[setVehiclesLODDistance]]<br />
* [[setWeather]]<br />
* [[setWeatherBlended]]<br />
* [[setWindVelocity]]<br />
* [[setWorldSoundEnabled]]<br />
* [[setWorldSpecialPropertyEnabled]]<br />
{{New feature/item|3.0161|1.6.0|21902|<br />
* [[setGrainLevel]]<br />
}}<br />
{{New feature/item|3.0161|1.6.0|21902|<br />
* [[setGrainMultiplier]]<br />
}}<br />
* [[testLineAgainstWater]]<br />
<br />
<noinclude>[[Category:Functions templates]]</noinclude></div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=SetGrainLevel&diff=77210SetGrainLevel2023-07-26T01:46:59Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
{{New feature/item|3.0161|1.6.0|21902|This function sets a level of the overlay grain effect. The game will draw it on top of other grain effects. It can be used to imitate an effect of radiation or electromagnetic disturbances, for example.}}<br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool setGrainLevel ( int level )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
*'''level:''' The amount of grain (0-255).<br />
<br />
===Returns===<br />
Returns ''true'' if the grain level was set, ''false'' otherwise.<br />
<br />
==Example==<br />
This example creates a radioactive zone at Missionary Hills:<br />
<syntaxhighlight lang="lua"><br />
setTimer( function()<br />
local zx, zy, zz = -2405.49268, -599.97339, 132.64844 -- Zone position<br />
local radius = 20 -- Zone radius<br />
<br />
local x, y, z = getElementPosition( localPlayer )<br />
local dist = getDistanceBetweenPoints3D( x, y, z, zx, zy, zz )<br />
local intensity = math.max( radius - dist, 0 ) / radius<br />
<br />
setGrainLevel( intensity * 255 )<br />
end, 100, 0 )<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Client_world_functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=SetGrainMultiplier&diff=77209SetGrainMultiplier2023-07-26T01:46:29Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
{{New feature/item|3.0161|1.6.0|21902|This function is used to adjust an intensity of the grain effect in different situations. It separately modulates an intensity of effect for infrared goggles, night vision goggles, rain and screen overlay.}}<br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool setGrainMultiplier ( string modifierName, float multiplier )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
*'''modifierName :''' The modifier name to use which can be one of:<br />
**'''master:''' The overall intersity that modulates the other ones.<br />
**'''infrared:''' The intersity of a grain effect for infrared goggles.<br />
**'''night:''' The intersity of a grain effect for night vision goggles.<br />
**'''rain :''' The intersity of a grain effect for rain.<br />
**'''overlay :''' The intersity of a grain effect for the screen overlay(see [[setGrainLevel]]).<br />
**'''all :''' Can be used to set all the modifiers above at once.<br />
*'''multiplier :''' The multiplier (0-1).<br />
<br />
===Returns===<br />
Returns ''true'' if the grain multiplier was set, ''false'' otherwise.<br />
<br />
==Example==<br />
This example disables a grain effect for the rain.<br />
<syntaxhighlight lang="lua"><br />
addCommandHandler( "disable_rain_grain", function()<br />
setGrainMultiplier( "rain", 0 )<br />
end )<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Client_world_functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=EngineAddImage&diff=77208EngineAddImage2023-07-26T01:44:31Z<p>TEDERIs: Undo revision 77204 by TEDERIs (talk)</p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
<br />
{{New feature/item|4|1.6.0|21695|This function adds an IMG file container to GTA streamer. After this GTA will asynchronously load models from IMG. '''Only two additional archives can be enabled once'''}}<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
boolean engineAddImage ( img imgArchive )<br />
</syntaxhighlight><br />
<br />
{{OOP||[[img]]:add}}<br />
===Required Arguments===<br />
* '''imgArchive''': The [[IMG]] file you want to add to GTA world.<br />
<br />
===Returns===<br />
Returns true if the [[IMG]] element was successfully added, ''false'' otherwise.<br />
<br />
==See Also==<br />
{{Engine_functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=EngineLoadIMG&diff=77207EngineLoadIMG2023-07-26T01:44:16Z<p>TEDERIs: Undo revision 77203 by TEDERIs (talk)</p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
{{New feature/item|3.0161|1.6.0|21708|This function loads an IMG container into GTA. '''Only 2 IMG archives can be loaded into GTA'''<br />
}}<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
img engineLoadIMG ( string img_file )<br />
</syntaxhighlight><br />
{{OOP||[[DFF|EngineIMG]]}}<br />
===Required Arguments===<br />
* '''img_file''': The [[filepath]] to the [[IMG]] file you want to load.<br />
<br />
===Returns===<br />
Returns an [[IMG]] element if the [[IMG]] file loaded, ''false'' otherwise.<br />
<br />
===Examples===<br />
This example loads IMG file from directory and then prints number of files in it<br />
<syntaxhighlight lang="lua"><br />
local img = engineLoadIMG('file.img')<br />
<br />
iprint('Number of files: ',#engineImageGetFiles(img))<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Engine_functions}}<br />
<br />
[[Category:Changes in 1.6.0]]</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=EngineAddImage&diff=77204EngineAddImage2023-07-25T15:56:01Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
<br />
{{New feature/item|4|1.6.0|21695|This function adds an IMG file container to GTA streamer. After this GTA will asynchronously load models from IMG. '''Only 239 additional archives can be enabled once'''}}<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
boolean engineAddImage ( img imgArchive )<br />
</syntaxhighlight><br />
<br />
{{OOP||[[img]]:add}}<br />
===Required Arguments===<br />
* '''imgArchive''': The [[IMG]] file you want to add to GTA world.<br />
<br />
===Returns===<br />
Returns true if the [[IMG]] element was successfully added, ''false'' otherwise.<br />
<br />
==See Also==<br />
{{Engine_functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=EngineLoadIMG&diff=77203EngineLoadIMG2023-07-25T15:55:33Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
{{New feature/item|3.0161|1.6.0|21708|This function loads an IMG container into GTA. '''Only 239 IMG archives can be loaded into GTA'''<br />
}}<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
img engineLoadIMG ( string img_file )<br />
</syntaxhighlight><br />
{{OOP||[[DFF|EngineIMG]]}}<br />
===Required Arguments===<br />
* '''img_file''': The [[filepath]] to the [[IMG]] file you want to load.<br />
<br />
===Returns===<br />
Returns an [[IMG]] element if the [[IMG]] file loaded, ''false'' otherwise.<br />
<br />
===Examples===<br />
This example loads IMG file from directory and then prints number of files in it<br />
<syntaxhighlight lang="lua"><br />
local img = engineLoadIMG('file.img')<br />
<br />
iprint('Number of files: ',#engineImageGetFiles(img))<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Engine_functions}}<br />
<br />
[[Category:Changes in 1.6.0]]</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=SetGrainMultiplier&diff=77202SetGrainMultiplier2023-07-25T15:51:31Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
{{New feature/item|3.0161|1.6.0|21894|This function is used to adjust an intensity of the grain effect in different situations. It separately modulates an intensity of effect for infrared goggles, night vision goggles, rain and screen overlay.}}<br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool setGrainMultiplier ( string modifierName, float multiplier )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
*'''modifierName :''' The modifier name to use which can be one of:<br />
**'''master:''' The overall intersity that modulates the other ones.<br />
**'''infrared:''' The intersity of a grain effect for infrared goggles.<br />
**'''night:''' The intersity of a grain effect for night vision goggles.<br />
**'''rain :''' The intersity of a grain effect for rain.<br />
**'''overlay :''' The intersity of a grain effect for the screen overlay(see [[setGrainLevel]]).<br />
**'''all :''' Can be used to set all the modifiers above at once.<br />
*'''multiplier :''' The multiplier (0-1).<br />
<br />
===Returns===<br />
Returns ''true'' if the grain multiplier was set, ''false'' otherwise.<br />
<br />
==Example==<br />
This example disables a grain effect for the rain.<br />
<syntaxhighlight lang="lua"><br />
addCommandHandler( "disable_rain_grain", function()<br />
setGrainMultiplier( "rain", 0 )<br />
end )<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Client_world_functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=SetGrainMultiplier&diff=77201SetGrainMultiplier2023-07-25T15:51:17Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
{{New feature/item|3.0161|1.6.0|21894|This function is used to adjust an intensity of the grain effect in different situations. It separately modulates an intensity of effect for infrared goggles, night vision goggles, rain and screen overlay.}}<br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool setGrainMultiplier ( string modifierName, float multiplier )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
*'''modifierName :''' The modifier name to use which can be one of:<br />
**'''master:''' The overall intersity that modulates the other ones.<br />
**'''infrared:''' The intersity of a grain effect for infrared goggles.<br />
**'''night:''' The intersity of a grain effect for night vision goggles.<br />
**'''rain :''' The intersity of a grain effect for rain.<br />
**'''overlay :''' The intersity of a grain effect for a screen overlay(see [[setGrainLevel]]).<br />
**'''all :''' Can be used to set all the modifiers above at once.<br />
*'''multiplier :''' The multiplier (0-1).<br />
<br />
===Returns===<br />
Returns ''true'' if the grain multiplier was set, ''false'' otherwise.<br />
<br />
==Example==<br />
This example disables a grain effect for the rain.<br />
<syntaxhighlight lang="lua"><br />
addCommandHandler( "disable_rain_grain", function()<br />
setGrainMultiplier( "rain", 0 )<br />
end )<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Client_world_functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=Template:Client_world_functions&diff=77200Template:Client world functions2023-07-25T15:49:12Z<p>TEDERIs: </p>
<hr />
<div>* [[areTrafficLightsLocked]]<br />
* [[createSWATRope]]<br />
* [[getAircraftMaxHeight]]<br />
* [[getAircraftMaxVelocity]]<br />
* [[getBirdsEnabled]]<br />
* [[getCloudsEnabled]]<br />
* [[getCoronaReflectionsEnabled]]<br />
* [[getFarClipDistance]]<br />
* [[getFogDistance]]<br />
* [[getGameSpeed]]<br />
* [[getGarageBoundingBox]]<br />
* [[getGaragePosition]]<br />
* [[getGarageSize]]<br />
* [[getGravity]]<br />
* [[getGroundPosition]]<br />
* [[getHeatHaze]]<br />
* [[getInteriorFurnitureEnabled]]<br />
* [[getInteriorSoundsEnabled]]<br />
* [[getJetpackMaxHeight]]<br />
* [[getMinuteDuration]]<br />
* [[getMoonSize]]<br />
* [[getNearClipDistance]]<br />
* [[getOcclusionsEnabled]]<br />
* [[getPedsLODDistance]]<br />
* [[getPlayerBlurLevel]]<br />
* [[getRainLevel]]<br />
{{Added feature/item|1.5.9|1.5.8|20675|<br />
* [[getRoofPosition]]<br />
}}<br />
* [[getScreenFromWorldPosition]]<br />
* [[getSunColor]]<br />
* [[getSunSize]]<br />
* [[getTime]]<br />
* [[getTrafficLightState]]<br />
* [[getVehiclesLODDistance]]<br />
* [[getWeather]]<br />
* [[getWindVelocity]]<br />
* [[getWorldFromScreenPosition]]<br />
* [[getZoneName]]<br />
* [[isAmbientSoundEnabled]]<br />
* [[isGarageOpen]]<br />
* [[isLineOfSightClear]]<br />
* [[isWorldSoundEnabled]]<br />
* [[isWorldSpecialPropertyEnabled]]<br />
* [[processLineOfSight]]<br />
* [[removeWorldModel]]<br />
* [[resetAmbientSounds]]<br />
* [[resetBlurLevel]]<br />
* [[resetColorFilter]]<br />
* [[resetCoronaReflectionsEnabled]]<br />
* [[resetFarClipDistance]]<br />
* [[resetFogDistance]]<br />
* [[resetHeatHaze]]<br />
* [[resetMoonSize]]<br />
* [[resetNearClipDistance]]<br />
* [[resetPedsLODDistance]]<br />
* [[resetRainLevel]]<br />
* [[resetSkyGradient]]<br />
* [[resetSunColor]]<br />
* [[resetSunSize]]<br />
* [[resetVehiclesLODDistance]]<br />
* [[resetWindVelocity]]<br />
* [[resetWorldSounds]]<br />
* [[restoreAllWorldModels]]<br />
* [[restoreWorldModel]]<br />
* [[setAircraftMaxHeight]]<br />
* [[setAircraftMaxVelocity]]<br />
* [[setAmbientSoundEnabled]]<br />
* [[setBirdsEnabled]]<br />
* [[setCloudsEnabled]]<br />
* [[setColorFilter]]<br />
* [[setCoronaReflectionsEnabled]]<br />
* [[setFarClipDistance]]<br />
* [[setFogDistance]]<br />
* [[setGameSpeed]]<br />
* [[setGarageOpen]]<br />
* [[setGravity]]<br />
* [[setHeatHaze]]<br />
* [[setInteriorFurnitureEnabled]]<br />
* [[setInteriorSoundsEnabled]]<br />
* [[setJetpackMaxHeight]]<br />
* [[setMinuteDuration]]<br />
* [[setMoonSize]]<br />
* [[setNearClipDistance]]<br />
* [[setOcclusionsEnabled]]<br />
* [[setPedsLODDistance]]<br />
* [[setPlayerBlurLevel]]<br />
* [[setRainLevel]]<br />
* [[setSkyGradient]]<br />
* [[setSunColor]]<br />
* [[setSunSize]]<br />
* [[setTime]]<br />
* [[setTrafficLightsLocked]]<br />
* [[setTrafficLightState]]<br />
* [[setVehiclesLODDistance]]<br />
* [[setWeather]]<br />
* [[setWeatherBlended]]<br />
* [[setWindVelocity]]<br />
* [[setWorldSoundEnabled]]<br />
* [[setWorldSpecialPropertyEnabled]]<br />
{{New feature/item|3.0161|1.6.0|21894|<br />
* [[setGrainLevel]]<br />
}}<br />
{{New feature/item|3.0161|1.6.0|21894|<br />
* [[setGrainMultiplier]]<br />
}}<br />
* [[testLineAgainstWater]]<br />
<br />
<noinclude>[[Category:Functions templates]]</noinclude></div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=SetGrainMultiplier&diff=77199SetGrainMultiplier2023-07-25T15:48:21Z<p>TEDERIs: Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0161|1.6.0|21894|This function is used to adjust an intensity of the grain effect in different situations. It separately modulates an intensity of effect for infrared goggles, night vision goggles, rain and screen overlay.}} ==Syntax== <syntaxhighlight lang="lua"> bool setGrainMultiplier ( string modifierName, float multiplier ) </syntaxhighlight> ===Required Arguments=== *'''modifierName :''' The modifier name to u..."</p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
{{New feature/item|3.0161|1.6.0|21894|This function is used to adjust an intensity of the grain effect in different situations. It separately modulates an intensity of effect for infrared goggles, night vision goggles, rain and screen overlay.}}<br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool setGrainMultiplier ( string modifierName, float multiplier )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
*'''modifierName :''' The modifier name to use which can be one of:<br />
**'''master:''' The overall intersity that modulates the other ones.<br />
**'''infrared:''' The intersity of a grain effect for infrared goggles.<br />
**'''night:''' The intersity of a grain effect for night vision goggles.<br />
**'''rain :''' The intersity of a grain effect for rain.<br />
**'''overlay :''' The intersity of a grain effect for a screen overlay(see setGrainLevel).<br />
**'''all :''' Can be used to set all the modifiers above at once.<br />
*'''multiplier :''' The multiplier (0-1).<br />
<br />
===Returns===<br />
Returns ''true'' if the grain multiplier was set, ''false'' otherwise.<br />
<br />
==Example==<br />
This example disables a grain effect for the rain.<br />
<syntaxhighlight lang="lua"><br />
addCommandHandler( "disable_rain_grain", function()<br />
setGrainMultiplier( "rain", 0 )<br />
end )<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Client_world_functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=SetGrainLevel&diff=77196SetGrainLevel2023-07-25T15:30:19Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
{{New feature/item|3.0161|1.6.0|21894|This function sets a level of the overlay grain effect. The game will draw it on top of other grain effects. It can be used to imitate an effect of radiation or electromagnetic disturbances, for example.}}<br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool setGrainLevel ( int level )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
*'''level:''' The amount of grain (0-255).<br />
<br />
===Returns===<br />
Returns ''true'' if the grain level was set, ''false'' otherwise.<br />
<br />
==Example==<br />
This example creates a radioactive zone at Missionary Hills:<br />
<syntaxhighlight lang="lua"><br />
setTimer( function()<br />
local zx, zy, zz = -2405.49268, -599.97339, 132.64844 -- Zone position<br />
local radius = 20 -- Zone radius<br />
<br />
local x, y, z = getElementPosition( localPlayer )<br />
local dist = getDistanceBetweenPoints3D( x, y, z, zx, zy, zz )<br />
local intensity = math.max( radius - dist, 0 ) / radius<br />
<br />
setGrainLevel( intensity * 255 )<br />
end, 100, 0 )<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Client_world_functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=SetGrainLevel&diff=77195SetGrainLevel2023-07-25T15:29:50Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
{{New feature/item|3.0161|1.6.0|21894|This function sets a level of the overlay grain effect. The game will draw it on top of another grain effects. It can be used to imitate an effect of radiation or electromagnetic disturbances, for example.}}<br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool setGrainLevel ( int level )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
*'''level:''' The amount of grain (0-255).<br />
<br />
===Returns===<br />
Returns ''true'' if the grain level was set, ''false'' otherwise.<br />
<br />
==Example==<br />
This example creates a radioactive zone at Missionary Hills:<br />
<syntaxhighlight lang="lua"><br />
setTimer( function()<br />
local zx, zy, zz = -2405.49268, -599.97339, 132.64844 -- Zone position<br />
local radius = 20 -- Zone radius<br />
<br />
local x, y, z = getElementPosition( localPlayer )<br />
local dist = getDistanceBetweenPoints3D( x, y, z, zx, zy, zz )<br />
local intensity = math.max( radius - dist, 0 ) / radius<br />
<br />
setGrainLevel( intensity * 255 )<br />
end, 100, 0 )<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Client_world_functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=Template:Client_world_functions&diff=77194Template:Client world functions2023-07-25T15:29:30Z<p>TEDERIs: </p>
<hr />
<div>* [[areTrafficLightsLocked]]<br />
* [[createSWATRope]]<br />
* [[getAircraftMaxHeight]]<br />
* [[getAircraftMaxVelocity]]<br />
* [[getBirdsEnabled]]<br />
* [[getCloudsEnabled]]<br />
* [[getCoronaReflectionsEnabled]]<br />
* [[getFarClipDistance]]<br />
* [[getFogDistance]]<br />
* [[getGameSpeed]]<br />
* [[getGarageBoundingBox]]<br />
* [[getGaragePosition]]<br />
* [[getGarageSize]]<br />
* [[getGravity]]<br />
* [[getGroundPosition]]<br />
* [[getHeatHaze]]<br />
* [[getInteriorFurnitureEnabled]]<br />
* [[getInteriorSoundsEnabled]]<br />
* [[getJetpackMaxHeight]]<br />
* [[getMinuteDuration]]<br />
* [[getMoonSize]]<br />
* [[getNearClipDistance]]<br />
* [[getOcclusionsEnabled]]<br />
* [[getPedsLODDistance]]<br />
* [[getPlayerBlurLevel]]<br />
* [[getRainLevel]]<br />
{{Added feature/item|1.5.9|1.5.8|20675|<br />
* [[getRoofPosition]]<br />
}}<br />
* [[getScreenFromWorldPosition]]<br />
* [[getSunColor]]<br />
* [[getSunSize]]<br />
* [[getTime]]<br />
* [[getTrafficLightState]]<br />
* [[getVehiclesLODDistance]]<br />
* [[getWeather]]<br />
* [[getWindVelocity]]<br />
* [[getWorldFromScreenPosition]]<br />
* [[getZoneName]]<br />
* [[isAmbientSoundEnabled]]<br />
* [[isGarageOpen]]<br />
* [[isLineOfSightClear]]<br />
* [[isWorldSoundEnabled]]<br />
* [[isWorldSpecialPropertyEnabled]]<br />
* [[processLineOfSight]]<br />
* [[removeWorldModel]]<br />
* [[resetAmbientSounds]]<br />
* [[resetBlurLevel]]<br />
* [[resetColorFilter]]<br />
* [[resetCoronaReflectionsEnabled]]<br />
* [[resetFarClipDistance]]<br />
* [[resetFogDistance]]<br />
* [[resetHeatHaze]]<br />
* [[resetMoonSize]]<br />
* [[resetNearClipDistance]]<br />
* [[resetPedsLODDistance]]<br />
* [[resetRainLevel]]<br />
* [[resetSkyGradient]]<br />
* [[resetSunColor]]<br />
* [[resetSunSize]]<br />
* [[resetVehiclesLODDistance]]<br />
* [[resetWindVelocity]]<br />
* [[resetWorldSounds]]<br />
* [[restoreAllWorldModels]]<br />
* [[restoreWorldModel]]<br />
* [[setAircraftMaxHeight]]<br />
* [[setAircraftMaxVelocity]]<br />
* [[setAmbientSoundEnabled]]<br />
* [[setBirdsEnabled]]<br />
* [[setCloudsEnabled]]<br />
* [[setColorFilter]]<br />
* [[setCoronaReflectionsEnabled]]<br />
* [[setFarClipDistance]]<br />
* [[setFogDistance]]<br />
* [[setGameSpeed]]<br />
* [[setGarageOpen]]<br />
* [[setGravity]]<br />
* [[setHeatHaze]]<br />
* [[setInteriorFurnitureEnabled]]<br />
* [[setInteriorSoundsEnabled]]<br />
* [[setJetpackMaxHeight]]<br />
* [[setMinuteDuration]]<br />
* [[setMoonSize]]<br />
* [[setNearClipDistance]]<br />
* [[setOcclusionsEnabled]]<br />
* [[setPedsLODDistance]]<br />
* [[setPlayerBlurLevel]]<br />
* [[setRainLevel]]<br />
* [[setSkyGradient]]<br />
* [[setSunColor]]<br />
* [[setSunSize]]<br />
* [[setTime]]<br />
* [[setTrafficLightsLocked]]<br />
* [[setTrafficLightState]]<br />
* [[setVehiclesLODDistance]]<br />
* [[setWeather]]<br />
* [[setWeatherBlended]]<br />
* [[setWindVelocity]]<br />
* [[setWorldSoundEnabled]]<br />
* [[setWorldSpecialPropertyEnabled]]<br />
{{New feature/item|3.0161|1.6.0|21894|<br />
* [[setGrainLevel]]<br />
}}<br />
* [[testLineAgainstWater]]<br />
<br />
<noinclude>[[Category:Functions templates]]</noinclude></div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=SetGrainLevel&diff=77193SetGrainLevel2023-07-25T15:22:35Z<p>TEDERIs: Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0161|1.6.0|21894|This function sets the level of the overlay grain effect. The game will draw it on top of another grain effects. It can be used to imitate an effect of radiation or electromagnetic disturbances, for example.}} ==Syntax== <syntaxhighlight lang="lua"> bool setGrainLevel ( int level ) </syntaxhighlight> ===Required Arguments=== *'''level:''' The amount of grain (0-255). ===Returns=== Returns ''true''..."</p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
{{New feature/item|3.0161|1.6.0|21894|This function sets the level of the overlay grain effect. The game will draw it on top of another grain effects. It can be used to imitate an effect of radiation or electromagnetic disturbances, for example.}}<br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool setGrainLevel ( int level )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
*'''level:''' The amount of grain (0-255).<br />
<br />
===Returns===<br />
Returns ''true'' if the grain level was set, ''false'' otherwise.<br />
<br />
==Example==<br />
This example creates a radioactive zone at Missionary Hills:<br />
<syntaxhighlight lang="lua"><br />
setTimer( function()<br />
local zx, zy, zz = -2405.49268, -599.97339, 132.64844 -- Zone position<br />
local radius = 20 -- Zone radius<br />
<br />
local x, y, z = getElementPosition( localPlayer )<br />
local dist = getDistanceBetweenPoints3D( x, y, z, zx, zy, zz )<br />
local intensity = math.max( radius - dist, 0 ) / radius<br />
<br />
setGrainLevel( intensity * 255 )<br />
end, 100, 0 )<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Client_world_functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxDrawMaterialSectionLine3D&diff=70918DxDrawMaterialSectionLine3D2021-04-24T01:48:32Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}} <br />
This function draws a textured 3D line between two points in the 3D world - rendered for one frame. This should be used in conjunction with [[onClientPreRender]] in order to display continuously.<br />
<br />
The 3D line with a large width value effectively becomes a rectangle, so it it possible to construct basic shapes such as boxes with several large width lines and the appropriate values for 'faceToward'.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool dxDrawMaterialSectionLine3D ( float startX, float startY, float startZ, float endX, float endY, float endZ,<br />
float u, float v, float usize, float vsize, [ bool flipUV = false, ] element material, float width,<br />
[ int color = white, [ bool postGUI = false, ] float faceTowardX, float faceTowardY, float faceTowardZ ] )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
* '''startX/Y/Z:''' The start position of the 3D line, representing a coordinate in the GTA world.<br />
* '''endX/Y/Z:''' The end position of the 3D line, representing a coordinate in the GTA world.<br />
*'''u:''' the absolute X coordinate of the top left corner of the section <br />
*'''v:''' the absolute Y coordinate of the top left corner of the section <br />
*'''usize:''' the absolute width of the section<br />
*'''vsize:''' the absolute height of the section<br />
* '''material:''' A [[material]] to draw the line with.<br />
* '''width:''' The width/thickness of the line in GTA world units. (This is 1/75th of the width used in dxDrawLine3D)<br />
<br />
==Optional Arguments==<br />
{{New items|3.0159|1.5.8|<br />
* '''flipUV''': A bool representing whether a UV orientation should be flipped.<br />
|20862}}<br />
* '''color:''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).<br />
{{New items|5.0155|1.5.5-9.11998|<br />
* '''postGUI''': A bool representing whether the line should be drawn on top of or behind any ingame GUI.<br />
}}<br />
* '''faceTowardX/Y/Z:''' The direction the front of the line should face towards. If this is not set, the front of the line always faces toward the camera.<br />
<br />
===Returns===<br />
Returns a ''true'' if the operation was successful, ''false'' otherwise.<br />
<br />
==Example== <br />
This example draws corona like effects near the player<br />
<syntaxhighlight lang="lua"><br />
coronaTexture = dxCreateTexture("corona.png")<br />
red = tocolor(255,0,0)<br />
green = tocolor(0,255,0)<br />
blue = tocolor(0,0,255)<br />
<br />
addEventHandler("onClientPreRender",root,<br />
function()<br />
local x,y,z = getElementPosition(localPlayer)<br />
<br />
dxSetBlendMode("add") -- Add blend mode looks best for corona effects<br />
drawCorona( x+2, y+2, z+1, 1, red )<br />
drawCorona( x+1, y+3, z+2, 1, green )<br />
drawCorona( x-1, y+2, z+3, 1, blue )<br />
dxSetBlendMode("blend") -- Restore default<br />
end<br />
)<br />
<br />
-- Draw the corona texture<br />
function drawCorona( x, y, z, size, color )<br />
dxDrawMaterialSectionLine3D ( x, y, z+size,<br />
x, y, z-size,<br />
0,0,1,1, coronaTexture, size, color)<br />
end<br />
<br />
</syntaxhighlight><br />
<br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.3.0-9.03931|}}<br />
<br />
==Changelog==<br />
{{ChangelogHeader}}<br />
{{ChangelogItem|1.5.5-9.11998|Added postGUI argument}}<br />
<br />
==See Also==<br />
{{Drawing_functions}}<br />
<br />
[[hu:dxDrawMaterialSectionLine3D]]</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxDrawMaterialLine3D&diff=70917DxDrawMaterialLine3D2021-04-24T01:46:21Z<p>TEDERIs: </p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
This function draws a textured 3D line between two points in the 3D world - rendered for one frame. This should be used in conjunction with [[onClientPreRender]] in order to display continuously.<br />
<br />
The 3D line with a large width value effectively becomes a rectangle, so it it possible to construct basic shapes such as boxes with several large width lines and the appropriate values for 'faceToward'.<br />
<br />
3D lines are drawn at a particular place in the [[Game_Processing_Order|game processing order]], so use [[onClientPreRender]] for drawing if you are attaching them to world elements.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool dxDrawMaterialLine3D ( float startX, float startY, float startZ, float endX, float endY, float endZ, [ bool flipUV = false, ] element material, float width,<br />
[ int color = white, [ bool postGUI = false, ] float faceTowardX, float faceTowardY, float faceTowardZ ] )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
* '''startX/Y/Z:''' The start position of the 3D line, representing a coordinate in the GTA world.<br />
* '''endX/Y/Z:''' The end position of the 3D line, representing a coordinate in the GTA world.<br />
* '''material:''' A [[material]] to draw the line with.<br />
* '''width:''' The width/thickness of the line in GTA world units. (This is 1/75th of the width used in dxDrawLine3D)<br />
<br />
==Optional Arguments==<br />
{{OptionalArg}}<br />
{{New items|3.0159|1.5.8|<br />
* '''flipUV''': A bool representing whether a UV orientation should be flipped.<br />
|20862}}<br />
* '''color:''' An [[int|integer]] of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).<br />
{{New items|3.0156|1.5.5|<br />
* '''postGUI''': A bool representing whether the line should be drawn on top of or behind any ingame GUI.<br />
|11998}}<br />
* '''faceTowardX/Y/Z:''' The position the front of the line should face towards. If this is not set, the camera position is used, so the front of the line faces toward the camera.<br />
<br />
===Returns===<br />
Returns a ''true'' if the operation was successful, ''false'' otherwise.<br />
<br />
==Example== <br />
Draws [[:File:DxDrawMaterialLine3D-example.png|an image]] in coordiantes -2422.68555, -608.78986, 132.56250<br />
<syntaxhighlight lang="lua"><br />
local redcircle = dxCreateTexture("red.png")<br />
<br />
x,y,z = -2422.68555, -608.78986, 132.56250<br />
<br />
size = 1<br />
<br />
addEventHandler("onClientRender", root, function()<br />
dxDrawMaterialLine3D(x+size, y+size, z-0.95, x-size, y-size, z-0.95, redcircle, size*2,tocolor(255, 255, 255, 255), x, y, z)<br />
end)<br />
</syntaxhighlight><br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.3.0-9.03931|}}<br />
<br />
==Changelog==<br />
{{ChangelogHeader}}<br />
{{ChangelogItem|1.5.5-9.11998|Added postGUI argument}}<br />
<br />
==See Also==<br />
{{Drawing_functions}}<br />
<br />
[[hu:dxDrawMaterialLine3D]]</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxCreateShader&diff=70549DxCreateShader2021-04-15T05:19:38Z<p>TEDERIs: </p>
<hr />
<div>{{Client function}}<br />
__NOTOC__<br />
This function creates a [[shader]] element that can be used in the dxDraw functions. Successful shader creation is not guaranteed unless the [[shader|Effect File]] contains a fallback technique which will work on every PC in the universe.<br />
{{Note|It is highly recommended that [[dxSetTestMode]] is used when writing and testing scripts using dxCreateShader.}}<br />
<br />
{{Deprecated items|3.0159|1.5.8|<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
element, string dxCreateShader ( string filepath / string raw_data [, float priority = 0, float maxDistance = 0, bool layered = false, string elementTypes = "world,vehicle,object,other" ] )<br />
</syntaxhighlight> <br />
{{OOP||[[Shader|DxShader]]}}<br />
===Required Arguments=== <br />
*'''filepath / raw_data:''' The filepath of the [[shader|shader Effect File]] (.fx) file or whole data buffer of the shader file<br />
<br />
===Optional Arguments===<br />
''All the following optional arguments are only relevant when the shader is used with [[engineApplyShaderToWorldTexture]]''<br />
*'''priority:''' If more than one shader is matched to a world texture, the shader with the highest priority will be used. If there is more than one shader with the same highest priority, the most recently created shader is used.<br />
*'''maxDistance:''' If non-zero, the shader will be applied to textures nearer than maxDistance only. This can speed up rendering, but (to look good) may require the shader to fade out it's own effect as the texture reaches maxDistance.<br />
*'''layered:''' When set to true, the shader will be drawn in a separate render pass. Several layered shaders can be drawn on the same world texture. (To avoid [http://en.wikipedia.org/wiki/Z-fighting Z fighting] artifacts, you may have to add '''DepthBias<nowiki>=</nowiki>-0.0002;''' to the technique pass, but this might cause visual artifacts when applied on vehicles)<br />
*'''elementTypes:''' A comma seperated list of element types to restrict this shader to. Valid element types are:<br />
** world - Textures in the GTA world<br />
** ped - Player and ped textures<br />
** vehicle - Vehicles textures<br />
** object - Objects textures<br />
** other - Element textures which are not peds, vehicles or objects<br />
** all - Everything<br />
<br />
===Returns===<br />
*'''element:''' A [[shader]] element if successful, ''false'' if invalid arguments were passed to the function. '''You should always check to see if this function has returned false.'''<br />
*'''string:''' The name of the technique that will be used.<br />
<br />
|20688}}<br />
<br />
{{New items|3.0159|1.5.8|<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
element, string dxCreateShader ( string filepath / string raw_data [ [, table macros = {} ], float priority = 0, float maxDistance = 0, bool layered = false, string elementTypes = "world,vehicle,object,other" ] )<br />
</syntaxhighlight> <br />
{{OOP||[[Shader|DxShader]]}}<br />
===Required Arguments=== <br />
*'''filepath / raw_data:''' The filepath of the [[shader|shader Effect File]] (.fx) file or whole data buffer of the shader file<br />
<br />
===Optional Arguments===<br />
''All the following optional arguments are only relevant when the shader is used with [[engineApplyShaderToWorldTexture]]''<br />
*'''macros:''' A table contains macros in an ordered and/or unordered way. See example below.<br />
*'''priority:''' If more than one shader is matched to a world texture, the shader with the highest priority will be used. If there is more than one shader with the same highest priority, the most recently created shader is used.<br />
*'''maxDistance:''' If non-zero, the shader will be applied to textures nearer than maxDistance only. This can speed up rendering, but (to look good) may require the shader to fade out it's own effect as the texture reaches maxDistance.<br />
*'''layered:''' When set to true, the shader will be drawn in a separate render pass. Several layered shaders can be drawn on the same world texture. (To avoid [http://en.wikipedia.org/wiki/Z-fighting Z fighting] artifacts, you may have to add '''DepthBias<nowiki>=</nowiki>-0.0002;''' to the technique pass, but this might cause visual artifacts when applied on vehicles)<br />
*'''elementTypes:''' A comma seperated list of element types to restrict this shader to. Valid element types are:<br />
** world - Textures in the GTA world<br />
** ped - Player and ped textures<br />
** vehicle - Vehicles textures<br />
** object - Objects textures<br />
** other - Element textures which are not peds, vehicles or objects<br />
** all - Everything<br />
<br />
===Returns===<br />
*'''element:''' A [[shader]] element if successful, ''false'' if invalid arguments were passed to the function. '''You should always check to see if this function has returned false.'''<br />
*'''string:''' The name of the technique that will be used.<br />
<br />
|20688}}<br />
<br />
==Example== <br />
<syntaxhighlight lang="lua"><br />
addEventHandler( "onClientRender", root,<br />
function()<br />
if myShader then<br />
dxDrawImage( 100, 350, 300, 350, myShader )<br />
end<br />
end<br />
)<br />
<br />
-- Use 'toggle' command to switch shader on and off<br />
addCommandHandler( "toggle",<br />
function()<br />
if not myShader then<br />
myShader = dxCreateShader( "fancything.fx" ) -- Create shader<br />
else <br />
destroyElement( myShader ) -- Destroy shader<br />
myShader = nil<br />
end<br />
end<br />
)<br />
</syntaxhighlight><br />
<br/><br />
{{New items|3.0157|1.5.6-9.14403|<br />
This example creates basic shader from raw data (without i/o) on resource start:<br />
<syntaxhighlight lang="lua"><br />
local myShader_raw_data = [[<br />
texture tex;<br />
technique replace {<br />
pass P0 {<br />
Texture[0] = tex;<br />
}<br />
}<br />
]]<br />
<br />
addEventHandler("onClientResourceStart", resourceRoot, function()<br />
local myShader = dxCreateShader(myShader_raw_data) -- create shader from raw data<br />
if isElement(myShader) then<br />
local myTexture = dxCreateTexture("some_image.png") -- create texture from image file<br />
if isElement(myTexture) then<br />
-- apply image to world texture via shader<br />
dxSetShaderValue(myShader, "tex", myTexture)<br />
engineApplyShaderToWorldTexture(myShader, "shad_ped")<br />
else<br />
outputDebugString("Unable to load texture", 1)<br />
end<br />
else<br />
outputDebugString("Unable to create shader", 1)<br />
end<br />
end)<br />
</syntaxhighlight><br />
You can pass raw data (shader code) directly into the function (example uses variable ''myShader_raw_data'').<br />
}}<br />
<br />
{{New items|3.0159|1.5.8|<br />
This example creates a basic shader using macros to change shader's behaviour<br />
<syntaxhighlight lang="lua"><br />
local shaderRawStr = [[<br />
texture MACRO_TEX_NAME;<br />
<br />
technique simple<br />
{<br />
pass P0<br />
{<br />
//-- Set up texture stage 0<br />
Texture[0] = MACRO_TEX_NAME;<br />
ColorOp[0] = SelectArg1;<br />
#ifdef MACRO_FIRST_ARG<br />
ColorArg1[0] = Texture;<br />
#else<br />
ColorArg1[0] = Diffuse;<br />
#endif<br />
AlphaOp[0] = SelectArg1;<br />
AlphaArg1[0] = Texture;<br />
<br />
//-- Disable texture stage 1<br />
ColorOp[1] = Disable;<br />
AlphaOp[1] = Disable;<br />
}<br />
}<br />
]]<br />
<br />
addEventHandler( "onClientResourceStart", resourceRoot,<br />
function ( )<br />
local shader, tech = dxCreateShader( shaderRawStr, { MACRO_TEX_NAME = "Tex0", MACRO_FIRST_ARG = true } )<br />
if not shader or tech ~= "simple" then<br />
outputDebugString( "An error was occured" )<br />
return<br />
end <br />
<br />
local texture = dxCreateTexture( "test.png" )<br />
if not texture then<br />
outputDebugString( "An error was occured" )<br />
return<br />
end<br />
<br />
dxSetShaderValue( shader, "Tex0", texture )<br />
<br />
addEventHandler( "onClientRender", root,<br />
function()<br />
dxDrawImage( 0, 0, 500, 500, shader )<br />
end<br />
, false )<br />
end<br />
, false )<br />
</syntaxhighlight><br />
You can also pass macros in key-value pairs when the order is important.<br />
|20688}}<br />
<br />
==Changelog==<br />
{{ChangelogHeader}}<br />
{{ChangelogItem|1.3.0-9.04435|Added layered and elementTypes arguments}}<br />
{{ChangelogItem|1.5.6-9.14403|Added option to use raw data instead of a file name}}<br />
{{ChangelogItem|1.5.8-9.20688|Added option to use macros}}<br />
<br />
==See Also==<br />
{{Drawing_functions}}<br />
<br />
[[hu:dxCreateShader]]</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxCreateShader&diff=70548DxCreateShader2021-04-15T05:15:18Z<p>TEDERIs: </p>
<hr />
<div>{{Client function}}<br />
__NOTOC__<br />
This function creates a [[shader]] element that can be used in the dxDraw functions. Successful shader creation is not guaranteed unless the [[shader|Effect File]] contains a fallback technique which will work on every PC in the universe.<br />
{{Note|It is highly recommended that [[dxSetTestMode]] is used when writing and testing scripts using dxCreateShader.}}<br />
<br />
{{Deprecated items|3.0159|1.5.8|<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
element, string dxCreateShader ( string filepath / string raw_data [, float priority = 0, float maxDistance = 0, bool layered = false, string elementTypes = "world,vehicle,object,other" ] )<br />
</syntaxhighlight> <br />
{{OOP||[[Shader|DxShader]]}}<br />
===Required Arguments=== <br />
*'''filepath / raw_data:''' The filepath of the [[shader|shader Effect File]] (.fx) file or whole data buffer of the shader file<br />
<br />
===Optional Arguments===<br />
''All the following optional arguments are only relevant when the shader is used with [[engineApplyShaderToWorldTexture]]''<br />
*'''priority:''' If more than one shader is matched to a world texture, the shader with the highest priority will be used. If there is more than one shader with the same highest priority, the most recently created shader is used.<br />
*'''maxDistance:''' If non-zero, the shader will be applied to textures nearer than maxDistance only. This can speed up rendering, but (to look good) may require the shader to fade out it's own effect as the texture reaches maxDistance.<br />
*'''layered:''' When set to true, the shader will be drawn in a separate render pass. Several layered shaders can be drawn on the same world texture. (To avoid [http://en.wikipedia.org/wiki/Z-fighting Z fighting] artifacts, you may have to add '''DepthBias<nowiki>=</nowiki>-0.0002;''' to the technique pass, but this might cause visual artifacts when applied on vehicles)<br />
*'''elementTypes:''' A comma seperated list of element types to restrict this shader to. Valid element types are:<br />
** world - Textures in the GTA world<br />
** ped - Player and ped textures<br />
** vehicle - Vehicles textures<br />
** object - Objects textures<br />
** other - Element textures which are not peds, vehicles or objects<br />
** all - Everything<br />
<br />
===Returns===<br />
*'''element:''' A [[shader]] element if successful, ''false'' if invalid arguments were passed to the function. '''You should always check to see if this function has returned false.'''<br />
*'''string:''' The name of the technique that will be used.<br />
<br />
|20688}}<br />
<br />
{{New items|3.0159|1.5.8|<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
element, string dxCreateShader ( string filepath / string raw_data [, [table macros = {},] float priority = 0, float maxDistance = 0, bool layered = false, string elementTypes = "world,vehicle,object,other" ] )<br />
</syntaxhighlight> <br />
{{OOP||[[Shader|DxShader]]}}<br />
===Required Arguments=== <br />
*'''filepath / raw_data:''' The filepath of the [[shader|shader Effect File]] (.fx) file or whole data buffer of the shader file<br />
<br />
===Optional Arguments===<br />
''All the following optional arguments are only relevant when the shader is used with [[engineApplyShaderToWorldTexture]]''<br />
*'''macros:''' A table contains macros in an ordered and/or unordered way. See example below.<br />
*'''priority:''' If more than one shader is matched to a world texture, the shader with the highest priority will be used. If there is more than one shader with the same highest priority, the most recently created shader is used.<br />
*'''maxDistance:''' If non-zero, the shader will be applied to textures nearer than maxDistance only. This can speed up rendering, but (to look good) may require the shader to fade out it's own effect as the texture reaches maxDistance.<br />
*'''layered:''' When set to true, the shader will be drawn in a separate render pass. Several layered shaders can be drawn on the same world texture. (To avoid [http://en.wikipedia.org/wiki/Z-fighting Z fighting] artifacts, you may have to add '''DepthBias<nowiki>=</nowiki>-0.0002;''' to the technique pass, but this might cause visual artifacts when applied on vehicles)<br />
*'''elementTypes:''' A comma seperated list of element types to restrict this shader to. Valid element types are:<br />
** world - Textures in the GTA world<br />
** ped - Player and ped textures<br />
** vehicle - Vehicles textures<br />
** object - Objects textures<br />
** other - Element textures which are not peds, vehicles or objects<br />
** all - Everything<br />
<br />
===Returns===<br />
*'''element:''' A [[shader]] element if successful, ''false'' if invalid arguments were passed to the function. '''You should always check to see if this function has returned false.'''<br />
*'''string:''' The name of the technique that will be used.<br />
<br />
|20688}}<br />
<br />
==Example== <br />
<syntaxhighlight lang="lua"><br />
addEventHandler( "onClientRender", root,<br />
function()<br />
if myShader then<br />
dxDrawImage( 100, 350, 300, 350, myShader )<br />
end<br />
end<br />
)<br />
<br />
-- Use 'toggle' command to switch shader on and off<br />
addCommandHandler( "toggle",<br />
function()<br />
if not myShader then<br />
myShader = dxCreateShader( "fancything.fx" ) -- Create shader<br />
else <br />
destroyElement( myShader ) -- Destroy shader<br />
myShader = nil<br />
end<br />
end<br />
)<br />
</syntaxhighlight><br />
<br/><br />
{{New items|3.0157|1.5.6-9.14403|<br />
This example creates basic shader from raw data (without i/o) on resource start:<br />
<syntaxhighlight lang="lua"><br />
local myShader_raw_data = [[<br />
texture tex;<br />
technique replace {<br />
pass P0 {<br />
Texture[0] = tex;<br />
}<br />
}<br />
]]<br />
<br />
addEventHandler("onClientResourceStart", resourceRoot, function()<br />
local myShader = dxCreateShader(myShader_raw_data) -- create shader from raw data<br />
if isElement(myShader) then<br />
local myTexture = dxCreateTexture("some_image.png") -- create texture from image file<br />
if isElement(myTexture) then<br />
-- apply image to world texture via shader<br />
dxSetShaderValue(myShader, "tex", myTexture)<br />
engineApplyShaderToWorldTexture(myShader, "shad_ped")<br />
else<br />
outputDebugString("Unable to load texture", 1)<br />
end<br />
else<br />
outputDebugString("Unable to create shader", 1)<br />
end<br />
end)<br />
</syntaxhighlight><br />
You can pass raw data (shader code) directly into the function (example uses variable ''myShader_raw_data'').<br />
}}<br />
<br />
{{New items|3.0159|1.5.8|<br />
This example creates a basic shader using macros to change shader's behaviour<br />
<syntaxhighlight lang="lua"><br />
local shaderRawStr = [[<br />
texture MACRO_TEX_NAME;<br />
<br />
technique simple<br />
{<br />
pass P0<br />
{<br />
//-- Set up texture stage 0<br />
Texture[0] = MACRO_TEX_NAME;<br />
ColorOp[0] = SelectArg1;<br />
#ifdef MACRO_FIRST_ARG<br />
ColorArg1[0] = Texture;<br />
#else<br />
ColorArg1[0] = Diffuse;<br />
#endif<br />
AlphaOp[0] = SelectArg1;<br />
AlphaArg1[0] = Texture;<br />
<br />
//-- Disable texture stage 1<br />
ColorOp[1] = Disable;<br />
AlphaOp[1] = Disable;<br />
}<br />
}<br />
]]<br />
<br />
addEventHandler( "onClientResourceStart", resourceRoot,<br />
function ( )<br />
local shader, tech = dxCreateShader( shaderRawStr, { MACRO_TEX_NAME = "Tex0", MACRO_FIRST_ARG = true } )<br />
if not shader or tech ~= "simple" then<br />
outputDebugString( "An error was occured" )<br />
return<br />
end <br />
<br />
local texture = dxCreateTexture( "test.png" )<br />
if not texture then<br />
outputDebugString( "An error was occured" )<br />
return<br />
end<br />
<br />
dxSetShaderValue( shader, "Tex0", texture )<br />
<br />
addEventHandler( "onClientRender", root,<br />
function()<br />
dxDrawImage( 0, 0, 500, 500, shader )<br />
end<br />
, false )<br />
end<br />
, false )<br />
</syntaxhighlight><br />
You can also pass macros in key-value pairs when the order is important.<br />
|20688}}<br />
<br />
==Changelog==<br />
{{ChangelogHeader}}<br />
{{ChangelogItem|1.3.0-9.04435|Added layered and elementTypes arguments}}<br />
{{ChangelogItem|1.5.6-9.14403|Added option to use raw data instead of a file name}}<br />
{{ChangelogItem|1.5.8-9.20688|Added option to use macros}}<br />
<br />
==See Also==<br />
{{Drawing_functions}}<br />
<br />
[[hu:dxCreateShader]]</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=Template:Client_world_functions&diff=67732Template:Client world functions2020-11-09T10:17:46Z<p>TEDERIs: </p>
<hr />
<div>* [[areTrafficLightsLocked]]<br />
* [[createSWATRope]]<br />
* [[getAircraftMaxHeight]]<br />
* [[getAircraftMaxVelocity]]<br />
* [[getBirdsEnabled]]<br />
* [[getCloudsEnabled]]<br />
* [[getFarClipDistance]]<br />
* [[getFogDistance]]<br />
* [[getGameSpeed]]<br />
* [[getGarageBoundingBox]]<br />
* [[getGaragePosition]]<br />
* [[getGarageSize]]<br />
* [[getGravity]]<br />
* [[getGroundPosition]]<br />
* [[getHeatHaze]]<br />
* [[getInteriorFurnitureEnabled]]<br />
* [[getInteriorSoundsEnabled]]<br />
* [[getJetpackMaxHeight]]<br />
* [[getMinuteDuration]]<br />
* [[getMoonSize]]<br />
* [[getNearClipDistance]]<br />
* [[resetNearClipDistance]]<br />
* [[getOcclusionsEnabled]]<br />
{{New items|3.0156|1.5.5|<br />
*[[getPedsLODDistance]]<br />
*[[setPedsLODDistance]]<br />
*[[resetPedsLODDistance]]<br />
|13771}}<br />
* [[getPlayerBlurLevel]]<br />
* [[getRainLevel]]<br />
* [[getScreenFromWorldPosition]]<br />
* [[getSunColor]]<br />
* [[getSunSize]]<br />
* [[getTime]]<br />
* [[getTrafficLightState]]<br />
* [[getVehiclesLODDistance]]<br />
* [[getWeather]]<br />
* [[getWindVelocity]]<br />
* [[getWorldFromScreenPosition]]<br />
* [[getZoneName]]<br />
* [[isAmbientSoundEnabled]]<br />
* [[isGarageOpen]]<br />
* [[isLineOfSightClear]]<br />
* [[isWorldSoundEnabled]]<br />
* [[isWorldSpecialPropertyEnabled]]<br />
* [[processLineOfSight]]<br />
* [[removeWorldModel]]<br />
* [[resetAmbientSounds]]<br />
{{New items|3.0158|1.5.7|<br />
*[[resetBlurLevel]]<br />
|20450}}<br />
* [[resetFarClipDistance]]<br />
* [[resetFogDistance]]<br />
* [[resetHeatHaze]]<br />
* [[resetMoonSize]]<br />
* [[resetRainLevel]]<br />
* [[resetSkyGradient]]<br />
* [[resetSunColor]]<br />
* [[resetSunSize]]<br />
* [[resetVehiclesLODDistance]]<br />
* [[resetWindVelocity]]<br />
* [[resetWorldSounds]]<br />
{{New items|3.0160|1.5.8|<br />
*[[resetColorFilter]]<br />
|20718}}<br />
* [[restoreAllWorldModels]]<br />
* [[restoreWorldModel]]<br />
* [[setAircraftMaxHeight]]<br />
* [[setAircraftMaxVelocity]]<br />
* [[setAmbientSoundEnabled]]<br />
* [[setBirdsEnabled]]<br />
* [[setCloudsEnabled]]<br />
* [[setFarClipDistance]]<br />
* [[setFogDistance]]<br />
* [[setGameSpeed]]<br />
* [[setGarageOpen]]<br />
* [[setGravity]]<br />
* [[setHeatHaze]]<br />
* [[setInteriorFurnitureEnabled]]<br />
* [[setInteriorSoundsEnabled]]<br />
* [[setJetpackMaxHeight]]<br />
* [[setMinuteDuration]]<br />
* [[setMoonSize]]<br />
* [[setNearClipDistance]]<br />
* [[setOcclusionsEnabled]]<br />
* [[setPlayerBlurLevel]]<br />
* [[setRainLevel]]<br />
* [[setSkyGradient]]<br />
* [[setSunColor]]<br />
* [[setSunSize]]<br />
* [[setTime]]<br />
* [[setTrafficLightState]]<br />
* [[setTrafficLightsLocked]]<br />
* [[setVehiclesLODDistance]]<br />
* [[setWeather]]<br />
* [[setWeatherBlended]]<br />
* [[setWindVelocity]]<br />
* [[setWorldSoundEnabled]]<br />
* [[setWorldSpecialPropertyEnabled]]<br />
{{New items|3.0160|1.5.8|<br />
*[[setColorFilter]]<br />
|20718}}<br />
* [[testLineAgainstWater]]<br />
<noinclude>[[Category:Functions templates]]</noinclude></div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=ResetColorFilter&diff=67731ResetColorFilter2020-11-09T10:16:45Z<p>TEDERIs: Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0160|1.5.8|20718|This function is used to reset the color filtering to its default values.}} ==Syntax== <syntaxhighlight..."</p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
{{New feature/item|3.0160|1.5.8|20718|This function is used to reset the color filtering to its default values.}}<br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool resetColorFilter ()<br />
</syntaxhighlight><br />
<br />
===Returns===<br />
Returns true if the color filtering was reset, false otherwise.<br />
<br />
==Example==<br />
This example lets any player reset the color filtering<br />
<syntaxhighlight lang="lua"><br />
function resetFilter()<br />
resetColorFilter()<br />
end<br />
addCommandHandler("reset_filter", resetFilter) -- Add the command<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{World functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=Template:Client_world_functions&diff=67730Template:Client world functions2020-11-09T10:09:20Z<p>TEDERIs: </p>
<hr />
<div>* [[areTrafficLightsLocked]]<br />
* [[createSWATRope]]<br />
* [[getAircraftMaxHeight]]<br />
* [[getAircraftMaxVelocity]]<br />
* [[getBirdsEnabled]]<br />
* [[getCloudsEnabled]]<br />
* [[getFarClipDistance]]<br />
* [[getFogDistance]]<br />
* [[getGameSpeed]]<br />
* [[getGarageBoundingBox]]<br />
* [[getGaragePosition]]<br />
* [[getGarageSize]]<br />
* [[getGravity]]<br />
* [[getGroundPosition]]<br />
* [[getHeatHaze]]<br />
* [[getInteriorFurnitureEnabled]]<br />
* [[getInteriorSoundsEnabled]]<br />
* [[getJetpackMaxHeight]]<br />
* [[getMinuteDuration]]<br />
* [[getMoonSize]]<br />
* [[getNearClipDistance]]<br />
* [[resetNearClipDistance]]<br />
* [[getOcclusionsEnabled]]<br />
{{New items|3.0156|1.5.5|<br />
*[[getPedsLODDistance]]<br />
*[[setPedsLODDistance]]<br />
*[[resetPedsLODDistance]]<br />
|13771}}<br />
* [[getPlayerBlurLevel]]<br />
* [[getRainLevel]]<br />
* [[getScreenFromWorldPosition]]<br />
* [[getSunColor]]<br />
* [[getSunSize]]<br />
* [[getTime]]<br />
* [[getTrafficLightState]]<br />
* [[getVehiclesLODDistance]]<br />
* [[getWeather]]<br />
* [[getWindVelocity]]<br />
* [[getWorldFromScreenPosition]]<br />
* [[getZoneName]]<br />
* [[isAmbientSoundEnabled]]<br />
* [[isGarageOpen]]<br />
* [[isLineOfSightClear]]<br />
* [[isWorldSoundEnabled]]<br />
* [[isWorldSpecialPropertyEnabled]]<br />
* [[processLineOfSight]]<br />
* [[removeWorldModel]]<br />
* [[resetAmbientSounds]]<br />
{{New items|3.0158|1.5.7|<br />
*[[resetBlurLevel]]<br />
|20450}}<br />
* [[resetFarClipDistance]]<br />
* [[resetFogDistance]]<br />
* [[resetHeatHaze]]<br />
* [[resetMoonSize]]<br />
* [[resetRainLevel]]<br />
* [[resetSkyGradient]]<br />
* [[resetSunColor]]<br />
* [[resetSunSize]]<br />
* [[resetVehiclesLODDistance]]<br />
* [[resetWindVelocity]]<br />
* [[resetWorldSounds]]<br />
* [[restoreAllWorldModels]]<br />
* [[restoreWorldModel]]<br />
* [[setAircraftMaxHeight]]<br />
* [[setAircraftMaxVelocity]]<br />
* [[setAmbientSoundEnabled]]<br />
* [[setBirdsEnabled]]<br />
* [[setCloudsEnabled]]<br />
* [[setFarClipDistance]]<br />
* [[setFogDistance]]<br />
* [[setGameSpeed]]<br />
* [[setGarageOpen]]<br />
* [[setGravity]]<br />
* [[setHeatHaze]]<br />
* [[setInteriorFurnitureEnabled]]<br />
* [[setInteriorSoundsEnabled]]<br />
* [[setJetpackMaxHeight]]<br />
* [[setMinuteDuration]]<br />
* [[setMoonSize]]<br />
* [[setNearClipDistance]]<br />
* [[setOcclusionsEnabled]]<br />
* [[setPlayerBlurLevel]]<br />
* [[setRainLevel]]<br />
* [[setSkyGradient]]<br />
* [[setSunColor]]<br />
* [[setSunSize]]<br />
* [[setTime]]<br />
* [[setTrafficLightState]]<br />
* [[setTrafficLightsLocked]]<br />
* [[setVehiclesLODDistance]]<br />
* [[setWeather]]<br />
* [[setWeatherBlended]]<br />
* [[setWindVelocity]]<br />
* [[setWorldSoundEnabled]]<br />
* [[setWorldSpecialPropertyEnabled]]<br />
{{New items|3.0160|1.5.8|<br />
*[[setColorFilter]]<br />
|20718}}<br />
* [[testLineAgainstWater]]<br />
<noinclude>[[Category:Functions templates]]</noinclude></div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=SetColorFilter&diff=67729SetColorFilter2020-11-09T09:47:25Z<p>TEDERIs: Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0160|1.5.8|20718|This function is used to override the default color filtering values.}} {{Tip|Normally the game is adding..."</p>
<hr />
<div>__NOTOC__ <br />
{{Client function}}<br />
{{New feature/item|3.0160|1.5.8|20718|This function is used to override the default color filtering values.}}<br />
{{Tip|Normally the game is adding these colors to a screen to simulate weather effects. Sometimes it can be important to disable these effects. You can get rid of the effects by calling this function with zero values.}} <br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool setColorFilter ( int aRed, int aGreen, int aBlue, int aAlpha, int bRed, int bGreen, int bBlue, int bAlpha )<br />
</syntaxhighlight><br />
<br />
===Required Arguments=== <br />
*'''aRed:''' The amount of red (0-255).<br />
*'''aGreen:''' The amount of green (0-255).<br />
*'''aBlue:''' The amount of blue (0-255).<br />
*'''aAlpha:''' The amount of alpha (0-255).<br />
*'''bRed:''' The amount of red (0-255).<br />
*'''bGreen:''' The amount of green (0-255).<br />
*'''bBlue:''' The amount of blue (0-255).<br />
*'''bAlpha:''' The amount of alpha (0-255).<br />
<br />
===Returns===<br />
Returns true if the color filter was set, false otherwise.<br />
<br />
==Example==<br />
This example lets any player disable the default color filtering<br />
<syntaxhighlight lang="lua"><br />
function disableFilter()<br />
setColorFilter(0, 0, 0, 0, 0, 0, 0, 0)<br />
end<br />
addCommandHandler("disable_filter", disableFilter) -- Add the command<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{World functions}}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxCreateShader&diff=67646DxCreateShader2020-10-27T10:00:47Z<p>TEDERIs: </p>
<hr />
<div>{{Client function}}<br />
__NOTOC__<br />
This function creates a [[shader]] element that can be used in the dxDraw functions. Successful shader creation is not guaranteed unless the [[shader|Effect File]] contains a fallback technique which will work on every PC in the universe.<br />
<br />
<h5>It is highly recommended that [[dxSetTestMode]] is used when writing and testing scripts using dxCreateShader.</h5><br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
element, string dxCreateShader ( string filepath / string raw_data [, float priority = 0, float maxDistance = 0, bool layered = false, string elementTypes = "world,vehicle,object,other" ] )<br />
</syntaxhighlight> <br />
{{OOP||[[Shader|DxShader]]}}<br />
===Required Arguments=== <br />
*'''filepath / raw_data:''' The filepath of the [[shader|shader Effect File]] (.fx) file or whole data buffer of the shader file<br />
<br />
===Optional Arguments===<br />
''All the following optional arguments are only relevant when the shader is used with [[engineApplyShaderToWorldTexture]]''<br />
*'''priority:''' If more than one shader is matched to a world texture, the shader with the highest priority will be used. If there is more than one shader with the same highest priority, the most recently created shader is used.<br />
*'''maxDistance:''' If non-zero, the shader will be applied to textures nearer than maxDistance only. This can speed up rendering, but (to look good) may require the shader to fade out it's own effect as the texture reaches maxDistance.<br />
*'''layered:''' When set to true, the shader will be drawn in a separate render pass. Several layered shaders can be drawn on the same world texture. (To avoid [http://en.wikipedia.org/wiki/Z-fighting Z fighting] artifacts, you may have to add '''DepthBias<nowiki>=</nowiki>-0.0002;''' to the technique pass, but this might cause visual artifacts when applied on vehicles)<br />
*'''elementTypes:''' A comma seperated list of element types to restrict this shader to. Valid element types are:<br />
** world - Textures in the GTA world<br />
** ped - Player and ped textures<br />
** vehicle - Vehicles textures<br />
** object - Objects textures<br />
** other - Element textures which are not peds, vehicles or objects<br />
** all - Everything<br />
<br />
===Returns===<br />
*'''element:''' A [[shader]] element if successful, ''false'' if invalid arguments were passed to the function. '''You should always check to see if this function has returned false.'''<br />
*'''string:''' The name of the technique that will be used.<br />
<br />
{{New items|5.0157|1.5.8-9.20688|<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
element, string dxCreateShader ( string filepath / string raw_data [, table macros = {}, float priority = 0, float maxDistance = 0, bool layered = false, string elementTypes = "world,vehicle,object,other" ] )<br />
</syntaxhighlight> <br />
{{OOP||[[Shader|DxShader]]}}<br />
===Required Arguments=== <br />
*'''filepath / raw_data:''' The filepath of the [[shader|shader Effect File]] (.fx) file or whole data buffer of the shader file<br />
<br />
===Optional Arguments===<br />
''All the following optional arguments are only relevant when the shader is used with [[engineApplyShaderToWorldTexture]]''<br />
*'''macros:''' A table contains macros in an ordered and/or unordered way. See example below.<br />
*'''priority:''' If more than one shader is matched to a world texture, the shader with the highest priority will be used. If there is more than one shader with the same highest priority, the most recently created shader is used.<br />
*'''maxDistance:''' If non-zero, the shader will be applied to textures nearer than maxDistance only. This can speed up rendering, but (to look good) may require the shader to fade out it's own effect as the texture reaches maxDistance.<br />
*'''layered:''' When set to true, the shader will be drawn in a separate render pass. Several layered shaders can be drawn on the same world texture. (To avoid [http://en.wikipedia.org/wiki/Z-fighting Z fighting] artifacts, you may have to add '''DepthBias<nowiki>=</nowiki>-0.0002;''' to the technique pass, but this might cause visual artifacts when applied on vehicles)<br />
*'''elementTypes:''' A comma seperated list of element types to restrict this shader to. Valid element types are:<br />
** world - Textures in the GTA world<br />
** ped - Player and ped textures<br />
** vehicle - Vehicles textures<br />
** object - Objects textures<br />
** other - Element textures which are not peds, vehicles or objects<br />
** all - Everything<br />
<br />
===Returns===<br />
*'''element:''' A [[shader]] element if successful, ''false'' if invalid arguments were passed to the function. '''You should always check to see if this function has returned false.'''<br />
*'''string:''' The name of the technique that will be used.<br />
<br />
}}<br />
<br />
==Example== <br />
<syntaxhighlight lang="lua"><br />
addEventHandler( "onClientRender", root,<br />
function()<br />
if myShader then<br />
dxDrawImage( 100, 350, 300, 350, myShader )<br />
end<br />
end<br />
)<br />
<br />
-- Use 'toggle' command to switch shader on and off<br />
addCommandHandler( "toggle",<br />
function()<br />
if not myShader then<br />
myShader = dxCreateShader( "fancything.fx" ) -- Create shader<br />
else <br />
destroyElement( myShader ) -- Destroy shader<br />
myShader = nil<br />
end<br />
end<br />
)<br />
</syntaxhighlight><br />
<br/><br />
{{New items|5.0156|1.5.6-9.14403|<br />
This example creates basic shader from raw data (without i/o) on resource start:<br />
<syntaxhighlight lang="lua"><br />
local myShader_raw_data = [[<br />
texture tex;<br />
technique replace {<br />
pass P0 {<br />
Texture[0] = tex;<br />
}<br />
}<br />
]]<br />
<br />
addEventHandler("onClientResourceStart", resourceRoot, function()<br />
local myShader = dxCreateShader(myShader_raw_data) -- create shader from raw data<br />
if isElement(myShader) then<br />
local myTexture = dxCreateTexture("some_image.png") -- create texture from image file<br />
if isElement(myTexture) then<br />
-- apply image to world texture via shader<br />
dxSetShaderValue(myShader, "tex", myTexture)<br />
engineApplyShaderToWorldTexture(myShader, "shad_ped")<br />
else<br />
outputDebugString("Unable to load texture", 1)<br />
end<br />
else<br />
outputDebugString("Unable to create shader", 1)<br />
end<br />
end)<br />
</syntaxhighlight><br />
You can pass raw data (shader code) directly into the function (example uses variable ''myShader_raw_data'').<br />
}}<br />
<br />
{{New items|5.0157|1.5.8-9.20688|<br />
This example creates a basic shader using macros to change shader's behaviour<br />
<syntaxhighlight lang="lua"><br />
local shaderRawStr = [[<br />
texture MACRO_TEX_NAME;<br />
<br />
technique simple<br />
{<br />
pass P0<br />
{<br />
//-- Set up texture stage 0<br />
Texture[0] = MACRO_TEX_NAME;<br />
ColorOp[0] = SelectArg1;<br />
#ifdef MACRO_FIRST_ARG<br />
ColorArg1[0] = Texture;<br />
#else<br />
ColorArg1[0] = Diffuse;<br />
#endif<br />
AlphaOp[0] = SelectArg1;<br />
AlphaArg1[0] = Texture;<br />
<br />
//-- Disable texture stage 1<br />
ColorOp[1] = Disable;<br />
AlphaOp[1] = Disable;<br />
}<br />
}<br />
]]<br />
<br />
addEventHandler( "onClientResourceStart", resourceRoot,<br />
function ( )<br />
local shader, tech = dxCreateShader( shaderRawStr, { MACRO_TEX_NAME = "Tex0", MACRO_FIRST_ARG = true } )<br />
if not shader or tech ~= "simple" then<br />
outputDebugString( "An error was occured" )<br />
return<br />
end <br />
<br />
local texture = dxCreateTexture( "test.png" )<br />
if not texture then<br />
outputDebugString( "An error was occured" )<br />
return<br />
end<br />
<br />
dxSetShaderValue( shader, "Tex0", texture )<br />
<br />
addEventHandler( "onClientRender", root,<br />
function()<br />
dxDrawImage( 0, 0, 500, 500, shader )<br />
end<br />
, false )<br />
end<br />
, false )<br />
</syntaxhighlight><br />
You can also pass macros in key-value pairs when the order is important.<br />
}}<br />
<br />
==Changelog==<br />
{{ChangelogHeader}}<br />
{{ChangelogItem|1.3.0-9.04435|Added layered and elementTypes arguments}}<br />
{{ChangelogItem|1.5.6-9.14403|Added option to use raw data instead of a file name}}<br />
{{ChangelogItem|1.5.8-9.20688|Added option to use macros}}<br />
<br />
==See Also==<br />
{{Drawing_functions}}<br />
<br />
[[hu:dxCreateShader]]</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxCreateShader&diff=67645DxCreateShader2020-10-27T08:49:12Z<p>TEDERIs: </p>
<hr />
<div>{{Client function}}<br />
__NOTOC__<br />
This function creates a [[shader]] element that can be used in the dxDraw functions. Successful shader creation is not guaranteed unless the [[shader|Effect File]] contains a fallback technique which will work on every PC in the universe.<br />
<br />
<h5>It is highly recommended that [[dxSetTestMode]] is used when writing and testing scripts using dxCreateShader.</h5><br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
element, string dxCreateShader ( string filepath / string raw_data [, float priority = 0, float maxDistance = 0, bool layered = false, string elementTypes = "world,vehicle,object,other" ] )<br />
</syntaxhighlight> <br />
{{OOP||[[Shader|DxShader]]}}<br />
===Required Arguments=== <br />
*'''filepath / raw_data:''' The filepath of the [[shader|shader Effect File]] (.fx) file or whole data buffer of the shader file<br />
<br />
===Optional Arguments===<br />
''All the following optional arguments are only relevant when the shader is used with [[engineApplyShaderToWorldTexture]]''<br />
*'''priority:''' If more than one shader is matched to a world texture, the shader with the highest priority will be used. If there is more than one shader with the same highest priority, the most recently created shader is used.<br />
*'''maxDistance:''' If non-zero, the shader will be applied to textures nearer than maxDistance only. This can speed up rendering, but (to look good) may require the shader to fade out it's own effect as the texture reaches maxDistance.<br />
*'''layered:''' When set to true, the shader will be drawn in a separate render pass. Several layered shaders can be drawn on the same world texture. (To avoid [http://en.wikipedia.org/wiki/Z-fighting Z fighting] artifacts, you may have to add '''DepthBias<nowiki>=</nowiki>-0.0002;''' to the technique pass, but this might cause visual artifacts when applied on vehicles)<br />
*'''elementTypes:''' A comma seperated list of element types to restrict this shader to. Valid element types are:<br />
** world - Textures in the GTA world<br />
** ped - Player and ped textures<br />
** vehicle - Vehicles textures<br />
** object - Objects textures<br />
** other - Element textures which are not peds, vehicles or objects<br />
** all - Everything<br />
<br />
===Returns===<br />
*'''element:''' A [[shader]] element if successful, ''false'' if invalid arguments were passed to the function. '''You should always check to see if this function has returned false.'''<br />
*'''string:''' The name of the technique that will be used.<br />
<br />
{{New items|5.0157|1.5.8-9.20688|<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
element, string dxCreateShader ( string filepath / string raw_data [, table macros = {}, float priority = 0, float maxDistance = 0, bool layered = false, string elementTypes = "world,vehicle,object,other" ] )<br />
</syntaxhighlight> <br />
{{OOP||[[Shader|DxShader]]}}<br />
===Required Arguments=== <br />
*'''filepath / raw_data:''' The filepath of the [[shader|shader Effect File]] (.fx) file or whole data buffer of the shader file<br />
<br />
===Optional Arguments===<br />
''All the following optional arguments are only relevant when the shader is used with [[engineApplyShaderToWorldTexture]]''<br />
*'''macros:''' A table contains macros in an ordered and/or unordered way. See example below.<br />
*'''priority:''' If more than one shader is matched to a world texture, the shader with the highest priority will be used. If there is more than one shader with the same highest priority, the most recently created shader is used.<br />
*'''maxDistance:''' If non-zero, the shader will be applied to textures nearer than maxDistance only. This can speed up rendering, but (to look good) may require the shader to fade out it's own effect as the texture reaches maxDistance.<br />
*'''layered:''' When set to true, the shader will be drawn in a separate render pass. Several layered shaders can be drawn on the same world texture. (To avoid [http://en.wikipedia.org/wiki/Z-fighting Z fighting] artifacts, you may have to add '''DepthBias<nowiki>=</nowiki>-0.0002;''' to the technique pass, but this might cause visual artifacts when applied on vehicles)<br />
*'''elementTypes:''' A comma seperated list of element types to restrict this shader to. Valid element types are:<br />
** world - Textures in the GTA world<br />
** ped - Player and ped textures<br />
** vehicle - Vehicles textures<br />
** object - Objects textures<br />
** other - Element textures which are not peds, vehicles or objects<br />
** all - Everything<br />
<br />
===Returns===<br />
*'''element:''' A [[shader]] element if successful, ''false'' if invalid arguments were passed to the function. '''You should always check to see if this function has returned false.'''<br />
*'''string:''' The name of the technique that will be used.<br />
<br />
}}<br />
<br />
==Example== <br />
<syntaxhighlight lang="lua"><br />
addEventHandler( "onClientRender", root,<br />
function()<br />
if myShader then<br />
dxDrawImage( 100, 350, 300, 350, myShader )<br />
end<br />
end<br />
)<br />
<br />
-- Use 'toggle' command to switch shader on and off<br />
addCommandHandler( "toggle",<br />
function()<br />
if not myShader then<br />
myShader = dxCreateShader( "fancything.fx" ) -- Create shader<br />
else <br />
destroyElement( myShader ) -- Destroy shader<br />
myShader = nil<br />
end<br />
end<br />
)<br />
</syntaxhighlight><br />
<br/><br />
{{New items|5.0156|1.5.6-9.14403|<br />
This example creates basic shader from raw data (without i/o) on resource start:<br />
<syntaxhighlight lang="lua"><br />
local myShader_raw_data = [[<br />
texture tex;<br />
technique replace {<br />
pass P0 {<br />
Texture[0] = tex;<br />
}<br />
}<br />
]]<br />
<br />
addEventHandler("onClientResourceStart", resourceRoot, function()<br />
local myShader = dxCreateShader(myShader_raw_data) -- create shader from raw data<br />
if isElement(myShader) then<br />
local myTexture = dxCreateTexture("some_image.png") -- create texture from image file<br />
if isElement(myTexture) then<br />
-- apply image to world texture via shader<br />
dxSetShaderValue(myShader, "tex", myTexture)<br />
engineApplyShaderToWorldTexture(myShader, "shad_ped")<br />
else<br />
outputDebugString("Unable to load texture", 1)<br />
end<br />
else<br />
outputDebugString("Unable to create shader", 1)<br />
end<br />
end)<br />
</syntaxhighlight><br />
You can pass raw data (shader code) directly into the function (example uses variable ''myShader_raw_data'').<br />
}}<br />
<br />
{{New items|5.0157|1.5.8-9.20688|<br />
This example creates a basic shader using macros to change shader's behaviour<br />
<syntaxhighlight lang="lua"><br />
local shaderRawStr = [[<br />
texture MACRO_TEX_NAME;<br />
<br />
technique simple<br />
{<br />
pass P0<br />
{<br />
//-- Set up texture stage 0<br />
Texture[0] = MACRO_TEX_NAME;<br />
ColorOp[0] = SelectArg1;<br />
#ifdef MACRO_FIRST_ARG<br />
ColorArg1[0] = Texture;<br />
#else<br />
ColorArg1[0] = Diffuse;<br />
#endif<br />
AlphaOp[0] = SelectArg1;<br />
AlphaArg1[0] = Texture;<br />
<br />
//-- Disable texture stage 1<br />
ColorOp[1] = Disable;<br />
AlphaOp[1] = Disable;<br />
}<br />
}<br />
]]<br />
<br />
addEventHandler( "onClientResourceStart", resourceRoot,<br />
function ( )<br />
local shader, tech = dxCreateShader( shaderRawStr, { MACRO_TEX_NAME = "Tex0", MACRO_FIRST_ARG = true } )<br />
if not shader or tech ~= "simple" then<br />
outputDebugString( "An error was occured" )<br />
return<br />
end <br />
<br />
local texture = dxCreateTexture( "test.png" )<br />
if not texture then<br />
outputDebugString( "An error was occured" )<br />
return<br />
end<br />
<br />
dxSetShaderValue( shader, "Tex0", texture )<br />
<br />
addEventHandler( "onClientRender", root,<br />
function()<br />
dxDrawImage( 0, 0, 500, 500, shader )<br />
end<br />
, false )<br />
end<br />
, false )<br />
</syntaxhighlight><br />
You can also pass macros in key-value pairs when the order is important.<br />
}}<br />
<br />
==Changelog==<br />
{{ChangelogHeader}}<br />
{{ChangelogItem|1.3.0-9.04435|Added layered and elementTypes arguments}}<br />
{{ChangelogItem|1.5.6-9.14403|Added option to use raw data instead of a file name}}<br />
<br />
==See Also==<br />
{{Drawing_functions}}<br />
<br />
[[hu:dxCreateShader]]</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=DxCreateShader&diff=67644DxCreateShader2020-10-27T08:12:30Z<p>TEDERIs: </p>
<hr />
<div>{{Client function}}<br />
__NOTOC__<br />
This function creates a [[shader]] element that can be used in the dxDraw functions. Successful shader creation is not guaranteed unless the [[shader|Effect File]] contains a fallback technique which will work on every PC in the universe.<br />
<br />
<h5>It is highly recommended that [[dxSetTestMode]] is used when writing and testing scripts using dxCreateShader.</h5><br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
element, string dxCreateShader ( string filepath / string raw_data [, float priority = 0, float maxDistance = 0, bool layered = false, string elementTypes = "world,vehicle,object,other" ] )<br />
</syntaxhighlight> <br />
{{OOP||[[Shader|DxShader]]}}<br />
===Required Arguments=== <br />
*'''filepath / raw_data:''' The filepath of the [[shader|shader Effect File]] (.fx) file or whole data buffer of the shader file<br />
<br />
===Optional Arguments===<br />
''All the following optional arguments are only relevant when the shader is used with [[engineApplyShaderToWorldTexture]]''<br />
*'''priority:''' If more than one shader is matched to a world texture, the shader with the highest priority will be used. If there is more than one shader with the same highest priority, the most recently created shader is used.<br />
*'''maxDistance:''' If non-zero, the shader will be applied to textures nearer than maxDistance only. This can speed up rendering, but (to look good) may require the shader to fade out it's own effect as the texture reaches maxDistance.<br />
*'''layered:''' When set to true, the shader will be drawn in a separate render pass. Several layered shaders can be drawn on the same world texture. (To avoid [http://en.wikipedia.org/wiki/Z-fighting Z fighting] artifacts, you may have to add '''DepthBias<nowiki>=</nowiki>-0.0002;''' to the technique pass, but this might cause visual artifacts when applied on vehicles)<br />
*'''elementTypes:''' A comma seperated list of element types to restrict this shader to. Valid element types are:<br />
** world - Textures in the GTA world<br />
** ped - Player and ped textures<br />
** vehicle - Vehicles textures<br />
** object - Objects textures<br />
** other - Element textures which are not peds, vehicles or objects<br />
** all - Everything<br />
<br />
===Returns===<br />
*'''element:''' A [[shader]] element if successful, ''false'' if invalid arguments were passed to the function. '''You should always check to see if this function has returned false.'''<br />
*'''string:''' The name of the technique that will be used.<br />
<br />
{{New items|5.0157|1.5.8-9.20688|<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
element, string dxCreateShader ( string filepath / string raw_data [, table macros = {}, float priority = 0, float maxDistance = 0, bool layered = false, string elementTypes = "world,vehicle,object,other" ] )<br />
</syntaxhighlight> <br />
{{OOP||[[Shader|DxShader]]}}<br />
===Required Arguments=== <br />
*'''filepath / raw_data:''' The filepath of the [[shader|shader Effect File]] (.fx) file or whole data buffer of the shader file<br />
<br />
===Optional Arguments===<br />
''All the following optional arguments are only relevant when the shader is used with [[engineApplyShaderToWorldTexture]]''<br />
*'''macros:''' A table contains macros in an ordered and/or unordered way. See example below.<br />
*'''priority:''' If more than one shader is matched to a world texture, the shader with the highest priority will be used. If there is more than one shader with the same highest priority, the most recently created shader is used.<br />
*'''maxDistance:''' If non-zero, the shader will be applied to textures nearer than maxDistance only. This can speed up rendering, but (to look good) may require the shader to fade out it's own effect as the texture reaches maxDistance.<br />
*'''layered:''' When set to true, the shader will be drawn in a separate render pass. Several layered shaders can be drawn on the same world texture. (To avoid [http://en.wikipedia.org/wiki/Z-fighting Z fighting] artifacts, you may have to add '''DepthBias<nowiki>=</nowiki>-0.0002;''' to the technique pass, but this might cause visual artifacts when applied on vehicles)<br />
*'''elementTypes:''' A comma seperated list of element types to restrict this shader to. Valid element types are:<br />
** world - Textures in the GTA world<br />
** ped - Player and ped textures<br />
** vehicle - Vehicles textures<br />
** object - Objects textures<br />
** other - Element textures which are not peds, vehicles or objects<br />
** all - Everything<br />
<br />
===Returns===<br />
*'''element:''' A [[shader]] element if successful, ''false'' if invalid arguments were passed to the function. '''You should always check to see if this function has returned false.'''<br />
*'''string:''' The name of the technique that will be used.<br />
<br />
}}<br />
<br />
==Example== <br />
<syntaxhighlight lang="lua"><br />
addEventHandler( "onClientRender", root,<br />
function()<br />
if myShader then<br />
dxDrawImage( 100, 350, 300, 350, myShader )<br />
end<br />
end<br />
)<br />
<br />
-- Use 'toggle' command to switch shader on and off<br />
addCommandHandler( "toggle",<br />
function()<br />
if not myShader then<br />
myShader = dxCreateShader( "fancything.fx" ) -- Create shader<br />
else <br />
destroyElement( myShader ) -- Destroy shader<br />
myShader = nil<br />
end<br />
end<br />
)<br />
</syntaxhighlight><br />
<br/><br />
{{New items|5.0156|1.5.6-9.14403|<br />
This example creates basic shader from raw data (without i/o) on resource start:<br />
<syntaxhighlight lang="lua"><br />
local myShader_raw_data = [[<br />
texture tex;<br />
technique replace {<br />
pass P0 {<br />
Texture[0] = tex;<br />
}<br />
}<br />
]]<br />
<br />
addEventHandler("onClientResourceStart", resourceRoot, function()<br />
local myShader = dxCreateShader(myShader_raw_data) -- create shader from raw data<br />
if isElement(myShader) then<br />
local myTexture = dxCreateTexture("some_image.png") -- create texture from image file<br />
if isElement(myTexture) then<br />
-- apply image to world texture via shader<br />
dxSetShaderValue(myShader, "tex", myTexture)<br />
engineApplyShaderToWorldTexture(myShader, "shad_ped")<br />
else<br />
outputDebugString("Unable to load texture", 1)<br />
end<br />
else<br />
outputDebugString("Unable to create shader", 1)<br />
end<br />
end)<br />
</syntaxhighlight><br />
You can pass raw data (shader code) directly into the function (example uses variable ''myShader_raw_data'').<br />
}}<br />
<br />
==Changelog==<br />
{{ChangelogHeader}}<br />
{{ChangelogItem|1.3.0-9.04435|Added layered and elementTypes arguments}}<br />
{{ChangelogItem|1.5.6-9.14403|Added option to use raw data instead of a file name}}<br />
<br />
==See Also==<br />
{{Drawing_functions}}<br />
<br />
[[hu:dxCreateShader]]</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=RU/engineStreamingSetProperty/validProps&diff=39645RU/engineStreamingSetProperty/validProps2014-05-28T07:47:53Z<p>TEDERIs: Undo revision 39642 by TEDERIs (talk)</p>
<hr />
<div>#REDIRECT [[EngineStreamingSetProperty/validProps ru]]</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=MTA_Eir/Functions/engineStreamingSetProperty&diff=39644MTA Eir/Functions/engineStreamingSetProperty2014-05-28T07:46:39Z<p>TEDERIs: </p>
<hr />
<div>{{*Client_function}}<br />
__NOTOC__ <br />
This function changes the behavior of the GTA:SA streaming system. It is meant to optimize the performance of the game for your custom server. Changes in these properties affect the gameplay quality of the entire server.<br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool engineStreamingSetProperty ( string propertyName, var propValue )<br />
</syntaxhighlight> <br />
<br />
===Arguments===<br />
*'''propertyName:''' the name of the streaming property you want to change<br />
*'''propValue:''' value to pass to the property<br />
<br />
===Valid Properties===<br />
{{:MTA:Eir/functions/engineStreamingSetProperty/validProps_ru}}<br />
<br />
===Useful Media===<br />
* https://dl.dropboxusercontent.com/u/55896914/eir_resources/streaming_opt.zip - streaming debugging resource<br />
* https://dl.dropboxusercontent.com/u/55896914/eir_resources/streaming_test.zip - streaming mode example resource<br />
* http://youtu.be/sk8WsHwPgsU - showcase video<br />
<br />
===Returns===<br />
Returns ''true'' if valid arguments have been passed, ''false'' otherwise.<br />
<br />
==Examples== <br />
<section name="Client" class="client" show="true"><br />
This snippet ultimatively fixes the world flickering.<br />
<syntaxhighlight lang="lua"><br />
engineStreamingSetProperty( "strictNodeDistrib", false );<br />
engineStreamingSetProperty( "infiniteStreaming", true );<br />
</syntaxhighlight><br />
</section><br />
<br />
<section name="Client" class="client" show="true"><br />
This snippet sets the Streaming GC system to sparse mode. In this mode only the preallocated amount of Streaming GC nodes is allowed. Keeping a low amount of Streaming nodes is interesting for performance optimizations.<br />
<syntaxhighlight lang="lua"><br />
engineStreamingSetProperty( "gcOnDemand", true );<br />
engineStreamingSetProperty( "infiniteStreaming", false );<br />
engineStreamingSetProperty( "strictNodeDistrib", true );<br />
</syntaxhighlight><br />
</section><br />
<br />
<section name="Client" class="client" show="true"><br />
This snippet turns on fibered loading when the Streaming system is busy and leaves it that way for five seconds.<br />
<syntaxhighlight lang="lua"><br />
engineStreamingSetProperty( "isFibered", false );<br />
<br />
local lastBusyTime = false;<br />
local fiberedDuration = 5000;<br />
<br />
addEventHandler( "onClientRender", root,<br />
function()<br />
local isBusy = engineGetStreamingInfo().isBusy;<br />
<br />
if ( isBusy ) then<br />
local now = getTickCount();<br />
<br />
if not ( lastBusyTime ) then<br />
lastBusyTime = now;<br />
<br />
engineStreamingSetProperty( "isFibered", true );<br />
end<br />
elseif ( lastBusyTime ) then<br />
if ( now - lastBusyTime > fiberedDuration ) then<br />
engineStreamingSetProperty( "isFibered", false );<br />
end<br />
end<br />
end<br />
);<br />
</syntaxhighlight><br />
</section><br />
<br />
<section name="Client" class="client" show="true"><br />
This snippet makes the world load very slow. Lag spikes cannot occur due to Streaming loading anymore.<br />
<syntaxhighlight lang="lua"><br />
engineStreamingSetProperty( "isFibered", true );<br />
engineStreamingSetProperty( "fiberedPerfMult", 0 );<br />
</syntaxhighlight><br />
</section></div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=MTA:Eir/functions/engineStreamingSetProperty&diff=39643MTA:Eir/functions/engineStreamingSetProperty2014-05-28T07:45:36Z<p>TEDERIs: Undo revision 39626 by TEDERIs (talk)</p>
<hr />
<div>{{*Client_function}}<br />
__NOTOC__ <br />
This function changes the behavior of the GTA:SA streaming system. It is meant to optimize the performance of the game for your custom server. Changes in these properties affect the gameplay quality of the entire server.<br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool engineStreamingSetProperty ( string propertyName, var propValue )<br />
</syntaxhighlight> <br />
<br />
===Arguments===<br />
*'''propertyName:''' the name of the streaming property you want to change<br />
*'''propValue:''' value to pass to the property<br />
<br />
===Valid Properties===<br />
{{:MTA:Eir/functions/engineStreamingSetProperty/validProps}}<br />
<br />
===Useful Media===<br />
* https://dl.dropboxusercontent.com/u/55896914/eir_resources/streaming_opt.zip - streaming debugging resource<br />
* https://dl.dropboxusercontent.com/u/55896914/eir_resources/streaming_test.zip - streaming mode example resource<br />
* http://youtu.be/sk8WsHwPgsU - showcase video<br />
<br />
===Returns===<br />
Returns ''true'' if valid arguments have been passed, ''false'' otherwise.<br />
<br />
==Examples== <br />
<section name="Client" class="client" show="true"><br />
This snippet ultimatively fixes the world flickering.<br />
<syntaxhighlight lang="lua"><br />
engineStreamingSetProperty( "strictNodeDistrib", false );<br />
engineStreamingSetProperty( "infiniteStreaming", true );<br />
</syntaxhighlight><br />
</section><br />
<br />
<section name="Client" class="client" show="true"><br />
This snippet sets the Streaming GC system to sparse mode. In this mode only the preallocated amount of Streaming GC nodes is allowed. Keeping a low amount of Streaming nodes is interesting for performance optimizations.<br />
<syntaxhighlight lang="lua"><br />
engineStreamingSetProperty( "gcOnDemand", true );<br />
engineStreamingSetProperty( "infiniteStreaming", false );<br />
engineStreamingSetProperty( "strictNodeDistrib", true );<br />
</syntaxhighlight><br />
</section><br />
<br />
<section name="Client" class="client" show="true"><br />
This snippet turns on fibered loading when the Streaming system is busy and leaves it that way for five seconds.<br />
<syntaxhighlight lang="lua"><br />
engineStreamingSetProperty( "isFibered", false );<br />
<br />
local lastBusyTime = false;<br />
local fiberedDuration = 5000;<br />
<br />
addEventHandler( "onClientRender", root,<br />
function()<br />
local isBusy = engineGetStreamingInfo().isBusy;<br />
<br />
if ( isBusy ) then<br />
local now = getTickCount();<br />
<br />
if not ( lastBusyTime ) then<br />
lastBusyTime = now;<br />
<br />
engineStreamingSetProperty( "isFibered", true );<br />
end<br />
elseif ( lastBusyTime ) then<br />
if ( now - lastBusyTime > fiberedDuration ) then<br />
engineStreamingSetProperty( "isFibered", false );<br />
end<br />
end<br />
end<br />
);<br />
</syntaxhighlight><br />
</section><br />
<br />
<section name="Client" class="client" show="true"><br />
This snippet makes the world load very slow. Lag spikes cannot occur due to Streaming loading anymore.<br />
<syntaxhighlight lang="lua"><br />
engineStreamingSetProperty( "isFibered", true );<br />
engineStreamingSetProperty( "fiberedPerfMult", 0 );<br />
</syntaxhighlight><br />
</section></div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=RU/engineStreamingSetProperty/validProps&diff=39642RU/engineStreamingSetProperty/validProps2014-05-28T07:44:07Z<p>TEDERIs: Blanked the page</p>
<hr />
<div></div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=MTA_Eir/Functions/engineStreamingSetProperty&diff=39641MTA Eir/Functions/engineStreamingSetProperty2014-05-28T07:42:00Z<p>TEDERIs: Undo revision 39628 by TEDERIs (talk)</p>
<hr />
<div>{{*Client_function}}<br />
__NOTOC__ <br />
This function changes the behavior of the GTA:SA streaming system. It is meant to optimize the performance of the game for your custom server. Changes in these properties affect the gameplay quality of the entire server.<br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool engineStreamingSetProperty ( string propertyName, var propValue )<br />
</syntaxhighlight> <br />
<br />
===Arguments===<br />
*'''propertyName:''' the name of the streaming property you want to change<br />
*'''propValue:''' value to pass to the property<br />
<br />
===Valid Properties===<br />
{{:MTA:Eir/functions/engineStreamingSetProperty/validProps_ru}}<br />
<br />
===Useful Media===<br />
* https://dl.dropboxusercontent.com/u/55896914/eir_resources/streaming_opt.zip - streaming debugging resource<br />
* https://dl.dropboxusercontent.com/u/55896914/eir_resources/streaming_test.zip - streaming mode example resource<br />
* http://youtu.be/sk8WsHwPgsU - showcase video<br />
<br />
===Returns===<br />
Returns ''true'' if valid arguments have been passed, ''false'' otherwise.<br />
<br />
==Examples== <br />
<section name="Client" class="client" show="true"><br />
This snippet ultimatively fixes the world flickering.<br />
<syntaxhighlight lang="lua"><br />
engineStreamingSetProperty( "strictNodeDistrib", false );<br />
engineStreamingSetProperty( "infiniteStreaming", true );<br />
</syntaxhighlight><br />
</section><br />
<br />
<section name="Client" class="client" show="true"><br />
This snippet sets the Streaming GC system to sparse mode. In this mode only the preallocated amount of Streaming GC nodes is allowed. Keeping a low amount of Streaming nodes is interesting for performance optimizations.<br />
<syntaxhighlight lang="lua"><br />
engineStreamingSetProperty( "gcOnDemand", true );<br />
engineStreamingSetProperty( "infiniteStreaming", false );<br />
engineStreamingSetProperty( "strictNodeDistrib", true );<br />
</syntaxhighlight><br />
</section><br />
<br />
<section name="Client" class="client" show="true"><br />
This snippet turns on fibered loading when the Streaming system is busy and leaves it that way for five seconds.<br />
<syntaxhighlight lang="lua"><br />
engineStreamingSetProperty( "isFibered", false );<br />
<br />
local lastBusyTime = false;<br />
local fiberedDuration = 5000;<br />
<br />
addEventHandler( "onClientRender", root,<br />
function()<br />
local isBusy = engineGetStreamingInfo().isBusy;<br />
<br />
if ( isBusy ) then<br />
local now = getTickCount();<br />
<br />
if not ( lastBusyTime ) then<br />
lastBusyTime = now;<br />
<br />
engineStreamingSetProperty( "isFibered", true );<br />
end<br />
elseif ( lastBusyTime ) then<br />
if ( now - lastBusyTime > fiberedDuration ) then<br />
engineStreamingSetProperty( "isFibered", false );<br />
end<br />
end<br />
end<br />
);<br />
</syntaxhighlight><br />
</section><br />
<br />
<section name="Client" class="client" show="true"><br />
This snippet makes the world load very slow. Lag spikes cannot occur due to Streaming loading anymore.<br />
<syntaxhighlight lang="lua"><br />
engineStreamingSetProperty( "isFibered", true );<br />
engineStreamingSetProperty( "fiberedPerfMult", 0 );<br />
</syntaxhighlight><br />
</section><br />
<br />
[[ru:engineStreamingSetProperty]]</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=MTA_Eir/Functions/engineStreamingSetProperty&diff=39640MTA Eir/Functions/engineStreamingSetProperty2014-05-28T07:41:30Z<p>TEDERIs: </p>
<hr />
<div>{{*Client_function}}<br />
__NOTOC__ <br />
Эта функция изменяет поведение системы стриминга GTA:SA. Это может увеличить производительность игры для ваших пользовательских серверов. Изменение этих свойств затрагивает качество игрового процесса на всем сервере.<br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
bool engineStreamingSetProperty ( string propertyName, var propValue )<br />
</syntaxhighlight> <br />
<br />
===Arguments===<br />
*'''propertyName:''' the name of the streaming property you want to change<br />
*'''propValue:''' value to pass to the property<br />
<br />
===Valid Properties===<br />
{{:MTA:Eir/functions/engineStreamingSetProperty/validProps_ru}}<br />
<br />
===Useful Media===<br />
* https://dl.dropboxusercontent.com/u/55896914/eir_resources/streaming_opt.zip - streaming debugging resource<br />
* https://dl.dropboxusercontent.com/u/55896914/eir_resources/streaming_test.zip - streaming mode example resource<br />
* http://youtu.be/sk8WsHwPgsU - showcase video<br />
<br />
===Returns===<br />
Returns ''true'' if valid arguments have been passed, ''false'' otherwise.<br />
<br />
==Examples== <br />
<section name="Client" class="client" show="true"><br />
This snippet ultimatively fixes the world flickering.<br />
<syntaxhighlight lang="lua"><br />
engineStreamingSetProperty( "strictNodeDistrib", false );<br />
engineStreamingSetProperty( "infiniteStreaming", true );<br />
</syntaxhighlight><br />
</section><br />
<br />
<section name="Client" class="client" show="true"><br />
This snippet sets the Streaming GC system to sparse mode. In this mode only the preallocated amount of Streaming GC nodes is allowed. Keeping a low amount of Streaming nodes is interesting for performance optimizations.<br />
<syntaxhighlight lang="lua"><br />
engineStreamingSetProperty( "gcOnDemand", true );<br />
engineStreamingSetProperty( "infiniteStreaming", false );<br />
engineStreamingSetProperty( "strictNodeDistrib", true );<br />
</syntaxhighlight><br />
</section><br />
<br />
<section name="Client" class="client" show="true"><br />
This snippet turns on fibered loading when the Streaming system is busy and leaves it that way for five seconds.<br />
<syntaxhighlight lang="lua"><br />
engineStreamingSetProperty( "isFibered", false );<br />
<br />
local lastBusyTime = false;<br />
local fiberedDuration = 5000;<br />
<br />
addEventHandler( "onClientRender", root,<br />
function()<br />
local isBusy = engineGetStreamingInfo().isBusy;<br />
<br />
if ( isBusy ) then<br />
local now = getTickCount();<br />
<br />
if not ( lastBusyTime ) then<br />
lastBusyTime = now;<br />
<br />
engineStreamingSetProperty( "isFibered", true );<br />
end<br />
elseif ( lastBusyTime ) then<br />
if ( now - lastBusyTime > fiberedDuration ) then<br />
engineStreamingSetProperty( "isFibered", false );<br />
end<br />
end<br />
end<br />
);<br />
</syntaxhighlight><br />
</section><br />
<br />
<section name="Client" class="client" show="true"><br />
This snippet makes the world load very slow. Lag spikes cannot occur due to Streaming loading anymore.<br />
<syntaxhighlight lang="lua"><br />
engineStreamingSetProperty( "isFibered", true );<br />
engineStreamingSetProperty( "fiberedPerfMult", 0 );<br />
</syntaxhighlight><br />
</section><br />
<br />
[[ru:engineStreamingSetProperty]]</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=EngineStreamingSetProperty/validProps_ru&diff=39637EngineStreamingSetProperty/validProps ru2014-05-28T07:37:45Z<p>TEDERIs: </p>
<hr />
<div>{|class="wikitable"<br />
|-<br />
! Имя<br />
! Тип<br />
! Описание<br />
! Значение<br />
|-<br />
|strictNodeDistrib<br />
|boolean<br />
|Это действительно только в связке с '''infiniteStreaming'''. Если включено, сущности сначала выделяются из существующих нодов. Если отключено, сущностям разрешено выделять новые ноды стриминга из кучи не задевая существующие ноды.<br />
|Enabled<br />
|-<br />
|infiniteStreaming<br />
|boolean<br />
|Включает или отключает выделение кучи [[GTA:SA_Streaming_Garbage_Collection|Сборшика мусора нодов стриминга]]. Поведение порядка выделения может быть изменено используя '''strictNodeDistrib'''. Если включено, GTA:SA теоритически может держать бесконечное количество сущностей внутри сборщика мусора стриминга. Это также означает, что на экране теоритически может быть отрисовано бесконечное количество сущностей в одно время.<br />
|Disabled<br />
|-<br />
|gcOnDemand<br />
|boolean<br />
|Используется для запуска [[GTA:SA_Streaming_Garbage_Collection|Сборшика мусора стриминга]] в случае, когда потеряет все свободные доступные ноды GC стриминга. Весь мир проверяется на сущности за пределами экрана или находящиеся слишком далеко. Каждая сущность находит и теряет свои RenderWare данные. Когда информация об определенной модели сущности больше не используется, она освобождается. Таким образом, несколько нодов GC стриминга становятся доступными для выделения. Этот путь выделения нодов из игровых сущностей безопаснее, чем изъятие нодов стриминга реализованное Rockstar Games.<br />
|Disabled<br />
|-<br />
|nodeStealing<br />
|boolean<br />
|Позволяет или запрещает нодами [[GTA:SA_Streaming_Garbage_Collection|GC Стриминга]] изыматься первоначальной GTA:SA. Эта функциональность, которая непосредственно вызывает мерцание мира если существует нехватка нодов GC стриминга. Отключение этой функциональности будет ограничивать количество сущностей, которые могут быть высвобождены их нодами GC стриминга.<br />
|Enabled<br />
|-<br />
|isFibered<br />
|boolean<br />
|Переключает между оригинальной и fibered загрузкой [[GTA:SA_Resource_Streaming|Системы GTA:SA стриминга]]. В оригинальном режиме, большинство ресурсов загружаются одномоментно, но некоторые большие (превышают размер буфера слайсера) исключительны для загрузки и выполняются в два толчка. В fibered режиме, система стриминга может только получать определенный пользователем процентаж от времени игрового кадра, что позволяет ресурсам брать произвольное количество точков в зависимости от сложности указанных ресуров.<br />
|Enabled<br />
|-<br />
|fiberedPerfMult<br />
|number<br />
|Эта функция изменяет fibered процентаж времени загрузки кадра [[GTA:SA_Resource_Streaming|Системы стриминга MTA:Eir]]. 100% означает что система стриминга может брать так много, сколько движок забрал в последнем кадре. Если установлено на 0%, система стриминга не остановится, но сделает шаг игнорируя все настройки времени.<br />
Низкий процентаж снизит нагрузку на CPU, которую загрузчик стриминга передает каждый кадр. Пока это незаметно на высокопроизводительных CPU, но довольно значительно проявляется на слабых CPU при низких показателях процентажа когда игрок пересекает мир или входит в плотно застроенные зоны. В общем, низкий процентаж ограничивает лаги, которые происходят при загрузке плотных застроенных зон.<br />
|0.6<br />
|}</div>TEDERIshttps://wiki.multitheftauto.com/index.php?title=RU/engineStreamingSetProperty/validProps&diff=39636RU/engineStreamingSetProperty/validProps2014-05-28T07:36:34Z<p>TEDERIs: TEDERIs moved page RU/engineStreamingSetProperty/validProps to EngineStreamingSetProperty/validProps ru: Russian version</p>
<hr />
<div>#REDIRECT [[EngineStreamingSetProperty/validProps ru]]</div>TEDERIs