Multi Theft Auto: Wiki - User contributions [en]

PlaySound

2013-10-02T17:51:25Z

Skurken: Undo revision 37250 by OpenIDUser59 (talk)

__NOTOC__
{{Client function}}
Creates a [[sound]] element and plays it immediately after creation for the local player.<br />
<br />
'''Note:''' The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT, S3M and PLS(e.g. Webstream).

==Syntax==
<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped = false ] )</syntaxhighlight>

===Required Arguments===
*'''soundPath:''' The [[filepath]] or URL of the sound file you want to play. (Sound specified by filepath has to be predefined in the [[meta.xml]] file with <file /> tag.)

===Optional Arguments===
{{OptionalArg}}
*'''looped:''' A [[boolean]] representing whether the sound will be looped. To loop the sound, use ''true''. Loop is not available for streaming sounds, only for sound files.

===Returns===
Returns a [[sound]] element if the sound was successfully created, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
function wasted (killer, weapon, bodypart)
local sound = playSound("sounds/wasted.mp3") --Play wasted.mp3 from the sounds folder
setSoundVolume(sound, 0.5) -- set the sound volume to 50%
end

addEventHandler("onClientPlayerWasted", getLocalPlayer(), wasted) --add the event handler
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}
[[AR:playSound]]
[[DE:playSound]]

DxConvertPixels

2013-09-28T18:26:47Z

Skurken: No point of the section as it's already a client function

{{Client function}}
__NOTOC__
This function converts [[Texture_pixels|pixels]] from one format to another.

==Syntax==
<syntaxhighlight lang="lua">
string dxConvertPixels ( string pixels, string newFormat [, int quality = 80 ] )
</syntaxhighlight>

