Server Scripting Functions: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Changed translations hierarchy)
 
(295 intermediate revisions by 63 users not shown)
Line 1: Line 1:
This page lists all the scripting functions that have been implemented and are available as native functions from the Deathmatch mod. To request a function or event, use [[Requested Functions and Events]]
<pageclass class="server"></pageclass>
 
{{Adding_Pages_to_Categories_and_Templates}}
Please note that the scripting functions can now be extended by loading in dynamic modules that provide new functionality, such as MySQL database access. These scripting functions are non-native and require the module to be loaded in order to work.
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.]
 
Head over to [[Module functions]] for a list of non-native functions and modules that are available.


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==
[[blip]] [[createBlip]] ( float x, float y, float z, [int icon=0, int size=2, int r=255, int g=0, int b=0, int a=255] )
{{Blip_functions}}
 
[[blip]] [[createBlipAttachedTo]] ( [[entity]] entity, [int icon=0, int size=2, int r=255, int g=0, int b=0, int a=255] )
==Camera functions==
 
{{Camera_functions}}
bool [[destroyBlipAttachedTo]] ( [[entity]] entity )
 
==Clothes and body functions==
bool [[destroyAllBlips]] ()
{{Clothes_and_body_functions}}
 
int [[getBlipIcon]] ( [[blip]] blip )
==Collision shape functions==
 
{{Collision_shape_functions}}
int [[getBlipSize]] ( [[blip]] blip )
 
==Cursor functions==
int int int int [[getBlipColor]] ( [[blip]] blip )
{{Cursor_functions}}
 
blip [[getBlipAttachedTo]] ( [[entity]] entity )
 
bool [[setBlipIcon]] ( [[element]] blip, int icon )
 
bool [[setBlipSize]] ( [[element]] blip, int size )
 
bool [[setBlipColor]] ( [[element]] blip, int red, int green, int blue, int alpha )
 
bool [[attachBlipToEntity]] ( [[blip]] blip, [[entity]] entity )
 
==Element functions==
==Element functions==
bool [[destroyElement]] ( [[element]] element )
{{Element_functions}}
 
[[element]] [[getRootElement]] ()
 
[[element]] [[getElementChild]] ( [[element]] parent, int index )
 
int [[getElementChildrenCount]] ( [[element]] parent )
 
string [[getElementID]] ( [[element]] element )
 
[[element]] [[getElementByID]] ( string name, int index )
 
[[element]] [[getElementByIndex]] ( string type, int index )
 
var [[getElementData]] ( string name )
 
[[element]] [[getElementParent]] ( [[element]] element )
 
string [[getElementType]] ( [[element]] element )
 
table [[getElementsByType]] ( string type )
 
bool [[setElementID]] ( [[element]] element, string name )
 
bool [[setElementData]] ( [[element]] element, string name, var data )
 
bool [[setElementParent]] ( [[element]] element, [[element]] parent )
 
==Entity functions==
float float float [[getEntityPosition]] ( [[entity]] entity, float x, float y, float z ) ''''Really?''''
 
bool [[setEntityPosition]] ( [[element]] entity )
 
bool [[addEntityVisibleTo]] ( [[element]] entity, [[element]] visibleto )
 
bool [[removeEntityVisibleTo]] ( [[element]] entity, [[element]] visibleto )
 
bool [[clearEntityVisibleTo]] ( [[element]] entity )
 
==Event functions==
==Event functions==
bool [[addEvent]] ( string name, string arguments )
{{Event_functions}}
 
bool [[addEventHandler]] ( string name, [[element]] element, string handler )
==Explosion functions==
 
{{Explosion_functions}}
bool [[triggerEvent]] ( string name, [[element]] element, [argument, ...] )
 
==File functions==
{{File_functions}}
==HTTP functions==
{{HTTP_functions}}
==Input functions==
{{Server_input_functions}}
==Map functions==
==Map functions==
string [[getLoadedMapName]] ()
{{Map_functions}}
 
xmlnode [[getLoadedMapXMLRoot]] ()
 
bool [[startMap]] ( string name )
 
bool [[endMap]] ()
 
==Marker functions==
==Marker functions==
[[marker]] [[createMarker]] ( float x, float y, float z, [int type, float size, int r, int g, int b] )
{{Marker_functions}}
 
bool [[destroyAllMarkers]] ()
==Matrix functions==
 
{{Shared_matrix_functions}}
int [[getMarkerCount]] ()
 
==Module functions==
int [[getMarkerType]] ( [[marker]] marker )
{{Module_functions}}
 
float [[getMarkerSize]] ( [[marker]] marker )
 
int int int [[getMarkerColor]] ( [[marker]] marker )
 
