Multi Theft Auto: Wiki - User contributions [en]

Template:Client utility functions

2015-02-17T19:17:18Z

NukeMTA:

* [[base64Encode]]
* [[base64Decode]]
{{Bit_functions}}
{{New items|3.0140|1.4|
* [[downloadFile]]
}}
* [[fromJSON]]
* [[getDistanceBetweenPoints2D]]
* [[getDistanceBetweenPoints3D]]
* [[getEasingValue]]
* [[getColorFromString]]
* [[getDevelopmentMode]]
* [[getFPSLimit]]
{{New items|3.0140|1.4|
* [[getLocalization]]
}}
* [[getNetworkStats]]
* [[getNetworkUsageData]]
* [[getPerformanceStats]]
* [[getRealTime]]
* [[getTickCount]]
* [[getTimers]]
* [[getTimerDetails]]
* [[gettok]]
* [[getVersion]]
{{New feature/item|3.0141|1.4.1|6791|
* [[hash]]
}}
* [[interpolateBetween]]
* [[isTimer]]
* [[killTimer]]
* [[md5]]
{{New feature/item|3.0135|1.3.5|6056|
* [[pregFind]]
* [[pregReplace]]
* [[pregMatch]]
}}
* [[resetTimer]]
* [[setClipboard]]
* [[setDevelopmentMode]]
* [[setFPSLimit]]
* [[setTimer]]
* [[sha256]]
* [[split]]
* [[teaEncode]]
* [[teaDecode]]
* [[tocolor]]
* [[toJSON]]
* [[utfChar]]
* [[utfCode]]
* [[utfLen]]
* [[utfSeek]]
* [[utfSub]]
<noinclude>[[Category:Functions templates]]</noinclude>

IsPedAimingNearPed

2015-02-17T19:14:25Z

NukeMTA:

{{Useful Function}}
__NOTOC__
This function checks if a ped is aiming and if it is at an certain distance from the object you specified. Returns true if yes and false if not.
 
'''Important : ONLY WORKS CLIENT SIDE.'''
 

==Syntax==
<syntaxhighlight lang="lua">bool isPedAimingNearPed ( ped thePed , element theElement, int range )</syntaxhighlight>

===Required Arguments===
* '''thePed''': The ped element.
* '''theElement''': The element you want to see if thePed is aiming to.
* '''range''': Range of the colshape.

===Returns===
Returns true if ped is aiming a weapon to the element and within the range, false if not.

==Code==
<section name="Clientside script" class="client" show="true">
<syntaxhighlight lang="lua">
function isPedAimingNearPed ( thePed, theElement, range )
if isElement(thePed) and isElement(theElement) and type(range) == "number" then
if (getElementType(thePed) == "player" or getElementType(thePed) == "ped") then
local x, y, z = getElementPosition(theElement)
local col = createColTube(x, y, z-1, range, 2)
attachElements(col, theElement)
if getPedTask(thePed, "secondary", 0) == "TASK_SIMPLE_USE_GUN" and getPedTarget(thePed) == theElement and isElementWithinColShape(thePed, col) then
return true
end
end
end
return false
end
</syntaxhighlight>
</section>

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

==See Also==
{{Useful_Functions}}

IsPedAimingNearPed

2015-02-17T19:12:55Z

NukeMTA: Created page with "{{Useful Function}} __NOTOC__ This function checks if a ped is aiming and if it is at an certain distance from the object you specified. Returns true if yes and false if not. ..."

{{Useful Function}}
__NOTOC__
This function checks if a ped is aiming and if it is at an certain distance from the object you specified. Returns true if yes and false if not.
 
'''Important : ONLY WORKS CLIENT SIDE.'''
 

==Syntax==
<syntaxhighlight lang="lua">bool isPedAimingNearPed ( ped thePed , element theElement, int range)</syntaxhighlight>

===Required Arguments===
* '''thePed''': The ped element.
* '''theElement''': The element you want to see if thePed is aiming to.
* '''range''': Range of the colshape.

===Returns===
Returns true if ped is aiming a weapon to the element, false if not.

==Code==
<section name="Clientside script" class="client" show="true">
<syntaxhighlight lang="lua">
function isPedAimingNearPed ( thePed, theElement, range )
if isElement(thePed) and isElement(theElement) and type(range) == "number" then
if (getElementType(thePed) == "player" or getElementType(thePed) == "ped") then
local x, y, z = getElementPosition(theElement)
local col = createColTube(x, y, z-1, range, 2)
attachElements(col, theElement)
if getPedTask(thePed, "secondary", 0) == "TASK_SIMPLE_USE_GUN" and getPedTarget(thePed) == theElement and isElementWithinColShape(thePed, col) then
return true
end
end
end
return false
end
</syntaxhighlight>
</section>

==Example==
The example outputs if the player is aiming a gun when the player presses b.
<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>

