Server Scripting Functions: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 29: Line 29:


==Object functions==
==Object functions==
An object is a model in the world. These have collision models and can be moved and rotated at will. Any existing GTA model can be used.
{{Object functions}}
 
[[element]] [[createObject]] ( [[int]] id, [[float]] x, [[float]] y, [[float]] z, [ [[float]] rx, [[float]] ry, [[float]] rz] )
 
[[bool]] [[destroyAllObjects]] ()
 
[[int]] [[getObjectModel]] ( [[element]] object )
 
[[float]] [[float]] [[float]] [[getObjectRotation]] ( [[element]] object )
 
[[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 )
 
[[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 ) ---------------Cannot get to work
 
[[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=0 ] )
 
[[bool]] [[removePlayerFromVehicle]] ( [[element]] player )
 
[[bool]] [[spawnPlayer]] ( [[player]] player, [[spawnpoint]] spawnpoint )
 
[[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, [ visibleTo=[[getRootElement]] () ] )
{{Radar area functions}}
 
[[bool]] [[destroyAllRadarAreas]] ()
 
[[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==
==Scoreboard functions==
[[bool]] [[addScoreboardColumn]] ( [[string]] id, [[string]] name, [[float]] width )
{{Scoreboard functions}}
 
[[bool]] [[removeScoreboardColumn]] ( [[string]] id )


==Server functions==
==Server functions==
[[int]] [[getMaxPlayers]] ()
{{Server functions}}
 
[[bool]] [[outputChatBox]] ( [[string]] text, [[element]] player, [ [[int]] r, [[int]] g, [[int]] b ] )
 
[[bool]] [[outputConsole]] ( [[string]] text, [[element]] player )
 
[[bool]] [[outputDebugString]] ( [[string]] text, [ [[int]] level=3 ] )
 
[[bool]] [[outputServerLog]] ( [[string]] text )
 
[[bool]] [[addCommandHandler]] ( [[string]] key, [[string]] handler )
 
[[bool]] [[removeCommandHandler]] ( [[string]] key )


==Spawnpoint functions==
==Spawnpoint functions==
[[float]] [[getspawnpointRotation]] ( [[spawnpoint]] spawn )
{{Spawnpoint functions}}
 
[[int]] [[getspawnpointSkin]] ( [[spawnpoint]] spawn )
 
[[bool]] [[setspawnpointRotation]] ( [[element]] spawn, [[float]] rotation )
 
[[bool]] [[setspawnpointSkin]] ( [[element]] spawn, [[int]] skin )


==Text functions==
==Text functions==
[[textdisplay]] [[textCreateDisplay]] ()
{{Text functions}}
 
[[void]] [[textDestroyDisplay]] ( [[textdisplay]] textdisplay )
 
[[textitem]] [[textCreateTextItem]] ( [ [[string]] text, [[float]] x, [[float]] y, [[int]] priority, [[int]] r, [[int]] g, [[int]] b, [[int]] a, [[float]] scale ] )
 
[[void]] [[textDestroyTextItem]] ( [[textitem]] textitem )
 
[[void]] [[textDisplayAddText]] ( [[textdisplay]] textdisplay, [[textitem]] textitem )
 
[[void]] [[textDisplayAddObserver]] ( [[textdisplay]] textdisplay, [[player]] player )
 
[[void]] [[textItemSetText]] ( [[textitem]] textitem, [[string]] text )
 
[[string]] [[textItemGetText]] ( [[textitem]] textitem )
 
[[void]]] [[textItemSetScale]] ( [[textitem]] textitem, [[float]] scale )
 
[[float]] [[textItemGetScale]] ( [[textitem]] textitem )
 
[[void]] [[textItemSetPosition]] ( [[textitem]] textitem, [[float]] x, [[float]] y )
 
[[float]] [[float]] [[textItemGetPosition]] ( [[textitem]] textitem )
 
[[void]] [[textItemSetColor]] ( [[textitem]] textitem, [[int]] r, [[int]] g, [[int]] b, [[int]] a )
 
[[int]] [[int]] [[int]] [[int]] [[textItemGetColor]] ( [[textitem]] textitem )
 
[[void]] [[textItemSetPriority]] ( [[textitem]] textitem, [[int]] priority )
 
[[int]] [[textItemGetPriority]] ( [[textitem]] 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 )
 
[[int]] [[randInt]] ( [[int]] lowerbound, [[int]] upperbound )
 
[[float]] [[randFloat]] ()
 
[[int]] [[getTickCount]] ()
 
[[string]] [[gettok]] ( [[string]] text, [[int]] index, [[int]] separator )
 
[[bool]] [[setTimer]] ( [[string]] function, [[int]] time, [ [[var]] argument1, [[var]] argument2, ... ] )


==Vehicle functions==
==Vehicle functions==
[[vehicle]] [[createVehicle]] ( [[int]] id, [[float]] x, [[float]] y, [[float]] z, [ [[float]] rx, [[float]] ry, [[float]] rz ] )
{{Vehicle functions}}
 
[[bool]] [[destroyAllVehicles]] ()
 
[[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==
{{XML functions}}
{{XML functions}}

Revision as of 23:13, 20 May 2006

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

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.

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

Incomplete/Malfunctioning Functions

Incomplete Function List: http://www.mtavc.com/once-upon_a_time-there_was-this_girl/index.php?title=Category:Incomplete

setPlayerRotation - Possibly not functional

Blip functions


Element functions


Entity functions

Template:Entity functions

Event functions


Map functions


Marker functions


Object functions


Pickup functions


Player functions


Radar area functions


Scoreboard functions

Template:Scoreboard functions

Server functions


Spawnpoint functions

Template:Spawnpoint functions

Text functions


Utility functions


Vehicle functions


Weapon functions


World functions


XML functions


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