===Required Arguments===
*'''pixels :''' The pixels to convert the format of
*'''newFormat :''' The new format required (''''plain'''' or ''''png'''' or ''''jpeg'''')

===Optional Arguments===
*'''quality :''' The quality of the returned pixels if the new format is ''''jpeg''''

==Returns==
Returns a copy of the pixels in the new format, or ''false'' if invalid arguments were passed to the function.

==Example==
The code opens an image, read its pixels, convert the pixels to PNG, and then save it. (You can use [http://i1325.photobucket.com/albums/u630/Tourmalinelisa2/128x128.jpg this] image to test.)
<syntaxhighlight lang="lua">
addEventHandler('onClientResourceStart', resourceRoot, function()
local img = fileOpen('img.jpg')
local pixels = fileRead(img, fileGetSize(img))
local pngPixels = dxConvertPixels(pixels, 'png')
local newImg = fileCreate('img.png')
fileWrite(newImg, pngPixels)
fileClose(newImg)
fileClose(img)
end)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3|}}

==See Also==
{{Drawing_functions}}

DxGetPixelsFormat

2013-09-28T18:26:11Z

Skurken: No point of the section as it's already a client function

{{Client function}}
__NOTOC__
This function returns the format of [[Texture_pixels|pixels]] contained in a string.

==Syntax==
<syntaxhighlight lang="lua">
string dxGetPixelsFormat ( string pixels )
</syntaxhighlight>

===Required Arguments===
*'''pixels :''' The pixels to get the format of

==Returns==
Returns the format of the pixels if successful (''''plain'''' or ''''png'''' or ''''jpeg''''), ''false'' if invalid arguments were passed to the function.

==Example==
The example loads an image, gets its pixels, and outputs the pixels format. (You can use [http://i1325.photobucket.com/albums/u630/Tourmalinelisa2/128x128.jpg this] image to test.)
<syntaxhighlight lang="lua">
addEventHandler('onClientResourceStart', resourceRoot, function()
local img = fileOpen('img.jpg')
local pixels = fileRead(img, fileGetSize(img))
local pixelsFormat = dxGetPixelsFormat(pixels)
outputChatBox('Pixels format is: ' .. pixelsFormat)
fileClose(img)
end)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3|}}

==See Also==
{{Drawing_functions}}

DxGetPixelsSize

2013-09-28T18:25:00Z

Skurken: No point of the section as it's already a client function

{{Client function}}
__NOTOC__
This function gets the dimensions of [[Texture_pixels|pixels]] contained in a string. It works with all pixel formats.

==Syntax==
<syntaxhighlight lang="lua">
int int dxGetPixelsSize ( string pixels )
</syntaxhighlight>

===Required Arguments===
*'''pixels :''' The pixels to get the dimensions of

==Returns==
Returns width and height of the pixels if successful, ''false'' if invalid arguments were passed to the function.

==Example==
The example loads an image, gets its pixels, and outputs the pixels size. (You can use [http://i1325.photobucket.com/albums/u630/Tourmalinelisa2/128x128.jpg this] image to test.)
<syntaxhighlight lang="lua">
addEventHandler('onClientResourceStart', resourceRoot, function()
local img = fileOpen('img.jpg')
local pixels = fileRead(img, fileGetSize(img))
local size = dxGetPixelsSize(pixels)
outputChatBox('Pixels size is: ' .. size)
fileClose(img)
end)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3|}}

==See Also==
{{Drawing_functions}}

HttpSetResponseHeader

2013-09-28T12:30:58Z

Skurken: Example

__NOTOC__
{{HTTP function}}
This function sets the value for the specified HTTP response header of the current HTML page.

==Syntax==
<syntaxhighlight lang="lua">
bool httpSetResponseHeader ( string headerName, string headerValue )
</syntaxhighlight>

==Required Arguments==
*'''headerName:''' the HTTP header whose value is being set. You can find a list of header names [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html here]. Header names should be all ''lower case'' letters.
*'''headerValue:''' the new value for the specified header.

===Returns===
Returns ''true'' if the header value was set successfully, ''false'' otherwise.

==Example==
Using httpSetResponseHeader to set the content type. (Example from [[httpWrite]])
<syntaxhighlight lang="lua">
<*
local file = fileOpen ( "icons/icon.png" )
if file then
while not fileIsEOF(file) do
buffer = fileRead(file, 500)
httpWrite(buffer, buffer:len())
end
fileClose(file)
httpSetResponseHeader ( "content-type", "image/png")
else
*>
Could not read file
<*
end
*>
</syntaxhighlight>

==See Also==
{{HTTP functions}}

IsElementWithinAColShape

2013-09-28T11:25:38Z

Skurken:

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function checks if the [[element]] is in a [[colshape]].

==Syntax==
<section name="Server" class="server" show="true"><syntaxhighlight lang="lua"> colshape / bool isElementWithinAColShape ( element theElement ) </syntaxhighlight></section>
<section name="Client" class="client" show="true"><syntaxhighlight lang="lua"> colshape / bool isElementWithinAColShape ( [ element theElement ] ) </syntaxhighlight></section>

===Required/Optional Arguments===
* '''theElement''': The element you want to check. (If not entered in client-side function, local player will be checked instead.)

===Returns===
Returns a [[colshape]] the [[element]] is in else false if the element isn't in one or no arguments were passed.

===Code===
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">function isElementWithinAColShape(element)
if element or isElement(element)then
for _,colshape in ipairs(getElementsByType("colshape"))do
if isElementWithinColShape(element,colshape) then
return colshape
end
end
end
outputDebugString("isElementWithinAColShape - Invalid arguments or element does not exist",1)
return false
end</syntaxhighlight></section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">function isElementWithinAColShape(element)
element = element or localPlayer or getLocalPlayer()
if element or isElement(element)then
for _,colshape in ipairs(getElementsByType("colshape"))do
if isElementWithinColShape(element,colshape) then
return colshape
end
end
end
outputDebugString("isElementWithinAColShape - Element does not exist",1)
return false
end</syntaxhighlight></section>

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

==See Also==
{{Useful_Functions}}

GetTeamFromColor

2013-09-28T11:23:05Z

Skurken:

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function gets a team from it's color.
'''Note:''' If 2 teams has the same color, then the first one found will be returned!
==Syntax==
<syntaxhighlight lang="lua">team getTeamFromColor ( int r, int g, int b)</syntaxhighlight>

===Required Arguments===
* '''r''': The red color.
* '''g''': The green color.
* '''b''': The blue color.

===Return===
Returns a [[team]] else false if bad arguments were given or a team doesn't have the same color.

==Code==
<syntaxhighlight lang="lua">
function getTeamFromColor(r,g,b)
if
not r or type(r)~="number" or r<0 or r>255 or
not g or type(g)~="number" or g<0 or g>255 or
not b or type(b)~="number" or b<0 or b>255
then outputDebugString("getTeamFromColor - Bad Arguments",0) return false end

for _,team in ipairs(getElementsByType("team"))do
local tR,tG,tB = getTeamColor(team)
if tR==r and tG==g and tB==b then
return team
end
end
return false
end
</syntaxhighlight>

==Example==

Author: Jaysds1

==See Also==
{{Useful_Functions}}

GetKeyBoundToFunction

2013-09-28T11:20:15Z

Skurken:

__NOTOC__
{{Server client function}}
getKeyBoundToFunction allows retrieval of the first key bound to a function.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">string getKeyBoundToFunction( player thePlayer, function theFunction )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you are checking the function bound to a key
*'''theFunction:''' The function in which you would like to check the bound key

===Returns===
Returns a string of the first key the function was bound to.
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">string getKeyBoundToFunction( function theFunction )</syntaxhighlight>

===Required Arguments===
*'''theFunction:''' The function in which you would like to check the bound key

===Returns===
Returns a string of the first key the function was bound to.
</section>

==Example==
<section name="Client" class="client" show="true">
/key command gives bounded key to our chat function
<syntaxhighlight lang="lua">
function chat ()
outputChatBox("Test")
end
bindKey("F2","down",chat)

function key()
local boundKey = getKeyBoundToFunction(chat)
outputChatBox(boundKey)
end
addCommandHandler("key",key)
</syntaxhighlight>
This example written by '''Samurai'''
</section>

==See Also==
{{Input_functions}}

DxGetPixelsSize

2013-09-28T11:15:48Z

Skurken:

{{Client function}}
__NOTOC__
This function gets the dimensions of [[Texture_pixels|pixels]] contained in a string. It works with all pixel formats.

==Syntax==
<syntaxhighlight lang="lua">
int int dxGetPixelsSize ( string pixels )
</syntaxhighlight>

===Required Arguments===
*'''pixels :''' The pixels to get the dimensions of

==Returns==
Returns width and height of the pixels if successful, ''false'' if invalid arguments were passed to the function.

==Example==
<section name="Client" class="client" show="true">
The example loads an image, gets its pixels, and outputs the pixels size. (You can use [http://i1325.photobucket.com/albums/u630/Tourmalinelisa2/128x128.jpg this] image to test.)
<syntaxhighlight lang="lua">
addEventHandler('onClientResourceStart', resourceRoot, function()
local img = fileOpen('img.jpg')
local pixels = fileRead(img, fileGetSize(img))
local size = dxGetPixelsSize(pixels)
outputChatBox('Pixels size is: ' .. size)
fileClose(img)
end)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|n/a|1.3|}}

==See Also==
{{Drawing_functions}}

User:Skurken

2013-09-27T21:46:58Z

Skurken:

= Contributions to the Wiki =

'''27 September 2013''' Wrote example for [[dxConvertPixels]], [[DxDrawImageSection]], [[DxGetPixelsFormat]], [[DxGetPixelsSize]]

DxGetPixelsSize

2013-09-27T21:43:41Z

Skurken: Example

{{Client function}}
__NOTOC__
This function gets the dimensions of [[Texture_pixels|pixels]] contained in a string. It works with all pixel formats.

==Syntax==
<syntaxhighlight lang="lua">
int int dxGetPixelsSize ( string pixels )
</syntaxhighlight>

===Required Arguments===
*'''pixels :''' The pixels to get the dimensions of

==Returns==
Returns width and height of the pixels if successful, ''false'' if invalid arguments were passed to the function.

==Example==
<section name="Client" class="client" show="true">
The example loads an image, gets its pixels, and outputs the pixels size. (You can use [http://i1325.photobucket.com/albums/u630/Tourmalinelisa2/128x128.jpg this] image to test.)
<syntaxhighlight lang="lua">
addEventHandler('onClientResourceStart', resourceRoot, function()
local img = fileOpen('img.jpg')
local pixels = fileRead(img, fileGetSize(img))
local size = dxGetPixelsSize(pixels)
outputChatBox('Pixels size is: ' .. size)
fileClose(img)
end)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|n/a|1.3|}}

==See Also==
{{Drawing_functions}}
[[Category:Needs Example]]

DxGetPixelsFormat

2013-09-27T21:41:58Z

Skurken:

{{Client function}}
__NOTOC__
This function returns the format of [[Texture_pixels|pixels]] contained in a string.

==Syntax==
<syntaxhighlight lang="lua">
string dxGetPixelsFormat ( string pixels )
</syntaxhighlight>

===Required Arguments===
*'''pixels :''' The pixels to get the format of

==Returns==
Returns the format of the pixels if successful (''''plain'''' or ''''png'''' or ''''jpeg''''), ''false'' if invalid arguments were passed to the function.

==Example==
<section name="Client" class="client" show="true">
The example loads an image, gets its pixels, and outputs the pixels format. (You can use [http://i1325.photobucket.com/albums/u630/Tourmalinelisa2/128x128.jpg this] image to test.)
<syntaxhighlight lang="lua">
addEventHandler('onClientResourceStart', resourceRoot, function()
local img = fileOpen('img.jpg')
local pixels = fileRead(img, fileGetSize(img))
local pixelsFormat = dxGetPixelsFormat(pixels)
outputChatBox('Pixels format is: ' .. pixelsFormat)
fileClose(img)
end)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|n/a|1.3|}}

==See Also==
{{Drawing_functions}}

DxGetPixelsFormat

2013-09-27T21:38:35Z

Skurken:

{{Client function}}
__NOTOC__
This function returns the format of [[Texture_pixels|pixels]] contained in a string.

==Syntax==
<syntaxhighlight lang="lua">
string dxGetPixelsFormat ( string pixels )
</syntaxhighlight>

===Required Arguments===
*'''pixels :''' The pixels to get the format of

==Returns==
Returns the format of the pixels if successful (''''plain'''' or ''''png'''' or ''''jpeg''''), ''false'' if invalid arguments were passed to the function.

==Example==
<section name="Client" class="client" show="true">
The example loads an image, gets its pixels, and outputs the pixels format.
<syntaxhighlight lang="lua">
addEventHandler('onClientResourceStart', resourceRoot, function()
local img = fileOpen('img.jpg')
local pixels = fileRead(img, fileGetSize(img))
local pixelsFormat = dxGetPixelsFormat(pixels)
outputChatBox('Pixels format is: ' .. pixelsFormat)
fileClose(img)
end)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|n/a|1.3|}}

==See Also==
{{Drawing_functions}}

DxDrawMaterialLine3D

2013-09-27T21:22:46Z

Skurken:

__NOTOC__
{{Client function}}
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.

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'.

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.

==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawMaterialLine3D ( float startX, float startY, float startZ, float endX, float endY, float endZ,
element material, int width, [, int color = white, float faceTowardX, float faceTowardY, float faceTowardZ ] )
</syntaxhighlight>

===Required Arguments===
* '''startX/Y/Z:''' The start position of the 3D line, representing a coordinate in the GTA world.
* '''endX/Y/Z:''' The end position of the 3D line, representing a coordinate in the GTA world.
* '''material:''' A [[material]] to draw the line with.
* '''width:''' The width/thickness of the line in GTA world units. (This is 1/75th of the width used in dxDrawLine3D)

==Optional Arguments==
{{OptionalArg}}
* '''color:''' An [[int|integer]] of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''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.

===Returns===
Returns a ''true'' if the operation was successful, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
Draws an Image ( "test.png" Download : [http://i.epvpimg.com/dwsTe.png test.png] ) from the Position 0,0,3 to 0,0,15
<syntaxhighlight lang="lua">local img = dxCreateTexture("test.png")
addEventHandler("onClientRender", root,
function() -- x,y,z, targetx,targety,targetz,texture,width,color
dxDrawMaterialLine3D (0,0,3,0,0,15,img, 7, tocolor(255,255,255,255))
end)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|n/a|1.3.0-9.03931|}}

==See Also==
{{Drawing_functions}}

DxDrawImageSection

2013-09-27T21:13:19Z

Skurken:

__NOTOC__
{{Client function}}
Differing from [[dxDrawImage]], this function only draws a part of an image on the screen for a single frame. In order for the image to stay visible continuously, you need to call this function with the same parameters on each frame update (see [[onClientRender]]).

==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawImageSection ( float posX, float posY, float width, float height, float u, float v, float usize, float vsize, mixed image,
[ float rotation = 0, float rotationCenterOffsetX = 0, float rotationCenterOffsetY = 0, int color = white, bool postGUI = false ] )
</syntaxhighlight>

===Required Arguments===
*'''posX:''' the absolute X coordinate of the top left corner of the image
*'''posY:''' the absolute Y coordinate of the top left corner of the image
*'''width:''' the absolute width of the image
*'''height:''' the absolute height of the image
*'''u:''' the absolute X coordinate of the top left corner of the section which should be drawn from image
*'''v:''' the absolute Y coordinate of the top left corner of the section which should be drawn from image
*'''usize:''' the absolute width of the image section
*'''vsize:''' the absolute height of the image section
*'''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.

===Optional Arguments===
*'''rotation:''' the rotation, in degrees for the image.
*'''rotationCenterOffsetX:''' the absolute X offset from the image center for which to rotate the image from.
*'''rotationCenterOffsetY:''' the absolute Y offset from the image center for which to rotate the image from.
*'''color:''' the color of the image, a value produced by [[tocolor]] or hexadecimal number in format: 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
*'''postgui :''' A bool representing whether the image should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

===Returns===
Returns ''true'' if successful, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
The example draws a section of an image. (You can use [http://i1325.photobucket.com/albums/u630/Tourmalinelisa2/128x128.jpg this] image to test.)
<syntaxhighlight lang="lua">
addEventHandler('onClientRender', root, function()
dxDrawImageSection(400, 200, 64, 64, 0, 0, 64, 64, 'img.jpg') -- Draw a certain section
dxDrawImage(400, 300, 128, 128, 'img.jpg') -- Draw the whole image to be able to identify the difference
end)
</syntaxhighlight>
</section>

==See Also==
{{Drawing_functions}}

DxDrawImageSection

2013-09-27T21:13:05Z

Skurken: Example

User:Skurken

2013-09-27T20:48:37Z

Skurken: Created page with "= Contributions to the Wiki = '''27 September 2013''' Wrote example for dxConvertPixels"

= Contributions to the Wiki =

'''27 September 2013''' Wrote example for [[dxConvertPixels]]

DxConvertPixels

2013-09-27T20:23:24Z

Skurken:

{{Client function}}
__NOTOC__
This function converts [[Texture_pixels|pixels]] from one format to another.

==Syntax==
<syntaxhighlight lang="lua">
string dxConvertPixels ( string pixels, string newFormat [, int quality = 80 ] )
</syntaxhighlight>

===Required Arguments===
*'''pixels :''' The pixels to convert the format of
*'''newFormat :''' The new format required (''''plain'''' or ''''png'''' or ''''jpeg'''')

===Optional Arguments===
*'''quality :''' The quality of the returned pixels if the new format is ''''jpeg''''

==Returns==
Returns a copy of the pixels in the new format, or ''false'' if invalid arguments were passed to the function.

==Example==
<section name="Client" class="client" show="true">
The code opens an image, read its pixels, convert the pixels to PNG, and then save it. (You can use [http://i1325.photobucket.com/albums/u630/Tourmalinelisa2/128x128.jpg this] image to test.)
<syntaxhighlight lang="lua">
addEventHandler('onClientResourceStart', resourceRoot, function()
local img = fileOpen('img.jpg')
local pixels = fileRead(img, fileGetSize(img))
local pngPixels = dxConvertPixels(pixels, 'png')
local newImg = fileCreate('img.png')
fileWrite(newImg, pngPixels)
fileClose(newImg)
fileClose(img)
end)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|n/a|1.3|}}

==See Also==
{{Drawing_functions}}