==See Also==
{{Useful_Functions}}

Template:Useful Functions

2015-02-17T19:04:35Z

NukeMTA:

*[[attachEffect]] » This function allows you attach an effect to an element.
*[[bindControlKeys]] » This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.
*[[callClientFunction]] » This function allows you to call any client-side function from the server's side.
*[[callServerFunction]] » This function allows you to call any server-side function from the client's side.
*[[capitalize]] » This function capitalizes a given string.
*[[centerWindow]] » This function centers a CEGUI window element responsively in any resolution.
*[[Check]] » This function checks if its arguments are of the right type and calls the error-function if one is not.
*[[convertNumber]] » This function converts and formats large numbers.
*[[convertServerTickToTimeStamp]] » This function converts server ticks to a unix timestamp.
*[[convertTextToSpeech]] » This function converts the provided text to a speech in the provided language which players can hear.
*[[coroutine.resume]] » This function applies a fix for hidden coroutine error messages.
*[[dxDrawAnimWindow]] » This function draws an animated 2D window on the screen.
*[[dxDrawCircle]] » This function draws a number of 2D lines in order to achieve a circle shape on the screen.
*[[dxDrawEmptyRec]] » This function draws an empty 2D rectangle on the screen.
*[[dxDrawGifImage]] » This function simulates the effect of a GIF image by using image sprites in 2D.
*[[dxDrawImage3D]] » This function draws a 3D image in GTA world.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle in GTA world.
*[[dxGetFontSizeFromHeight]] » This function calculates the font size from given height.
*[[dxGetRealFontHeight]] » This function calculates the height of a font.
*[[findRotation]] » This function takes two points and returns the direction from point A to point B.
*[[FormatDate]] » This function formats a date on the basis of a format string and returns it.
*[[GenerateString]] » This function generates a random string with any characters.
*[[generateRandomASCIIString]] » This function returns a random string which uses ASCII characters. 
*[[getAge]] » This function calculates the age of a given birthday.
*[[getAlivePlayers (Client)|getAlivePlayers]] » This function returns a table of the alive players client-side.
*[[getAlivePlayersInTeam]] » This function returns a table of the alive players in a team.
*[[getBanFromName]] » This functions returns the ban of the given playername.
*[[getBoundControls]] » This function returns a table of control names that are bound to the specified key.
*[[getCurrentFPS]] » This function returns the frames per second at which GTA: SA is running.
*[[getCursorMoveOn]] » This function checks in which way the cursor is currently moving.
*[[getDistanceBetweenPointAndSegment2D]] » This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.
*[[getElementSpeed]] » This function returns the specified element's speed in m/s, km/h or mph.
*[[getElementsInDimension]] » This function returns a table of elements that are in the specified dimension.
*[[getElementsWithinMarker]] » This function returns a table of elements that are within a marker's collision shape.
*[[getJetpackWeaponsEnabled]] » This function returns a table of enabled weapons usable on a jetpack.
*[[getKeyFromValueInTable]] » This function returns the key of the specified value in a table.
*[[getOffsetFromXYZ]] » This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.
*[[getOnlineAdmins]] » This function returns a table of all logged-in administrators.
*[[getOnlineStaff]] » This function returns a string of all logged-in administrators separated by two whitespace characters.
*[[getPedMaxHealth]] » This function returns a pedestrians's maximum health by converting it from their maximum health stat.
*[[getPedMaxOxygenLevel]] » This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.
*[[getPlayerFromNamePart]] » This function returns a player from partial name.
*[[getPlayerFromSerial]] » This function returns a player from their serial.
*[[getPlayerAcls]] » This function returns a table of all ACL groups on a player.
*[[getPlayersByData]] » This function returns a table of players that have the specified data name.
*[[getPlayersInPhotograph]] » This function returns a table of all players in photograph.
*[[getPlayerCity]] » This functions returns a string containing the player's city name
*[[getPointFromDistanceRotation]] » This function finds a point based on a starting point, direction and distance.
*[[getResourceSettings]] » This function returns a table of the resource settings.
*[[getResourceScripts]] » This function returns a table of the resource scripts.
*[[getRGColorFromPercentage]] »This function returns two integers representing red and green colors according to the specified percentage.
*[[getScreenRotationFromWorldPosition]] » This function returns a screen relative rotation to a world position.
*[[getTeamFromColor]] » This function returns a team element by the specified color.
*[[getTeamWithFewestPlayers]] » This function returns a team element with least players of all the specified teams.
*[[getTimestamp]] » This function returns the UNIX timestamp of a specified date and time.
*[[getValidVehicleModels]] » This function returns a table of all valid vehicle models.
*[[getVehicleRespawnPosition]] » This function allows you to get the respawn position of a vehicle.
*[[getXMLNodes]] » This function returns all children of a XML node.
*[[guiComboBoxAdjustHeight]] » This function adjusts a CEGUI combobox element to have the correct height.
*[[guiGridListGetSelectedText]] » This function returns a string containing the inner text of a selected gridlist item.
*[[IfElse]] » This function returns one of two values based on a boolean expression.
*[[isElementInPhotograph]] » This function checks if an element is in the player's camera picture area.
*[[isElementInRange]] » This function allows you to check if an element's range to a main point is within the maximum range.
*[[isElementMoving]]» This function checks if an element is moving.
*[[isElementWithinAColShape]]» This function checks if an element is within a collision shape element.
*[[isLeapYear]] » This function returns a boolean representing if a given year is a leap year.
*[[isMouseInPosition]] » This function allows you to check whether the mouse cursor/pointer is within a rectangular position.
*[[isPedAiming]]» This function checks if a pedestrian is aiming their weapon.
*[[isPedDrivingVehicle]] » This function checks if a specified pedestrian is driving a vehicle.
*[[isPlayerInACL]] » This function checks if a player element is in an ACL group.
*[[isPlayerInTeam]] » This function checks if a player is in a specified team.
*[[isSoundFinished]] » This function checks if a sound element has finished.
*[[isVehicleEmpty]] » This function checks whether a vehicle is empty.
*[[isVehicleOccupied]] » This function checks if a specified vehicle is occupied.
*[[isVehicleOnRoof]] » This function checks whether vehicle is on roof.
*[[iterElements]] » This function returns ''a time-saving'' iterator for your for-loops.
*[[mathNumber]] » This function is a workaround for the client-side floating-point precision of 24-bits.
*[[math.percent]] » This function returns a percentage from two number values.
*[[math.round]] » Rounds a number whereas the number of decimals to keep and the method may be set.
*[[multi_check]] » This function checks one element to many, handy and clean.
*[[onVehicleWeaponFire]] » This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.
*[[renameAclGroup]] » This function gives an existing ACL group a new name.
*[[RGBToHex]] » This function returns a string representing the color in hexadecimal.
*[[secondsToTimeDesc]] » This function converts a plain seconds-integer into a user-friendly time description.
*[[setAccountName]] » This function is used to change an existing account's name.
*[[setElementSpeed]] » This function allows you to set the speed of an element in kph or mph units.
*[[setTableProtected]] » This function protects a table and makes it read-only.
*[[setVehicleGravityPoint]] » This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.
*[[smoothMoveCamera]] » This function allows you to create a cinematic camera flight.
*[[string.count]] » This function counts the amount of occurences of a string in a string.
*[[string.explode]] » This function splits a string at a given separator pattern and returns a table with the pieces.
*[[switch]] » This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.
*[[table.copy]] » This function copies a whole table and all the tables in that table.
*[[table.compare]] » This function checks whether two given tables are equal.
*[[table.empty]] » This function checks whether a table is empty.
*[[table.map]] » This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.
*[[table.merge]] » This function merges two or more tables together.
*[[table.random]] » This function retrieves a random value from a table.
*[[table.size]] » This function returns the absolute size of a table.
*[[toHex]] » This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.
*[[unbindControlKeys]] » This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].
*[[var dump]] » This function outputs information about one or more variables using outputConsole.
*[[wavelengthToRGBA]] » This function converts a physical wavelength of light to a RGBA color.
*[[isPedAimingNearPed]] » This is similar to isPedAiming but uses a colshape to be more precise.
[[Category:Useful Functions]]