bool [[setMarkerType]] ( [[element]] marker, int type )
 
bool [[setMarkerSize]] ( [[element]] marker, float size )
 
bool [[setMarkerColor]] ( [[element]] marker, int r, int g, int b )
 
==Object functions==
==Object functions==
[[object]] [[createObject]] ( int id, float x, float y, float z, [float rx, float ry, float rz] )
{{Object_functions}}
 
bool [[destroyAllObjects]] ()
==Output functions==
 
{{Output_functions}}
int [[getObjectModel]] ( [[object]] object )
 
==Ped functions==
float float float [[getObjectRotation]] ( [[object]] object )
{{Ped_functions}}
 
bool [[setObjectModel]] ( [[element]] object, int id )
 
bool [[setObjectRotation]] ( [[element]] object, float x, float y, float z )
 
bool [[moveObject]] ( [[element]] object, int time, float x, float y, float z, float rx, float ry, float rz )
 
==Pickup functions==
==Pickup functions==
[[pickup]] [[createPickup]] ( float x, float y, float z, int type, int amount/weapon, [int ammo] )
{{Pickup_functions}}
 
bool [[destroyAllPickups]] ()
 
int [[getPickupType]] ( [[pickup]] pickup )
 
int [[getPickupWeapon]] ( [[pickup]] pickup )
 
int [[getPickupHealth]] ( [[pickup]] pickup )
 
int [[getPickupAmmo]] ( [[pickup]] pickup )
 
bool [[setPickupType]] ( [[element]] pickup, int type, int amount/weapon, [int ammo] )
 
==Player functions==
==Player functions==
int [[getPlayerCount]] ()
{{Player_functions}}
 
int [[getPlayerCurrentWeaponAmmoInClip]] ( [[player]] player )
==Projectile functions==
 
{{Projectile_functions}}
int [[getPlayerCurrentWeaponID]] ( [[player]] player )
 
[[player]] [[getPlayerFromNick]] ( string nick )
 
float [[getPlayerHealth]] ( [[player]] player )
 
float [[getPlayerArmor]] ( [[player]] player )
 
int [[getPlayerLevel]] ( [[player]] player )
 
int [[getPlayerMoney]] ( [[player]] player )
 
float float float [[getPlayerMoveSpeed]] ( [[player]] player )
 
string [[getPlayerName]] ( [[player]] player )
 
[[vehicle]] [[getPlayerOccupiedVehicle]] ( [[player]] player )
 
int [[getPlayerOccupiedVehicleSeat]] ( [[player]] player )
 
int [[getPlayerPing]] ( [[player]] player )
 
float [[getPlayerRotation]] ( [[player]] player )
 
int [[getPlayerSkin]] ( [[player]] player )
 
string [[getPlayerSourceIP]] ( [[player]] player )
 
[[player]] [[getRandomPlayer]] ()
 
bool [[isPlayerDead]] ( [[player]] player )
 
bool [[isPlayerDucked]] ( [[player]] player )
 
bool [[isPlayerMuted]] ( [[player]] player )
 
bool [[setPlayerRotation]] ( [[element]] player, float rotation )
 
bool [[setPlayerSkin]] ( [[element]] player, int id )
 
bool [[setPlayerHealth]] ( [[element]] player, float health )
 
bool [[setPlayerArmor]] ( [[element]] player, float armor )
 
bool [[setPlayerMoney]] ( [[element]] player, int money )
 
bool [[givePlayerMoney]] ( [[element]] player, int money )
 
bool [[takePlayerMoney]] ( [[element]] player, int money )
 
bool [[killPlayer]] ( [[element]] player )
 
bool [[warpPlayerIntoVehicle]] ( [[player]] player, [[vehicle]] vehicle, [int seat] )
 
bool [[removePlayerFromVehicle]] ( [[element]] player )
 
bool [[spawnPlayer]] ( [[player]] player, float x, float y, float z, float rotation, int skin )
 
==Radar area functions==
==Radar area functions==
[[radararea]] [[createRadarArea]] ( float x, float y, float sizex, float sizey, int r, int g, int b, int a )
{{Radar_area_functions}}
 
bool [[destroyAllRadarAreas]] ()
==Resource functions==
 
{{Resource_functions}}
float float [[getRadarAreaSize]] ( [[radararea]] radararea )
 
int int int int [[getRadarAreaColor]] ( [[radararea]] radararea )
 
bool [[isRadarAreaFlashing]] ( [[radararea]] radararea )
 
bool [[setRadarAreaSize]] ( [[element]] radararea, float x, float y )
 
bool [[setRadarAreaColor]] ( [[element]] radararea, int r, int g, int b, int a )
 
bool [[setRadarAreaFlashing]] ( [[element]] radararea, bool flash )
 
