Server Scripting Functions: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Changed translations hierarchy)
 
(405 intermediate revisions by 63 users not shown)
Line 1: Line 1:
This page lists all the scripting functions that exist already. To request a function or event, use [[Requested Functions and Events]].
<pageclass class="server"></pageclass>
 
{{Adding_Pages_to_Categories_and_Templates}}
==Player functions==
This page lists all the '''server-side''' scripting functions that have been implemented and are available as native functions. To request a function, create an issue in [https://github.com/multitheftauto/mtasa-blue/issues our GitHub repository.]
int [[getPlayerAdminLevel]] ( player )
 
int [[getPlayerCount]] ()
 
int [[getPlayerCurrentWeaponAmmoInClip]] ( player )
 
int [[getPlayerCurrentWeaponID]] ( player )
 
player [[getPlayerFromID]] ( id )
 
player [[getPlayerFromNick]] ( nick )
 
float [[getPlayerHealth]] ( player )
 
float [[getPlayerArmor]] ( player )
 
int [[getPlayerID]] ( player )
 
float float float [[getPlayerMoveSpeed]] ( player )
 
float [[getPlayerMoveSpeed|getPlayerMoveSpeedX]] ( player )
 
float [[getPlayerMoveSpeed|getPlayerMoveSpeedY]] ( player )
 
float [[getPlayerMoveSpeed|getPlayerMoveSpeedZ]] ( player )
 
string [[getPlayerName]] ( player )
 
vehicle [[getPlayerOccupiedVehicle]] ( player )
 
int [[getPlayerOccupiedVehicleSeat]] ( player )
 
int [[getPlayerPing]] ( player )
 
float float float [[getPlayerPosition]] ( player )
 
float [[getPlayerPosition|getPlayerPositionX]] ( player )
 
float [[getPlayerPosition|getPlayerPositionY]] ( player )
 
float [[getPlayerPosition|getPlayerPositionZ]] ( player )
 
float [[getPlayerRotation]] ( player )
 
string [[getPlayerSourceIP]] ( player )
 
player [[getRandomPlayer]] ()
 
bool [[isPlayerDead]] ( player )
 
bool [[isPlayerDucked]] ( player )
 
bool [[isPlayerMuted]] ( player )
 
bool [[setPlayerHealth]] ( player, health )
 
bool [[setPlayerArmor]] ( player, armor )
 
bool [[killPlayer]] ( player )
 
==Weapon functions==
{{Needs_Checking|giveWeapon and giveWeaponToAll should use ammo as an optional argument. if not specified, default to 0. (give the player the weapon, but no ammo)|[[User:Vandalite|Vandalite]] }}
bool [[giveWeapon]] ( player, weaponid, ammo )
 
bool [[giveWeaponToAll]] ( weaponid, ammo )
 
bool [[takeWeapon]] ( player, weaponid )
 
{{Needs_Checking|the following function appears to require a useless argument. A dev should check the codebase and see if '''player''' really is a required argument for '''takeWeaponFromAll'''.|[[User:Vandalite|Vandalite]]}}
bool [[takeWeaponFromAll]] ( player, weaponid )
 
bool [[takeAllWeapons]] ( player )
 
bool [[takeAllWeaponsFromAll]] ()
 
==Vehicle functions==
vehicle [[createVehicle]] ( id, x, y, z, [rx, ry, rz] )
 
bool [[destroyVehicle]] ( vehicle )
 
float [[getVehicleHealth]] ( vehicle )
 
int [[getVehicleID]] ( vehicle )
 
int [[getVehicleIndex]] ( vehicle )
 
float float float [[getVehicleMoveSpeed]] ( vehicle )
 
float [[getVehicleMoveSpeed|getVehicleMoveSpeedX]] ( vehicle )
 
float [[getVehicleMoveSpeed|getVehicleMoveSpeedY]] ( vehicle )
 
float [[getVehicleMoveSpeed|getVehicleMoveSpeedZ]] ( vehicle )
{{Needs_Checking|getVehicleOccupant is missing an optional [seat] argument|[[User:Vandalite|Vandalite]]}}
player [[getVehicleOccupant]] ( vehicle )
 
float float float [[getVehiclePosition]] ( vehicle )
 
float [[getVehiclePosition|getVehiclePositionX]] ( vehicle )
 
float [[getVehiclePosition|getVehiclePositionY]] ( vehicle )
 
float [[getVehiclePosition|getVehiclePositionZ]] ( vehicle )
 
float float float [[getVehicleRotation]] ( vehicle )
 
float [[getVehicleRotation|getVehicleRotationX]] ( vehicle )
 
float [[getVehicleRotation|getVehicleRotationY]] ( vehicle )
 
float [[getVehicleRotation|getVehicleRotationZ]] ( vehicle )
 
float float float [[getVehicleTurnSpeed]] ( vehicle )
 
float [[getVehicleTurnSpeedX]] ( vehicle )
 
float [[getVehicleTurnSpeedY]] ( vehicle )
 
float [[getVehicleTurnSpeedZ]] ( vehicle )
 
float float [[getVehicleTurretPosition]] ( vehicle )
 
float [[GetVehicleTurretPosition|getVehicleTurretPositionX]] ( vehicle )
 
float [[GetVehicleTurretPosition|getVehicleTurretPositionY]] ( vehicle )
 
bool [[setVehiclePosition]] ( vehicle, x, y, z )
 
bool [[setVehicleRotation]] ( vehicle, rx, ry, rz )
 
bool [[setVehicleMoveSpeed]] ( vehicle, x, y, z )
 
bool [[setVehicleTurnSpeed]] ( vehicle, rx, ry, rz )
 
bool [[setVehicleHealth]] ( vehicle, health )
 
bool [[setVehicleColor]] ( vehicle, color1, color2, color3, color4 )


Please note that the scripting functions can also be extended by loading in dynamic modules that provide new functionality, such as utility functions. These scripting functions are non-native and require the module to be loaded in order to work.
Head over to [[Modules]] for a list of non-native serverside functions and modules that are available.
For more functions, check the [[Useful_Functions|useful functions page]].
'''Client-side scripting functions can be found here: [[Client Scripting Functions]].'''
__TOC__
==Account functions==
{{Account_functions}}
==ACL functions==
{{ACL_functions}}
==Admin functions==
{{Admin_functions}}
==Audio functions==
{{Audio_functions}}
==Announcement functions==
{{Announce_functions}}
==Blip functions==
{{Blip_functions}}
==Camera functions==
{{Camera_functions}}
==Clothes and body functions==
{{Clothes_and_body_functions}}
==Collision shape functions==
{{Collision_shape_functions}}
==Cursor functions==
{{Cursor_functions}}
==Element functions==
{{Element_functions}}
==Event functions==
{{Event_functions}}
==Explosion functions==
{{Explosion_functions}}
==File functions==
{{File_functions}}
==HTTP functions==
{{HTTP_functions}}
==Input functions==
{{Server_input_functions}}
==Map functions==
{{Map_functions}}
==Marker functions==
==Marker functions==
{{Needs Checking|There are a significant number of functions and arguments that are needed, and do not exist. I reccomend the documentation for this section not be written until the final form of these functions is confirmed.|[[User:Vandalite|Vandalite]]}}
{{Marker_functions}}
marker [[createMarker]] ( id, x, y, z, r, g, b )
 
==Matrix functions==
bool [[destroyMarker]] ( marker )
{{Shared_matrix_functions}}
 
   
marker [[getMarkerFromID]] ( id )
==Module functions==
 
{{Module_functions}}
==Blip functions==
{{Needs_Checking|CreateBlip has the wrong arguments set to optional. the color/transparencies can be defaulted, the location cannot. Also, there is no option for creating blips larger than others. perhaps an additional scale option? That would make the final markup for the function "blip createBlip ( x, y, z, [r, g, b, a, scale} )|[[User:Vandalite|Vandalite]]}}
blip [[createBlip]] ( r, g, b, a, [x, y, z] )
{{Needs_Checking|CreateBlipAttachedTo should have the r,g,b,a arguments optional. also required is a scale argument. EG: blip createBlipAttachedTo ( entity, [r, g, b, a, scale] )|[[User:Vandalite|Vandalite]]}}
blip [[createBlipAttachedTo]] ( entity, r, g, b, a )
 
bool [[destroyBlip]] ( blip )
 
bool [[destroyBlipAttachedTo]] ( entity )
 
float, float, float [[getBlipPosition]] ( blip )
 
float [[getBlipPositionX]] ( blip )
 
float [[getBlipPositionY]] ( blip )
 
float [[getBlipPositionZ]] ( blip )
{{Needs_Checking|Does setBlipPosition automatically detach a blip that has been attached to something?|[[User:Vandalite|Vandalite]]}}
bool [[setBlipPosition]] ( blip, x, y, z )
 
bool [[attachBlipToEntity]] ( blip, entity )
 
==Object functions==
==Object functions==
object [[createObject]] ( model, x, y, z, [rx, ry, rz] )
{{Object_functions}}
 
bool [[destroyObject]] ( object )
==Output functions==
 
{{Output_functions}}
bool [[destroyAllObjects]] ()
 
==Ped functions==
string [[getObjectName]] ( object )
{{Ped_functions}}
 
int [[getObjectModel]] ( object )
==Pickup functions==
 
{{Pickup_functions}}
float float float [[getObjectPosition]] ( object )
 
==Player functions==
float [[getObjectPositionX]] ( object )
{{Player_functions}}
 
float [[getObjectPositionY]] ( object )
==Projectile functions==
 
{{Projectile_functions}}
float [[getObjectPositionZ]] ( object )
 
float float float [[getObjectRotation]] ( object )
 
float [[getObjectRotationX]] ( object )
 
float [[getObjectRotationY]] ( object )
 
float [[getObjectRotationZ]] ( object )
 
bool [[setObjectName]] ( object, name )
 
bool [[setObjectModel]] ( object, model )
 
bool [[setObjectPosition]] ( object, x, y, z )
 
bool [[setObjectRotation]] ( object, x, y, z )
 
bool [[moveObject]] ( object, time, x, y, z, rx, ry, rz )
 
==Radar area functions==
==Radar area functions==
radararea [[createRadarArea]] ( x, y, sizex, sizey, r, g, b, a )
{{Radar_area_functions}}
 
bool [[destroyRadarArea]] ( radararea )
==Resource functions==
 
{{Resource_functions}}
bool [[destroyAllRadarAreas]] ()
 
float float [[getRadarAreaPosition]] ( radararea )
 
float [[getRadarAreaPositionX]] ( radararea )
 
float [[getRadarAreaPositionY]] ( radararea )
 
float float [[getRadarAreaSize]] ( radararea )
 
float [[getRadarAreaSizeX]] ( radararea )
 
float [[getRadarAreaSizeY]] ( radararea )
 
int int int int [[getRadarAreaColor]] ( radararea )
 
int [[getRadarAreaColorRed]] ( radararea )
 
int [[getRadarAreaColorGreen]] ( radararea )
 
int [[getRadarAreaColorBlue]] ( radararea )
 
int [[getRadarAreaColorAlpha]] ( radararea )
 
bool [[isRadarAreaFlashing]] ( radararea )
 
bool [[setRadarAreaPosition]] ( radararea, x, y )
 
bool [[setRadarAreaSize]] ( radararea, x, y )
 
bool [[setRadarAreaColor]] ( radararea, r, g, b, a )
 
bool [[setRadarAreaFlashing]]( radararea, bool )
 
==Server functions==
==Server functions==
int [[getMaxPlayers]] ()
{{Server_functions}}
 
bool [[serverLoggerPrint]] ( string, [...] )
==Settings registry functions==
 
{{Settings_registry_functions}}
bool [[serverChat]] ( string, [...] )
 
==SQL functions==
bool [[playerPM]] ( player, string, [...] )
{{SQL_functions}}
 
bool [[showTextForAll]] ( duration, r, g, b, size, string, [...] )
==Team functions==
 
{{Team_functions}}
bool [[showTextForPlayer]] ( player, duration, r, g, b, size, string, [...] )
 
==Text functions==
{{Text_functions}}
==Utility functions==
==Utility functions==
float [[getDistanceBetweenPoints2D]] ( x1, y1, x2, y2 )
{{Utility_functions}}
 
float [[getDistanceBetweenPoints3D]] ( x1, y1, z1, x2, y2, z2 )
==UTF8 Library==
 
{{UTF8_functions}}
int [[randInt]] ( lowerbound, upperbound )
 
==Vehicle functions==
float [[randFloat]] ()
{{Vehicle_functions}}
 
int [[getTickCount]] ()
==Water functions==
 
{{Water_functions}}
string [[gettok]] ( string, index, seperatingchar )
 
==Weapon functions==
bool [[setTimer]] ( function, time, [arg1, arg2, ...] )
{{Weapon_functions}}
 
==Map functions==
==World functions==
string [[getLoadedMapName]] ()
{{World_functions}}
 
xmlnode [[getLoadedMapXMLRoot]] ()
 
==XML functions==
==XML functions==
xmlnode [[xmlFindSubNode]] ( parent, subnode, index )
{{XML_functions}}
 
string [[xmlNodeGetValue]] ( xmlNode )
 
bool [[xmlNodeSetValue]] ( xmlNode, value )
 
string [[xmlNodeGetAttribute]] ( xmlNode, attribute name )
 
bool [[xmlNodeSetAttribute]] ( xmlNode, attribute name, value )
 
xmlnode [[xmlLoadFile]] ( filename )
 
bool [[xmlUnloadFile]] ( xmlnode )
 
==Text Functions==
textdisplay [[textCreateDisplay]] ()
 
void [[textDestroyDisplay]] ( textdisplay )
 
textitem [[textCreateTextItem]] ( [text, x, y, priority, red, green, blue, alpha, scale] )
 
void [[textDestroyTextItem]] ( textitem )
 
void [[textDisplayAddText]] ( textdisplay, textitem )
 
void [[textDisplayAddObserver]] ( textdisplay, player )
 
void [[textItemSetText]] ( textitem, text )
 
string [[textItemGetText]] ( textitem )
 
void [[textItemSetScale]] ( textitem, scale )
 
float [[textItemGetScale]] ( textitem )
 
void [[textItemSetPosition]] ( textitem, x, y )
 
float, float [[textItemGetPosition]] ( textitem )
 
void [[textItemSetColor]] ( textitem, red, green, blue, alpha )
 
int, int, int, int [[textItemGetColor]] ( textitem )
 
void [[textItemSetPriority]] ( textitem, priority )


int [[textItemGetPriority]] ( textitem )
[[ar:Server Scripting Functions]]
[[de:Server-Seitige Scripting Funktionen]]
[[en:Server Scripting Functions]]
[[es:Funciones_del_Server]]
[[hu:Server Scripting Functions]]
[[pl:Server Scripting Functions]]
[[pt-br:Funções de Scripting do Servidor]]
[[ru:Server Scripting Functions]]
[[tr:Server Scripting Functions]]
[[zh-cn:Server Scripting Functions]]

Latest revision as of 15:13, 7 August 2023

Contributors: Did you create a page but it's not on this list? Confused? Read: Adding Pages to Categories and Templates

This page lists all the server-side scripting functions that have been implemented and are available as native functions. To request a function, create an issue in our GitHub repository.

Please note that the scripting functions can also be extended by loading in dynamic modules that provide new functionality, such as utility functions. These scripting functions are non-native and require the module to be loaded in order to work.

Head over to Modules for a list of non-native serverside functions and modules that are available.

For more functions, check the useful functions page.

Client-side scripting functions can be found here: Client Scripting Functions.

Account functions


ACL functions


Admin functions


Audio functions


Announcement functions


Blip functions


Camera functions


Clothes and body functions


Collision shape functions


Cursor functions


Element functions


Event functions


Explosion functions


File functions


HTTP functions

These functions can only be used from within lua blocks in HTML pages hosted by the server


Input functions


Map functions


Marker functions


Matrix functions


Module functions


Object functions


Output functions


Ped functions


Pickup functions


Player functions


Projectile functions


Radar area functions


Resource functions


Server functions


Settings registry functions


SQL functions


Team functions


Text functions


Utility functions


UTF8 Library


Vehicle functions


Water functions


Weapon functions


World functions


XML functions