Template:Client utility functions

2015-02-17T18:59:23Z

NukeMTA:

* [[base64Encode]]
* [[base64Decode]]
{{Bit_functions}}
{{New items|3.0140|1.4|
* [[downloadFile]]
}}
* [[fromJSON]]
* [[getDistanceBetweenPoints2D]]
* [[getDistanceBetweenPoints3D]]
* [[getEasingValue]]
* [[getColorFromString]]
* [[getDevelopmentMode]]
* [[getFPSLimit]]
{{New items|3.0140|1.4|
* [[getLocalization]]
}}
* [[getNetworkStats]]
* [[getNetworkUsageData]]
* [[getPerformanceStats]]
* [[getRealTime]]
* [[getTickCount]]
* [[getTimers]]
* [[getTimerDetails]]
* [[gettok]]
* [[getVersion]]
{{New feature/item|3.0141|1.4.1|6791|
* [[hash]]
}}
* [[interpolateBetween]]
* [[isTimer]]
* [[killTimer]]
* [[md5]]
{{New feature/item|3.0135|1.3.5|6056|
* [[pregFind]]
* [[pregReplace]]
* [[pregMatch]]
}}
* [[resetTimer]]
* [[setClipboard]]
* [[setDevelopmentMode]]
* [[setFPSLimit]]
* [[setTimer]]
* [[sha256]]
* [[split]]
* [[teaEncode]]
* [[teaDecode]]
* [[tocolor]]
* [[toJSON]]
* [[utfChar]]
* [[utfCode]]
* [[utfLen]]
* [[utfSeek]]
* [[utfSub]]
* [[createFunction]]
<noinclude>[[Category:Functions templates]]</noinclude>

