Multi Theft Auto: Wiki - User contributions [en]

OOP

2014-06-27T02:39:16Z

OpenIDUser58: /* Useful Links */

Object Orientated Programming is introduced in MTA:SA 1.4 and comes with special utility classes like [[Vector]] and [[Matrix]]. This page contains general information about the OOP functions and provides useful links.

== Turning it on ==
You must set the <oop> key in the server configuration file from false to true to enable OOP in your server. However, Vectors and Matrices will always work regardless of OOP being enabled.

== Vectors and Matrices ==
[[Vector|Vectors]] and [[Matrix|Matrices]] make it easier to drop the complex maths and go straight ahead with fun part of maths. As mentioned above, OOP does not have to be enabled in the server config for this to be enabled.

==OOP Metatable Structure==
You will undersand this if you're an advanced scripter with an understanding in metatables.
<syntaxhighlight lang="lua">
-- Exposed to global environment
Element = {
create = createElement,
setPosition = setElementPosition,
...
}

Vehicle = {
create = createVehicle,
setColor = setVehicleColor,
...
}

-- Hidden in lua registry, applied to userdata
ElementMT = {
__index = CLuaClassDefs::Index,
__newindex = CLuaClassDefs::NewIndex,
__class = Element,
__call = __class.create,
__set = {
type = CLuaClassDefs::ReadOnly,
health = setElementHealth,
...
},
__get = {
type = getElementType,
health = getElementHealth,
...
},
}

VehicleMT = {
__index = CLuaClassDefs::Index,
__newindex = CLuaClassDefs::NewIndex,
__class = Vehicle,
__parent = ElementMT,
__call = __class.create,
__set = {
damageProof = setVehicleDamageProof
...
},
__get = {
damageProof = isVehicleDamageProof
...
},
}
</syntaxhighlight>

== Things to do ==
* Document all the existing functions in OOP form on the documentation

== Useful Links ==
* '''[[OOP Introduction]]''' - teaches you about the basics of OOP
* '''[https://wiki.multitheftauto.com/wiki/OOP_server Function list (client)]''' - the most up to date list of functions, you should be able to infer from this.
* '''[https://wiki.multitheftauto.com/wiki/OOP_client Function list (server)]''' - the most up to date list of functions, you should be able to infer from this.

Template:Useful Functions

2013-10-15T02:25:57Z

OpenIDUser58:

*[[callClientFunction]] » This function allows you to call any clientside function from the server's side.
*[[callServerFunction]] » This function allows you to call any server-side function from the client's side.
*[[centerWindow]] » This function center the window in any resolution.
*[[Check]] » This function checks if it's arguments are of the right types and calls the error-function if one isn't.
*[[convertNumber]] » This function converts large numbers and adds commas to it. (Example: 100000 -> 100,000)
*[[coroutine.resume]] » Fix for hidden coroutine error messages
*[[dxDrawColorText]] » This function draws a dx text with #RRGGBB color codes support.
*[[dxDrawGifImage]] » This function simulates the effect of a GIF image by using image sprites.
*[[dxDrawImage3D]] » This function draws a 3D image.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle.
*[[dxGetFontSizeFromHeight]] » This function calculate a font size from given height for dxDraw.
*[[dxGetRealFontHeight]] » Accurately measures the pixel height of a font.
*[[findRotation]] » Takes two points and returns the direction from point A to point B.
*[[FormatDate]] » Formats a date on the basis of a format string and returns it.
*[[GenerateString]] » With this function you can generate a random string with any characters.
*[[getAge]] » This function calculates the age of a birthday.
*[[getAlivePlayers (Client)|getAlivePlayers]] » This function returns all the alive players by a client side, so you can store them into a Gridlist or something like that, faster.
*[[getAlivePlayersInTeam]] » This function returns a table of the alive players in a team.
*[[getBoundControls]] » This function returns a list of control names that are bound to the specified key.
*[[getCursorMoveOn]] » This function checks in which way the cursor is currently moving.
*[[getDistanceBetweenPointAndSegment2D]] » 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 allows you to get element speed in kph or mph units.
*[[getElementsWithinMarker]] » This function gets the elements that are in a markers colshape.
*[[getJetpackWeaponsEnabled]] » This function returns a table of enabled weapons usable on a jetpack.
*[[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 will give the online admins.
*[[getOnlineStaff]] » Returns all online staff, names separated by two spaces.
*[[getPlayersByData]] » This function gets players who have data name you passed to it.
*[[getPlayerFromNamePart]] » This function allows you to get player From his Name part.
*[[getPlayersInPhotograph]] » This function gets all the players in a photograph.
*[[getPlayerFromSerial]] » This function gets an online player from their serial.
*[[getPointFromDistanceRotation]] » Finds a point based on a starting point, direction and distance.
*[[getResourceSettings]] » This function returns a table of the resource settings.
*[[getTeamFromColor]] » This function gets a team from it's color. (Related to: [[getTeamFromName]])
*[[getTimestamp]] » With this function you can get the UNIX timestamp.
*[[getValidVehicleModels]] » This function returns a table containing valid MTA Vehicle models.
*[[getXMLNodes]] » Returns all children of a node
*[[getVehicleRespawnPosition]] » This function allows you to get the spawn position of a vehicle.
*[[guiComboBoxAdjustHeight]] » Adjusts the combobox to have a correct height.
*[[IfElse]] » Returns one of two values based on a boolean expression.
*[[isElementInPhotograph]] » This function checks if an element was in the player's camera picture.
*[[isElementInRange]] » This function allows you to check is the element's range to the main point is smaller than (or as big as) the maximum range.
*[[isElementMoving]]» This function checks if an element is moving.
*[[isElementWithinAColShape]]» This function checks if the [[element]] is in a [[colshape]].
*[[isPedAiming]]» This function checks if a ped is aiming.
*[[isPlayerInACL]] » This function will check to see if a player element is in an ACL group.
*[[isPlayerInTeam]] » This function check if the player in the team.
*[[isLeapYear]] » Checks if the given year is a leap year.
*[[isVehicleOnRoof]] » This function checks whether vehicle is on roof.
*[[isVehicleEmpty]] » This function checks whether a vehicle is empty.
*[[iterElements]] » Returns an iterator for your for loops saving time typing ipairs( getElementsByType( type ) ), instead you type: iterElements( type ).
*[[mathNumber]] » This function is a workaround for the clientside floating-point precision of 24-bits
*[[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 vehicles weapon.
*[[RGBToHex]] » This function returns a string representing the color in hexadecimal.
*[[setElementSpeed]] » This function allows you to set moving element speed in kph or mph units.
*[[setTableProtected]] » Protects a table and makes it read-only.
*[[setVehicleGravityPoint]] » This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.
*[[smoothMoveCamera]] » This clientside function allows you to create a cinematic camera flight.
*[[string.count]] » This function counts a text from a text.
*[[string.explode]] » This function splits a string at a given separator pattern and returns a table with the pieces.
*[[switch]] » This function allow 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 check if both tables is equal. 
*[[table.empty]] » This function check is empty table or not.
*[[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]] » Merges two or more tables in the first.
*[[table.random]] » This function retrieves a random variable from a table.
*[[table.size]] » Finds the absolute size of a table.
*[[toHex]] » This function converts a decimal number to a hexadecimal number, as a fix to be used clientside.
*[[var dump]] » This function outputs information about one or more variables using outputConsole()
*[[wavelengthToRGBA]] » This function converts a phisical wavelength of light to a RGBA color.
[[Category:Useful Functions]]

Template:Useful Functions

2013-10-15T02:25:47Z

OpenIDUser58:

GetValidVehicleModels

2013-10-15T02:07:02Z

OpenIDUser58: Created page with "{{Useful Function}} __NOTOC__ This function returns a table containing the valid (drivable) vehicles for GTA:SA ==Syntax== <syntaxhighlight lang="lua">table getValidVehicleModels ( )</co..."

{{Useful Function}}
__NOTOC__
This function returns a table containing the valid (drivable) vehicles for GTA:SA 

==Syntax==
<syntaxhighlight lang="lua">table getValidVehicleModels ( )</syntaxhighlight>

===Returns===
Returns a table with the MTA vehicle models.

==Code==
<syntaxhighlight lang="lua">
function getValidVehicleModels ( )
local validVehicles = { }
local invalidModels = {
['435']=true, ['449']=true, ['450']=true, ['537']=true,
['538']=true, ['569']=true, ['570']=true, ['584']=true,
['590']=true, ['591']=true, ['606']=true, ['607']=true,
['608']=true
}
for i=400, 609 do
if ( not invalidModels[tostring(i)] ) then
table.insert ( validVehicles, i )
end
end
return validVehicles
end
</syntaxhighlight>

==Example==
This is an example of the function.
<syntaxhighlight lang="lua">
for index, model in ipairs ( getValidVehicleModels ( ) ) do
outputChatBox ( tostring ( model ) )
end
</syntaxhighlight>
 
Author: xXMADEXx 

==See Also==
{{Useful_Functions}}

IsPlayerInACL

2013-10-15T01:53:56Z

OpenIDUser58: /* Code */

{{Useful Function}}
__NOTOC__
This function returns true if the player is in the ACL group, false if otherwise. 

==Syntax==
<syntaxhighlight lang="lua">bool isPlayerInACL ( player thePlayer, string ACLGroup )</syntaxhighlight>

===Required Arguments===
* '''thePlayer''': The player element that you want to check
* '''ACLGroup''': The name of the ACL group that you want to check

'''Important Note''': This function will only work on the server-side.

===Returns===
Returns true if the player's account is in the ACL, false if otherwise.

==Code==
<syntaxhighlight lang="lua">
function isPlayerInACL ( player, acl )
local account = getPlayerAccount ( player )
if ( isGuestAccount ( account ) ) then
return false
end
return isObjectInACLGroup ( "user."..getAccountName ( account ), aclGetGroup ( acl ) )
end
</syntaxhighlight>

==Example==
This is an example of the function.
<syntaxhighlight lang="lua">outputChatBox ( tostring ( isPlayerInACL ( getPlayerFromName ( "xXMADEXx" ), "Admin" ) ) )</syntaxhighlight>
 
xXMADEXx 

==See Also==
{{Useful_Functions}}

Template:Useful Functions

2013-09-23T01:36:54Z

OpenIDUser58:

*[[callClientFunction]] » This function allows you to call any clientside function from the server's side.
*[[callServerFunction]] » This function allows you to call any server-side function from the client's side.
*[[centerWindow]] » This function center the window in any resolution.
*[[Check]] » This function checks if it's arguments are of the right types and calls the error-function if one isn't.
*[[convertNumber]] » This function converts large numbers and adds commas to it. (Example: 100000 -> 100,000)
*[[coroutine.resume]] » Fix for hidden coroutine error messages
*[[dxDrawColorText]] » This function draws a dx text with #RRGGBB color codes support.
*[[dxDrawGifImage]] » This function simulates the effect of a GIF image by using image sprites.
*[[dxDrawImage3D]] » This function draws a 3D image.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle.
*[[dxGetFontSizeFromHeight]] » This function calculate a font size from given height for dxDraw.
*[[dxGetRealFontHeight]] » Accurately measures the pixel height of a font.
*[[findRotation]] » Takes two points and returns the direction from point A to point B.
*[[FormatDate]] » Formats a date on the basis of a format string and returns it.
*[[GenerateString]] » With this function you can generate a random string with any characters.
*[[getAge]] » This function calculates the age of a birthday.
*[[getAlivePlayers (Client)|getAlivePlayers]] » This function returns all the alive players by a client side, so you can store them into a Gridlist or something like that, faster.
*[[getAlivePlayersInTeam]] » This function returns a table of the alive players in a team.
*[[getBoundControls]] » This function returns a list of control names that are bound to the specified key.
*[[getCursorMoveOn]] » This function checks in which way the cursor is currently moving.
*[[getDistanceBetweenPointAndSegment2D]] » 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 allows you to get element speed in kph or mph units.
*[[getElementsWithinMarker]] » This function gets the elements that are in a markers colshape.
*[[getJetpackWeaponsEnabled]] » This function returns a table of enabled weapons usable on a jetpack.
*[[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 will give the online admins.
*[[getOnlineStaff]] » Returns all online staff, names separated by two spaces.
*[[getPlayersByData]] » This function gets players who have data name you passed to it.
*[[getPlayerFromNamePart]] » This function allows you to get player From his Name part.
*[[getPlayersInPhotograph]] » This function gets all the players in a photograph.
*[[getPlayerFromSerial]] » This function gets an online player from their serial.
*[[getPointFromDistanceRotation]] » Finds a point based on a starting point, direction and distance.
*[[getResourceSettings]] » This function returns a table of the resource settings.
*[[getTeamFromColor]] » This function gets a team from it's color. (Related to: [[getTeamFromName]])
*[[getTimestamp]] » With this function you can get the UNIX timestamp.
*[[getXMLNodes]] » Returns all children of a node
*[[getVehicleRespawnPosition]] » This function allows you to get the spawn position of a vehicle.
*[[guiComboBoxAdjustHeight]] » Adjusts the combobox to have a correct height.
*[[IfElse]] » Returns one of two values based on a boolean expression.
*[[isElementInPhotograph]] » This function checks if an element was in the player's camera picture.
*[[isElementInRange]] » This function allows you to check is the element's range to the main point is smaller than (or as big as) the maximum range.
*[[isElementMoving]]» This function checks if an element is moving.
*[[isElementWithinAColShape]]» This function checks if the [[element]] is in a [[colshape]].
*[[isPedAiming]]» This function checks if a ped is aiming.
*[[isPlayerInACL]] » This function will check to see if a player element is in an ACL group.
*[[isPlayerInTeam]] » This function check if the player in the team.
*[[isLeapYear]] » Checks if the given year is a leap year.
*[[isVehicleOnRoof]] » This function checks whether vehicle is on roof.
*[[isVehicleEmpty]] » This function checks whether a vehicle is empty.
*[[iterElements]] » Returns an iterator for your for loops saving time typing ipairs( getElementsByType( type ) ), instead you type: iterElements( type ).
*[[mathNumber]] » This function is a workaround for the clientside floating-point precision of 24-bits
*[[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 vehicles weapon.
*[[RGBToHex]] » This function returns a string representing the color in hexadecimal.
*[[setElementSpeed]] » This function allows you to set moving element speed in kph or mph units.
*[[setTableProtected]] » Protects a table and makes it read-only.
*[[setVehicleGravityPoint]] » This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.
*[[smoothMoveCamera]] » This clientside function allows you to create a cinematic camera flight.
*[[string.count]] » This function counts a text from a text.
*[[string.explode]] » This function splits a string at a given separator pattern and returns a table with the pieces.
*[[switch]] » This function allow 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 check if both tables is equal. 
*[[table.empty]] » This function check is empty table or not.
*[[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]] » Merges two or more tables in the first.
*[[table.random]] » This function retrieves a random variable from a table.
*[[table.size]] » Finds the absolute size of a table.
*[[toHex]] » This function converts a decimal number to a hexadecimal number, as a fix to be used clientside.
*[[var dump]] » This function outputs information about one or more variables using outputConsole()
*[[wavelengthToRGBA]] » This function converts a phisical wavelength of light to a RGBA color.
[[Category:Useful Functions]]

IsPlayerInACL

2013-09-23T01:35:56Z

OpenIDUser58:

{{Useful Function}}
__NOTOC__
This function returns true if the player is in the ACL group, false if otherwise. 

==Syntax==
<syntaxhighlight lang="lua">bool isPlayerInACL ( player thePlayer, string ACLGroup )</syntaxhighlight>

===Required Arguments===
* '''thePlayer''': The player element that you want to check
* '''ACLGroup''': The name of the ACL group that you want to check

'''Important Note''': This function will only work on the server-side.

===Returns===
Returns true if the player's account is in the ACL, false if otherwise.

==Code==
<syntaxhighlight lang="lua">
function isPlayerInACL ( player, acl )
local account = getPlayerAccount ( player )
if ( isGuestAccount ( account ) ) then
return false
end if ( isObjectInACLGroup ( "user."..getAccountName ( account ), aclGetGroup ( acl ) ) ) then
return true
else
return false
end
end
</syntaxhighlight>

==Example==
This is an example of the function.
<syntaxhighlight lang="lua">outputChatBox ( tostring ( isPlayerInACL ( getPlayerFromName ( "xXMADEXx" ), "Admin" ) ) )</syntaxhighlight>
 
xXMADEXx 

==See Also==
{{Useful_Functions}}