==Scoreboard functions==
bool [[addScoreboardColumn]] ( string id, string name, float width )
 
bool [[removeScoreboardColumn]] ( string id )
 
==Server functions==
==Server functions==
int [[getMaxPlayers]] ()
{{Server_functions}}
 
bool [[serverLoggerPrint]] ( string text )
==Settings registry functions==
 
{{Settings_registry_functions}}
bool [[serverChat]] ( string text, [r, g, b] )
 
==SQL functions==
bool [[playerPM]] ( [[element]] player, string text, [r, g, b] )
{{SQL_functions}}
 
==Spawnpoint functions==
==Team functions==
float [[getSpawnpointRotation]] ( [[spawnpoint]] spawn )
{{Team_functions}}
 
int [[getSpawnpointSkin]] ( [[spawnpoint]] spawn )
==Text functions==
 
{{Text_functions}}
bool [[setSpawnpointRotation]] ( [[element]] spawn, float rotation )
 
bool [[setSpawnpointSkin]] ( [[element]] spawn, int skin )
 
==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 )
 
==Utility functions==
==Utility functions==
float [[getDistanceBetweenPoints2D]] ( float x1, float y1, float x2, float y2 )
{{Utility_functions}}
 
float [[getDistanceBetweenPoints3D]] ( float x1, float y1, float z1, float x2, float y2, float z2 )
==UTF8 Library==
 
{{UTF8_functions}}
int [[randInt]] ( int lowerbound, int upperbound )
 
float [[randFloat]] ()
 
int [[getTickCount]] ()
 
string [[gettok]] ( string text, int index, int separator )
 
bool [[setTimer]] ( string function, int time, [arg1, arg2, ...] )
 
==Vehicle functions==
==Vehicle functions==
vehicle [[createVehicle]] ( int id, float x, float y, float z, [float rx, float ry, float rz] )
{{Vehicle_functions}}
 
bool [[destroyAllVehicles]] ()
==Water functions==
 
{{Water_functions}}
int int int int [[getVehicleColor]] ( [[vehicle]] vehicle )
 
float [[getVehicleHealth]] ( [[vehicle]] vehicle )
 
int [[getVehicleID]] ( [[vehicle]] vehicle )
 
int [[getVehicleIDFromName]] ( string name )
 
int [[getVehicleIndex]] ( [[vehicle]] vehicle )
 
float float float [[getVehicleMoveSpeed]] ( string vehicle )
 
string [[getVehicleName]] ( string vehicle )
 
string [[getVehicleNameFromID]] ( int id )
 
player [[getVehicleOccupant]] ( [[vehicle]] vehicle, [int seat=0] )
 
float float float [[getVehicleRotation]] ( [[vehicle]] vehicle )
 
float float float [[getVehicleTurnSpeed]] ( [[vehicle]] vehicle )
 
float float [[getVehicleTurretPosition]] ( [[vehicle]] vehicle )
 
int [[getVehicleMaxPassengers]] ( [[vehicle]] vehicle )
 
bool [[isVehicleLocked]] ( [[vehicle]] vehicle )
 
bool [[fixVehicle]] ( [[element]] vehicle )
 
bool [[blowVehicle]] ( [[element]] vehicle, [bool explode=true] )
 
bool [[setVehicleRotation]] ( [[element]] vehicle, float rx, float ry, float rz )
 
bool [[setVehicleMoveSpeed]] ( [[element]] vehicle, float x, float y, float z )
 
bool [[setVehicleTurnSpeed]] ( [[element]] vehicle, float rx, float ry, float rz )
 
bool [[setVehicleHealth]] ( [[element]] vehicle, float health )
 
bool [[setVehicleColor]] ( [[element]] vehicle, int color1, int color2, int color3, int color4 )
 
bool [[setVehicleLocked]] ( [[element]] vehicle, bool locked )
 
==Weapon functions==
==Weapon functions==
string [[getWeaponNameFromID]] ( int id )
{{Weapon_functions}}
 
int [[getWeaponIDFromName]] ( string name )
 
bool [[giveWeapon]] ( [[element]] player, int weapon, [int ammo=30] )
 
bool [[takeWeapon]] ( [[element]] player, int weapon )
 
bool [[takeAllWeapons]] ( [[element]] player )
 
==World functions==
==World functions==
int int [[getTime]] ()
{{World_functions}}
 
int [[getWeather]] ()
 
bool [[setTime]] ( int hour, int min )
 
bool [[setWeather]] ( int id )
 
bool [[setWeatherBlended]] ( int id )
 
==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 )
[[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

Retrieved from "https://wiki.multitheftauto.com/wiki/Server_Scripting_Functions?oldid=77397"