OnClientGUIClick

2015-01-17T14:44:14Z

NukeMTA: /* Source */

{{Client event}}
__NOTOC__
This event happens when any gui-element clicked
{{Note|The '''player''' who clicked the gui-element is always the [[localPlayer]].}}

==Parameters==
<syntaxhighlight lang="lua">
string button, string state, int absoluteX, int absoluteY
</syntaxhighlight>
*'''button:''' the name of the button which will be clicked , it can be ''left'', ''right'', ''middle''
*'''state:''' the state of the mouse button, will be ''down'' if the mouse button was pushed, or ''up'' if it was released. '''Please note currently only the ''up'' state is supported.'''
*'''absoluteX:''' the X position of the mouse cursor, in pixels, measured from the left side of the screen.
*'''absoluteY:''' the Y position of the mouse cursor, in pixels, measured from the top of the screen.

==Source==
The [[event system#Event source|source]] of this event is the GUI element that was clicked.

'''Note:'''If you attach a GUI element to this event, when you click it's parent it will trigger too!

==Example==
This example creates an edit box alongside an "Output!" button. When the button is clicked with the left mouse button, it will output the message in the edit box into the chat box.
<syntaxhighlight lang="lua">
-- When client's resource starts, create the GUI
function initGUI( )
-- Create our button
btnOutput = guiCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )

-- And attach our button to the outputEditBox function
addEventHandler ( "onClientGUIClick", btnOutput, outputEditBox, false )

-- Create an edit box and define it as "editBox".
editBox = guiCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
guiEditSetMaxLength ( editBox, 128 ) -- The max chatbox text length is 128, so force this
end
addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource( ) ), initGUI )

-- Setup our function to output the message to the chatbox
function outputEditBox ( button )
if button == "left" then
local text = guiGetText ( editBox )-- Get the text from the edit box
outputChatBox ( text ) -- Output that text
end
end
</syntaxhighlight>

==See Also==
===GUI events===
{{GUI_events}}
===Client event functions===
{{Client_event_functions}}

OnElementModelChange

2014-12-18T08:46:34Z

NukeMTA: /* Cancel Effect */

__NOTOC__
{{Server event}}
{{New feature|3.0120|1.2|
'''Available only in MTA SA 1.2 and onwards'''
}}
This event is triggered when the model of an [[element]] is changed using [[setElementModel]].

==Parameters==
<syntaxhighlight lang="lua">
int oldModel, int newModel
</syntaxhighlight>

* '''oldModel:''' The model of the element beforehand.
* '''newModel:''' The new model of the element.

==Source==
The source of this event is the element that changed its model

==Cancel Effect==
This event doesn't support [[Event system#Canceling|cancellation]]. Use setElementModel with the old value to reverse.

==Example==
This example sends a message to players when their model changes telling them what the model ID is and was.
<syntaxhighlight lang="lua">
function informPlayerOnModelChange(oldModel, newModel)
if ( getElementType(source) == "player" ) then -- Make sure the element is a player
outputChatBox("Model ID changing from: "..oldModel.." to: "..newModel, source, 0, 255, 0) -- Message for player
end
end
addEventHandler("onElementModelChange", root, informPlayerOnModelChange) -- Bind the event to every element
</syntaxhighlight>

==See Also==
===Element events===
{{Element_events}}
===Event functions===
{{Event_functions}}

DownloadFile

2014-12-17T16:53:12Z

NukeMTA: /* Example */

{{Client function}}
__NOTOC__
{{New items|3.0140|1.4|
This function downloads a file from the HTTP server. This can only be used on files on the HTTP server associated with the MTA server and will only download files from within the folder of the resource that is calling it. The '''file''' should also be included in meta.xml with the '''download''' attribute set to "false", see [[meta.xml]] for more details. If the file has been previously downloaded and the CRC matches, the file will not be downloaded again but [[onClientFileDownloadComplete]] will still run.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool downloadFile ( string fileName )
</syntaxhighlight>

===Required Arguments===
* '''fileName''': A string referencing the name of the file to download

===Returns===
Returns ''true'' if file download has been queued, ''false'' otherwise.

==Example==
'''Example 1:''' This client side event downloads a file when the current resource has started.
<syntaxhighlight lang="lua">
-- the function is called on resource start
function onThisResourceStart ( )
downloadFile ( "test.xml" )
end
addEventHandler ( "onClientResourceStart", resourceRoot, onThisResourceStart )
</syntaxhighlight>

==See Also==
{{Client_utility_functions}}