Multi Theft Auto: Wiki - User contributions [en]

OOP server

2018-07-01T22:58:40Z

Bonus: Add account functions

{{Needs Checking|This page is partially outdated.}}
The new OOP in MTA allows for better code organization and readability. This is a list of [[Server_Scripting_Functions|server-side functions]].

''See also: [[OOP]]''

==Element==
areCollisionsEnabled (function: [[getElementCollisionsEnabled]])
attach (function: [[attachElements]])
clearVisibility (function: [[clearElementVisibleTo]])
clone (function: [[cloneElement]])
create (function: [[createElement]])
destroy (function: [[destroyElement]])
detach (function: [[detachElements]])
getAllByType (function: [[getElementsByType]])
getAllData (function: [[getAllElementData]])
getAlpha (function: [[getElementAlpha]])
getAttachedElements (function: [[getAttachedElements]])
getAttachedOffsets (function: [[getElementAttachedOffsets]])
getAttachedTo (function: [[getElementAttachedTo]])
getByID (function: [[getElementByID]])
getByIndex (function: [[getElementByIndex]])
getChild (function: [[getElementChild]])
getChildren (function: [[getElementChildren]])
getChildrenCount (function: [[getElementChildrenCount]])
getColShape (function: [[getElementColShape]])
getData (function: [[getElementData]])
getDimension (function: [[getElementDimension]])
getHealth (function: [[getElementHealth]])
getID (function: [[getElementID]])
getInterior (function: [[getElementInterior]])
getLowLOD (function: [[getLowLODElement]])
getModel (function: [[getElementModel]])
getParent (function: [[getElementParent]])
getPosition (function: [[getElementPosition]])
getRotation (function: [[getElementRotation]])
getSyncer (function: [[getElementSyncer]])
getType (function: [[getElementType]])
getVelocity (function: [[getElementVelocity]])
getZoneName (function: [[getElementZoneName]])
isAttached (function: [[isElementAttached]])
isCallPropagationEnabled (function: [[isElementCallPropagationEnabled]])
isDoubleSided (function: [[isElementDoubleSided]])
isFrozen (function: [[isElementFrozen]])
isInWater (function: [[isElementInWater]])
isLowLOD (function: [[isElementLowLOD]])
isVisibleTo (function: [[isElementVisibleTo]])
isWithinColShape (function: [[isElementWithinColShape]])
isWithinMarker (function: [[isElementWithinMarker]])
removeData (function: [[removeElementData]])
setAlpha (function: [[setElementAlpha]])
setAttachedOffsets (function: [[setElementAttachedOffsets]])
setCallPropagationEnabled (function: [[setElementCallPropagationEnabled]])
setCollisionsEnabled (function: [[setElementCollisionsEnabled]])
setData (function: [[setElementData]])
setDimension (function: [[setElementDimension]])
setDoubleSided (function: [[setElementDoubleSided]])
setFrozen (function: [[setElementFrozen]])
setHealth (function: [[setElementHealth]])
setID (function: [[setElementID]])
setInterior (function: [[setElementInterior]])
setMatrix (function: [[setElementMatrix]])
setModel (function: [[setElementModel]])
setParent (function: [[setElementParent]])
setPosition (function: [[setElementPosition]])
setRotation (function: [[setElementRotation]])
setSyncer (function: [[setElementSyncer]])
setVelocity (function: [[setElementVelocity]])

==ACL==

create (function: [[aclCreate]])
destroy (function: [[aclDestroy]])
get (function: [[aclGet]])
getName (function: [[aclGetName]])
getRight (function: [[aclGetRight]])
hasObjectPermissionTo (function: [[hasObjectPermissionTo]])
list (function: [[aclList]])
listRights (function: [[aclListRights]])
reload (function: [[aclReload]])
removeRight (function: [[aclRemoveRight]])
save (function: [[aclSave]])
setRight (function: [[aclSetRight]])

==ACLGroup==

addACL (function: [[aclGroupAddACL]])
addObject (function: [[aclGroupAddObject]])
addToGroup (function: [[aclGroupAddACL]])
create (function: [[aclCreateGroup]])
destroy (function: [[aclDestroyGroup]])
doesContainObject (function: [[isObjectInACLGroup]])
get (function: [[aclGetGroup]])
getName (function: [[aclGroupGetName]])
list (function: [[aclGroupList]])
listACL (function: [[aclGroupListACL]])
listObjects (function: [[aclGroupListObjects]])
removeACL (function: [[aclGroupRemoveACL]])
removeFromGroup (function: [[aclGroupRemoveACL]])
removeObject (function: [[aclGroupRemoveObject]])

==Account==

add (function: [[addAccount]])
copyDataTo (function: [[copyAccountData]])
getData (function: [[getAccountData]])
getID (function: [[getAccountID]])
getIP (function: [[getAccountIP]])
getName (function: [[getAccountName]])
getPlayer (function: [[getAccountPlayer]])
getAllByData (function: [[getAccountsByData]])
getAllByIP (function: [[getAccountsByIP]])
getAllBySerial (function: [[getAccountsBySerial]])
getSerial (function: [[getAccountSerial]])
getAll (function: [[getAccounts]])
create (function: [[getAccount]])
getAllData (function: [[getAllAccountData]])
getAccount (function: [[getPlayerAccount]])
isGuest (function: [[isGuestAccount]])
logIn (function: [[logIn]])
logOut (function: [[logOut]])
remove (function: [[removeAccount]])
setData (function: [[setAccountData]])
setName (function: [[setAccountName]])
setPassword (function: [[setAccountPassword]])

==Ban==

create (function: [[addBan]])
getAdmin (function: [[getBanAdmin]])
getIP (function: [[getBanIP]])
getList (function: [[getBans]])
getNick (function: [[getBanNick]])
getReason (function: [[getBanReason]])
getSerial (function: [[getBanSerial]])
getTime (function: [[getBanTime]])
getUnbanTime (function: [[getUnbanTime]])
remove (function: [[removeBan]])

==Blip==
''Inherited from [[#Element|Element]]''

create (function: [[createBlip]])
createAttachedTo (function: [[createBlipAttachedTo]])
getColor (function: [[getBlipColor]])
getIcon (function: [[getBlipIcon]])
getOrdering (function: [[getBlipOrdering]])
getSize (function: [[getBlipSize]])
getVisibleDistance (function: [[getBlipVisibleDistance]])
setColor (function: [[setBlipColor]])
setIcon (function: [[setBlipIcon]])
setOrdering (function: [[setBlipOrdering]])
setSize (function: [[setBlipSize]])
setVisibleDistance (function: [[setBlipVisibleDistance]])

==ColShape==
''Inherited from [[#Element|Element]]''

Circle (function: [[createColCircle]])
Cuboid (function: [[createColCuboid]])
getElementsWithin (function: [[getElementsWithinColShape]])
isElementWithin (function: [[isElementWithinColShape]])
Polygon (function: [[createColPolygon]])
Rectangle (function: [[createColRectangle]])
Sphere (function: [[createColSphere]])
Tube (function: [[createColTube]])

==File==

close (function: [[fileClose]])
copy (function: [[fileCopy]])
create (function: [[fileOpen]])
delete (function: [[fileDelete]])
destroy (function: [[fileClose]])
exists (function: [[fileExists]])
flush (function: [[fileFlush]])
getPos (function: [[fileGetPos]])
getSize (function: [[fileGetSize]])
isEOF (function: [[fileIsEOF]])
new (function: [[fileCreate]])
read (function: [[fileRead]])
rename (function: [[fileRename]])
setPos (function: [[fileSetPos]])
write (function: [[fileWrite]])

==Marker==
''Inherited from [[#Element|Element]]''

create (function: [[createMarker]])
getColor (function: [[getMarkerColor]])
getCount (function: [[getMarkerCount]])
getIcon (function: [[getMarkerIcon]])
getSize (function: [[getMarkerSize]])
getTarget (function: [[getMarkerTarget]])
getType (function: [[getMarkerType]])
setColor (function: [[setMarkerColor]])
setIcon (function: [[setMarkerIcon]])
setSize (function: [[setMarkerSize]])
setTarget (function: [[setMarkerTarget]])
setType (function: [[setMarkerType]])

==Object==
''Inherited from [[#Element|Element]]''

create (function: [[createObject]])
getScale (function: [[getObjectScale]])
move (function: [[moveObject]])
setScale (function: [[setObjectScale]])
stop (function: [[stopObject]])

==Ped==
''Inherited from [[#Element|Element]]''

addClothes (function: [[addPedClothes]])
create (function: [[createPed]])
doesHaveJetpack (function: [[doesPedHaveJetPack]])
getAmmoInClip (function: [[getPedAmmoInClip]])
getAnalogControlState (function: [[getPedAnalogControlState]])
getArmor (function: [[getPedArmor]])
getClothes (function: [[getPedClothes]])
getContactElement (function: [[getPedContactElement]])
getFightingStyle (function: [[getPedFightingStyle]])
getGravity (function: [[getPedGravity]])
getOccupiedVehicle (function: [[getPedOccupiedVehicle]])
getOccupiedVehicleSeat (function: [[getPedOccupiedVehicleSeat]])
getStat (function: [[getPedStat]])
getTarget (function: [[getPedTarget]])
getTotalAmmo (function: [[getPedTotalAmmo]])
getValidModels (function: [[getValidPedModels]])
getWalkingStyle (function: [[getPedWalkingStyle]])
getWeapon (function: [[getPedWeapon]])
getWeaponSlot (function: [[getPedWeaponSlot]])
giveJetPack (function: [[givePedJetPack]])
isChoking (function: [[isPedChoking]])
isDead (function: [[isPedDead]])
isDoingGangDriveby (function: [[isPedDoingGangDriveby]])
isDucked (function: [[isPedDucked]])
isFrozen (function: [[isPedFrozen]])
isHeadless (function: [[isPedHeadless]])
isInVehicle (function: [[isPedInVehicle]])
isInWater (function: [[isPedInWater]])
isOnFire (function: [[isPedOnFire]])
isOnGround (function: [[isPedOnGround]])
kill (function: [[killPed]])
reloadWeapon (function: [[reloadPedWeapon]])
removeClothes (function: [[removePedClothes]])
removeFromVehicle (function: [[removePedFromVehicle]])
removeJetPack (function: [[removePedJetPack]])
setAnalogControlState (function: [[setPedAnalogControlState]])
setAnimation (function: [[setPedAnimation]])
setAnimationProgress (function: [[setPedAnimationProgress]])
setArmor (function: [[setPedArmor]])
setChoking (function: [[setPedChoking]])
setDoingGangDriveBy (function: [[setPedDoingGangDriveby]])
setFightingStyle (function: [[setPedFightingStyle]])
setFrozen (function: [[setPedFrozen]])
setGravity (function: [[setPedGravity]])
setHeadless (function: [[setPedHeadless]])
setOnFire (function: [[setPedOnFire]])
setStat (function: [[setPedStat]])
setWalkingStyle (function: [[setPedWalkingStyle]])
setWeaponSlot (function: [[setPedWeaponSlot]])
warpIntoVehicle (function: [[warpPedIntoVehicle]])

==Pickup==
''Inherited from [[#Element|Element]]''

create (function: [[createPickup]])
getAmmo (function: [[getPickupAmmo]])
getAmount (function: [[getPickupAmount]])
getRespawnInterval (function: [[getPickupRespawnInterval]])
getType (function: [[getPickupType]])
getWeapon (function: [[getPickupWeapon]])
setRespawnInterval (function: [[setPickupRespawnInterval]])
setType (function: [[setPickupType]])
use (function: [[usePickup]])

==Player==
''Inherited from [[#Ped|Ped]]''

ban (function: [[banPlayer]])
create (function: [[getPlayerFromName]])
forceMap (function: [[forcePlayerMap]])
getAccount (function: [[getPlayerAccount]])
getACInfo (function: [[getPlayerACInfo]])
getAllAlive (function: [[getAlivePlayers]])
getAllDead (function: [[getDeadPlayers]])
getAnnounceValue (function: [[getPlayerAnnounceValue]])
getBlurLevel (function: [[getPlayerBlurLevel]])
getCount (function: [[getPlayerCount]])
getIdleTime (function: [[getPlayerIdleTime]])
getIP (function: [[getPlayerIP]])
getMoney (function: [[getPlayerMoney]])
getName (function: [[getPlayerName]])
getNametagColor (function: [[getPlayerNametagColor]])
getNametagText (function: [[getPlayerNametagText]])
getPing (function: [[getPlayerPing]])
getRandom (function: [[getRandomPlayer]])
getSerial (function: [[getPlayerSerial]])
getTeam (function: [[getPlayerTeam]])
getVersion (function: [[getPlayerVersion]])
getWantedLevel (function: [[getPlayerWantedLevel]])
giveMoney (function: [[givePlayerMoney]])
isMapForced (function: [[isPlayerMapForced]])
isMuted (function: [[isPlayerMuted]])
isNametagShowing (function: [[isPlayerNametagShowing]])
isObservingDisplay (function: [[textDisplayIsObserver]])
isVoiceEnabled (function: [[isVoiceEnabled]])
kick (function: [[kickPlayer]])
logOut (function: [[logOut]])
observeDisplay (function: [[textDisplayAddObserver]])
redirect (function: [[redirectPlayer]])
resendModInfo (function: [[resendPlayerModInfo]])
setAnnounceValue (function: [[setPlayerAnnounceValue]])
setBlurLevel (function: [[setPlayerBlurLevel]])
setHudComponentVisible (function: [[setPlayerHudComponentVisible]])
setMoney (function: [[setPlayerMoney]])
setMuted (function: [[setPlayerMuted]])
setName (function: [[setPlayerName]])
setNametagColor (function: [[setPlayerNametagColor]])
setNametagShowing (function: [[setPlayerNametagShowing]])
setNametagText (function: [[setPlayerNametagText]])
setTeam (function: [[setPlayerTeam]])
setVoiceBroadcastTo (function: [[setPlayerVoiceBroadcastTo]])
setVoiceIgnoreFrom (function: [[setPlayerVoiceIgnoreFrom]])
setWantedLevel (function: [[setPlayerWantedLevel]])
showHudComponent (function: [[showPlayerHudComponent]])
spawn (function: [[spawnPlayer]])
stopObservingDisplay (function: [[textDisplayRemoveObserver]])
takeMoney (function: [[takePlayerMoney]])
takeScreenshot (function: [[takePlayerScreenShot]])
triggerEvent (function: [[triggerClientEvent]])

==RadarArea==
''Inherited from [[#Element|Element]]''

create (function: [[createRadarArea]])
getColor (function: [[getRadarAreaColor]])
getSize (function: [[getRadarAreaSize]])
isFlashing (function: [[isRadarAreaFlashing]])
isInside (function: [[isInsideRadarArea]])
setColor (function: [[setRadarAreaColor]])
setFlashing (function: [[setRadarAreaFlashing]])
setSize (function: [[setRadarAreaSize]])

==Resource==
call (function: [[call]])
copy (function: [[copyResource]])
create (function: [[createResource]])
getDynamicElementRoot (function: [[getResourceDynamicElementRoot]])
getFromName (function: [[getResourceFromName]])
getInfo (function: [[getResourceInfo]])
getMapRootElement (function: [[getResourceMapRootElement]])
getName (function: [[getResourceName]])
getRootElement (function: [[getResourceRootElement]])
getState (function: [[getResourceState]])
removeFile (function: [[removeResourceFile]])
restart (function: [[restartResource]])
start (function: [[startResource]])
stop (function: [[stopResource]])
setInfo (function: [[setResourceInfo]])
rename (function: [[renameResource]])
delete (function: [[deleteResource]])

==Connection==
''Inherited from [[#Element|Element]]''

create (function: [[dbConnect]])
exec (function: [[dbExec]])
query (function: [[dbQuery]])

==QueryHandle==

free (function: [[dbFree]])
poll (function: [[dbPoll]])

==Team==
''Inherited from [[#Element|Element]]''

countPlayers (function: [[countPlayersInTeam]])
create (function: [[createTeam]])
getColor (function: [[getTeamColor]])
getFriendlyFire (function: [[getTeamFriendlyFire]])
getFromName (function: [[getTeamFromName]])
getName (function: [[getTeamName]])
getPlayers (function: [[getPlayersInTeam]])
setColor (function: [[setTeamColor]])
setFriendlyFire (function: [[setTeamFriendlyFire]])
setName (function: [[setTeamName]])

==TextDisplay==

addObserver (function: [[textDisplayAddObserver]])
addText (function: [[textDisplayAddText]])
create (function: [[textCreateDisplay]])
destroy (function: [[textDestroyDisplay]])
getObservers (function: [[textDisplayGetObservers]])
isObserver (function: [[textDisplayIsObserver]])
removeObserver (function: [[textDisplayRemoveObserver]])
removeText (function: [[textDisplayRemoveText]])

==TextItem==

create (function: [[textCreateTextItem]])
destroy (function: [[textDestroyTextItem]])
getColor (function: [[textItemGetColor]])
getPosition (function: [[textItemGetPosition]])
getPriority (function: [[textItemGetPriority]])
getScale (function: [[textItemGetScale]])
getText (function: [[textItemGetText]])
setColor (function: [[textItemSetColor]])
setPosition (function: [[textItemSetPosition]])
setPriority (function: [[textItemSetPriority]])
setScale (function: [[textItemSetScale]])
setText (function: [[textItemSetText]])

==Vehicle==
''Inherited from [[#Element|Element]]''

addSirens (function: [[addVehicleSirens]])
addUpgrade (function: [[addVehicleUpgrade]])
areSirensOn (function: [[getVehicleSirensOn]])
attachTrailer (function: [[attachTrailerToVehicle]])
blow (function: [[blowVehicle]])
create (function: [[createVehicle]])
detachTrailer (function: [[detachTrailerFromVehicle]])
fix (function: [[fixVehicle]])
getAllOfType (function: [[getVehiclesOfType]])
getColor (function: [[getVehicleColor]])
getCompatibleUpgrades (function: [[getVehicleCompatibleUpgrades]])
getController (function: [[getVehicleController]])
getDirection (function: [[getTrainDirection]])
getDoorOpenRatio (function: [[getVehicleDoorOpenRatio]])
getDoorState (function: [[getVehicleDoorState]])
getEngineState (function: [[getVehicleEngineState]])
getHandling (function: [[getVehicleHandling]])
getHeadLightColor (function: [[getVehicleHeadLightColor]])
getLandingGearDown (function: [[getVehicleLandingGearDown]])
getLightState (function: [[getVehicleLightState]])
getMaxPassengers (function: [[getVehicleMaxPassengers]])
getModelFromName (function: [[getVehicleModelFromName]])
getModelHandling (function: [[getModelHandling]])
getName (function: [[getVehicleName]])
getNameFromModel (function: [[getVehicleNameFromModel]])
getOccupant (function: [[getVehicleOccupant]])
getOccupants (function: [[getVehicleOccupants]])
getOriginalHandling (function: [[getOriginalHandling]])
getOverrideLights (function: [[getVehicleOverrideLights]])
getPaintjob (function: [[getVehiclePaintjob]])
getPanelState (function: [[getVehiclePanelState]])
getPlateText (function: [[getVehiclePlateText]])
getSirenParams (function: [[getVehicleSirenParams]])
getSirens (function: [[getVehicleSirens]])
getSpeed (function: [[getTrainSpeed]])
getTowedByVehicle (function: [[getVehicleTowedByVehicle]])
getTowingVehicle (function: [[getVehicleTowingVehicle]])
getTurnVelocity (function: [[getVehicleTurnVelocity]])
getTurretPosition (function: [[getVehicleTurretPosition]])
getUpgradeOnSlot (function: [[getVehicleUpgradeOnSlot]])
getUpgrades (function: [[getVehicleUpgrades]])
getUpgradeSlotName (function: [[getVehicleUpgradeSlotName]])
getVariant (function: [[getVehicleVariant]])
getVehicleType (function: [[getVehicleType]])
getWheelStates (function: [[getVehicleWheelStates]])
isBlown (function: [[isVehicleBlown]])
isDamageProof (function: [[isVehicleDamageProof]])
isDerailable (function: [[isTrainDerailable]])
isDerailed (function: [[isTrainDerailed]])
isFuelTankExplodable (function: [[isVehicleFuelTankExplodable]])
isLocked (function: [[isVehicleLocked]])
isOnGround (function: [[isVehicleOnGround]])
isTaxiLightOn (function: [[isVehicleTaxiLightOn]])
removeSirens (function: [[removeVehicleSirens]])
removeUpgrade (function: [[removeVehicleUpgrade]])
resetExplosionTime (function: [[resetVehicleExplosionTime]])
resetIdleTime (function: [[resetVehicleIdleTime]])
respawn (function: [[respawnVehicle]])
setColor (function: [[setVehicleColor]])
setDamageProof (function: [[setVehicleDamageProof]])
setDerailable (function: [[setTrainDerailable]])
setDerailed (function: [[setTrainDerailed]])
setDirection (function: [[setTrainDirection]])
setDoorOpenRatio (function: [[setVehicleDoorOpenRatio]])
setDoorState (function: [[setVehicleDoorState]])
setDoorsUndamageable (function: [[setVehicleDoorsUndamageable]])
setEngineState (function: [[setVehicleEngineState]])
setFuelTankExplodable (function: [[setVehicleFuelTankExplodable]])
setHandling (function: [[setVehicleHandling]])
setHeadLightColor (function: [[setVehicleHeadLightColor]])
setIdleRespawnDelay (function: [[setVehicleIdleRespawnDelay]])
setLandingGearDown (function: [[setVehicleLandingGearDown]])
setLightState (function: [[setVehicleLightState]])
setLocked (function: [[setVehicleLocked]])
setModelHandling (function: [[setModelHandling]])
setOverrideLights (function: [[setVehicleOverrideLights]])
setPaintJob (function: [[setVehiclePaintjob]])
setPanelState (function: [[setVehiclePanelState]])
setPlateText (function: [[setVehiclePlateText]])
setRespawnDelay (function: [[setVehicleRespawnDelay]])
setRespawnPosition (function: [[setVehicleRespawnPosition]])
setSirens (function: [[setVehicleSirens]])
setSirensOn (function: [[setVehicleSirensOn]])
setSpeed (function: [[setTrainSpeed]])
setTaxiLightOn (function: [[setVehicleTaxiLightOn]])
setTurnVelocity (function: [[setVehicleTurnVelocity]])
setTurretPosition (function: [[setVehicleTurretPosition]])
setVariant (function: [[setVehicleVariant]])
setWheelStates (function: [[setVehicleWheelStates]])
spawn (function: [[spawnVehicle]])
toggleRespawn (function: [[toggleVehicleRespawn]])

==Water==
''Inherited from [[#Element|Element]]''

create (function: [[createWater]])
getColor (function: [[getWaterColor]])
getVertexPosition (function: [[getWaterVertexPosition]])
getWaveHeight (function: [[getWaveHeight]])
resetColor (function: [[resetWaterColor]])
resetLevel (function: [[resetWaterLevel]])
setColor (function: [[setWaterColor]])
setLevel (function: [[setWaterLevel]])
setVertexPosition (function: [[setWaterVertexPosition]])
setWaveHeight (function: [[setWaveHeight]])

==XML==

copy (function: [[xmlCopyFile]])
create (function: [[xmlCreateFile]])
createChild (function: [[xmlCreateChild]])
destroy (function: [[xmlDestroyNode]])
findChild (function: [[xmlFindChild]])
getAttribute (function: [[xmlNodeGetAttribute]])
getAttributes (function: [[xmlNodeGetAttributes]])
getChildren (function: [[xmlNodeGetChildren]])
getName (function: [[xmlNodeGetName]])
getParent (function: [[xmlNodeGetParent]])
load (function: [[xmlLoadFile]])
loadMapData (function: [[loadMapData]])
saveFile (function: [[xmlSaveFile]])
saveMapData (function: [[saveMapData]])
setAttribute (function: [[xmlNodeSetAttribute]])
setName (function: [[xmlNodeSetName]])
setValue (function: [[xmlNodeGetValue]])
setValue (function: [[xmlNodeSetValue]])
unload (function: [[xmlUnloadFile]])

==Timer==

create (function: [[setTimer]])
destroy (function: [[killTimer]])
getDetails (function: [[getTimerDetails]])
isValid (function: [[isTimer]])
reset (function: [[resetTimer]])

[[Category:OOP]]

Template:Player events

2018-07-01T22:55:15Z

Bonus:

*[[onPlayerACInfo]]
*[[onPlayerBan]]
*[[onPlayerChangeNick]]
*[[onPlayerChat]]
*[[onPlayerClick]]
*[[onPlayerCommand]]
*[[onPlayerConnect]]
*[[onPlayerContact]]
*[[onPlayerDamage]]
*[[onPlayerJoin]]
*[[onPlayerLogin]]
*[[onPlayerLogout]]
*[[onPlayerMarkerHit]]
*[[onPlayerMarkerLeave]]
*[[onPlayerModInfo]]
*[[onPlayerMute]]
*[[onPlayerNetworkStatus]]
*[[onPlayerPickupHit]]
*[[onPlayerPickupLeave]]
*[[onPlayerPickupUse]]
*[[onPlayerPrivateMessage]]
*[[onPlayerQuit]]
*[[onPlayerScreenShot]]
*[[onPlayerSpawn]]
*[[onPlayerStealthKill]]
*[[onPlayerTarget]]
*[[onPlayerUnmute]]
*[[onPlayerVehicleEnter]]
*[[onPlayerVehicleExit]]
*[[onPlayerVoiceStart]]
*[[onPlayerVoiceStop]]
*[[onPlayerWasted]]
*[[onPlayerWeaponFire]]
*[[onPlayerWeaponSwitch]]

<noinclude>[[Category:Events templates]]</noinclude>

Template:Pickup events

2018-07-01T22:54:59Z

Bonus:

*[[onPickupHit]]
*[[onPickupLeave]]
*[[onPickupSpawn]]
*[[onPickupUse]]

<noinclude>[[Category:Events templates]]</noinclude>

SetAccountName

2018-07-01T22:52:32Z

Bonus:

{{Server function}}
__NOTOC__
{{New feature/item|3.0160|1.5.5|11747|
This function sets the name of an [[account]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setAccountName ( account theAccount, string name [, bool allowCaseVariations = false] )
</syntaxhighlight>
{{OOP||[[account]]:setName||name}}
===Required Arguments===
*'''theAccount:''' The account you wish to change the name.
*'''name:''' The new name.

===Optional Arguments===
*'''allowCaseVariations:''' Whether the username is case sensitive (if this is set to true, usernames "Bob" and "bob" will refer to different accounts)

===Returns===
Returns a ''true'' if the account name was set, ''false'' if an invalid argument was specified.

==Example==
Change the name of an account.
<syntaxhighlight lang="lua">
addCommandHandler("changeaccountname", function(player, _, oldname, newname)
if not oldname or not newname then
return
end
local account = getAccount(oldname)
if not account then
return
end
setAccountName(account, newname)
end)
</syntaxhighlight>

==See Also==
{{Account_functions}}

GetAccountsByIP

2018-07-01T22:52:00Z

Bonus:

__NOTOC__
{{Server function}}
{{New feature/item|3.0160|1.5.5|11747|
This function returns a [[table]] containing all accounts that were logged onto from specified IP-address.
}}

==Syntax==
<syntaxhighlight lang="lua">
table getAccountsByIP ( string ip )
</syntaxhighlight>
{{OOP|This function is a static function underneath the Account class.|Account.getAllByIP||}}
===Required Arguments===
*'''ip:''' The IP to get accounts from

===Returns===
Returns ''[[table]]'' containing the accounts associated with specified IP-address. Returns ''false'' if invalid arguments were specified.

==Example==
This example adds command ''getAccounts'' that outputs the number of accounts a player has in the chat box.
<syntaxhighlight lang="lua">
addCommandHandler("getAccounts",
function (player, cmd)
local ip = getPlayerIP(player)
local accounts = getAccountsByIP(ip)
outputChatBox("You have " .. #accounts .. " accounts.", player)
end)
</syntaxhighlight>

==See Also==
{{Account_functions}}

GetAccountsByData

2018-07-01T22:51:25Z

Bonus:

__NOTOC__
{{Server function}}
{{New feature/item|3.0160|1.5.5|11747|
This function returns a [[table]] containing all accounts with specified dataName and value (set with setAccountData).
}}

==Syntax==
<syntaxhighlight lang="lua">
table getAccountsByData ( string dataName, string value )
</syntaxhighlight>
{{OOP|This function is a static function underneath the Account class.|Account.getAllByData||}}
===Required Arguments===
*'''dataName:''' The name of the data
*'''value:''' The value the dataName should have

===Returns===
Returns ''[[table]]'' containing the accounts associated with specified value at dataName. Returns ''false'' if invalid arguments were specified.

==Example==
Useless example to show how it works.
<syntaxhighlight lang="lua">
addCommandHandler("accountsbydata", function (player)
local account = getPlayerAccount(player)
setAccountData(account, "test", "hello")
local accounts = getAccountsByData("test", "hello")
outputChatBox(getAccountName(accounts[1]), player)
end)
</syntaxhighlight>

==See Also==
{{Account_functions}}

GetAccountsByIP

2018-07-01T22:50:58Z

Bonus:

__NOTOC__
{{Server function}}
{{New feature/item|3.0160|1.5.5|12217|
This function returns a [[table]] containing all accounts that were logged onto from specified IP-address.
}}

==Syntax==
<syntaxhighlight lang="lua">
table getAccountsByIP ( string ip )
</syntaxhighlight>
{{OOP|This function is a static function underneath the Account class.|Account.getAllByIP||}}
===Required Arguments===
*'''ip:''' The IP to get accounts from

===Returns===
Returns ''[[table]]'' containing the accounts associated with specified IP-address. Returns ''false'' if invalid arguments were specified.

==Example==
This example adds command ''getAccounts'' that outputs the number of accounts a player has in the chat box.
<syntaxhighlight lang="lua">
addCommandHandler("getAccounts",
function (player, cmd)
local ip = getPlayerIP(player)
local accounts = getAccountsByIP(ip)
outputChatBox("You have " .. #accounts .. " accounts.", player)
end)
</syntaxhighlight>

==See Also==
{{Account_functions}}

GetAccountByID

2018-07-01T22:50:31Z

Bonus:

__NOTOC__
{{Server function}}
{{New feature/item|3.0160|1.5.5|12217|
This function returns the account with the specific ID.
}}

==Syntax==
<syntaxhighlight lang="lua">
account getAccountByID ( int id )
</syntaxhighlight>

===Required Arguments===
*'''id:''' The ID to get account from

===Returns===
Returns ''[[account]]'' associated with specified ID. Returns ''false'' if invalid arguments were specified or there is no account with this ID.

==Example==
This example adds command ''getAccount'' that outputs the account-name of the account with ID.
<syntaxhighlight lang="lua">
addCommandHandler("getAccount",
function (player, cmd, id)
id = tonumber(id)
local account = getAccountByID(id)
if account then
outputChatBox("The name of the account with that ID is: "..getAccountName(account), player)
else
outputChatBox("There is no account with this ID.", player)
end
end)
</syntaxhighlight>

==See Also==
{{Account_functions}}

GetAccountIP

2018-07-01T22:50:14Z

Bonus:

{{Server function}}
__NOTOC__
{{New feature/item|3.0160|1.5.5|11747|
This function retrieves the IP-address of an [[account]].
}}

==Syntax==
<syntaxhighlight lang="lua">
string getAccountIP ( account theAccount )
</syntaxhighlight>
{{OOP||[[account]]:getIP|ip|}}
===Required Arguments===
*'''theAccount:''' The account you wish to get the IP of.

===Returns===
Returns a string containing the account's IP, ''false'' if the account does not exist or an invalid argument was passed to the function.

==Example==
This example announces into the debugscript when a player logs into his account.
<syntaxhighlight lang="lua">
function outputOnLogin ( previous_account, current_account, auto_login ) --when a player logs in
outputDebugScript(getPlayerName(source).."logged into his account with IP "..getAccountIP(previous_account)) -- announce it into the debugscript
end
addEventHandler("onPlayerLogin",getRootElement(),outputOnLogin ) --add an event handler
</syntaxhighlight>

==See Also==
{{Account_functions}}

GetAccountID

2018-07-01T22:48:47Z

Bonus:

{{Server function}}
__NOTOC__
{{New feature/item|3.0160|1.5.5|12217|
This function retrieves the ID of an [[account]].
}}

==Syntax==
<syntaxhighlight lang="lua">
int getAccountID ( account theAccount )
</syntaxhighlight>
{{OOP||[[account]]:getID|id|}}
===Required Arguments===
*'''theAccount:''' The account you wish to get the ID of.

===Returns===
Returns a int containing the account's ID, ''false'' if the account does not exist or an invalid argument was passed to the function.

==Example==
This example announces into the console when a player logs into his account.
<syntaxhighlight lang="lua">
function outputOnLogin ( previous_account, current_account, auto_login ) --when a player logs in
outputConsole("["..getAccountID(previous_account).."] "..getAccountName(previous_account).." Logged into ["..getAccountID(current_account).."]"..getAccountName(current_account)) -- announce it into the console
end
addEventHandler("onPlayerLogin",getRootElement(),outputOnLogin ) --add an event handler
</syntaxhighlight>

==See Also==
{{Account_functions}}

OnPlayerPickupLeave

2018-07-01T22:47:54Z

Bonus:

__NOTOC__
{{Server event}}
{{New feature/item|3.0160|1.5.5|11783|
This event is triggered when a [[player]] leaves a [[pickup]].
}}

==Parameters==
<syntaxhighlight lang="lua">
pickup pickupLeft
</syntaxhighlight>

*'''pickupLeft''': the [[pickup]] the [[player]] left.

==Source==
This example creates a pickup and outputs a message to the chat box when a player leaves it.
<syntaxhighlight lang="lua">
local aPickup = createPickup ( 10.0, 10.0, 10.0, 2, 31, 3000, 50 ) --Create an M4 weapon pickup when script starts

function leftWeaponPickup( pickup )
if pickup == aPickup then
outputChatBox ( "You have left the M4 weapon pickup.", source ) --Display this message in the chat box
end
end
addEventHandler ( "onPlayerPickupLeave", root, pickedUpWeaponCheck )
</syntaxhighlight>

{{See also/Server event|Player events}}

OnPickupLeave

2018-07-01T22:47:31Z

Bonus:

__NOTOC__
{{Server event}}
{{New feature/item|3.0160|1.5.5|11783|
This event is triggered when a [[player]] leaves a [[pickup]].
}}

==Parameters==
<syntaxhighlight lang="lua">
player thePlayer
</syntaxhighlight>

*'''thePlayer''': a [[player]] element referring to the player who left the [[pickup]].

==Source==
The [[event system#Event source|source]] of this event is the [[pickup]] that was left by the player.

==Example==
This example creates a pickup and outputs a message to the chat box when a player leaves it.
<syntaxhighlight lang="lua">
local aPickup = createPickup ( 10.0, 10.0, 10.0, 2, 31, 3000, 50 ) --Create an M4 weapon pickup when script starts

function leftWeaponPickup( player )
outputChatBox ( "You have left the M4 weapon pickup.", player ) --Display this message in the chat box
end
addEventHandler ( "onPickupLeave", aPickup, pickedUpWeaponCheck )
</syntaxhighlight>

{{See also/Server event|Pickup events}}

OnPickupLeave

2018-07-01T22:47:18Z

Bonus:

__NOTOC__
{{Server event}}
{{New feature/item|3.0160|1.5.6|11783|
This event is triggered when a [[player]] leaves a [[pickup]].
}}

==Parameters==
<syntaxhighlight lang="lua">
player thePlayer
</syntaxhighlight>

*'''thePlayer''': a [[player]] element referring to the player who left the [[pickup]].

==Source==
The [[event system#Event source|source]] of this event is the [[pickup]] that was left by the player.

==Example==
This example creates a pickup and outputs a message to the chat box when a player leaves it.
<syntaxhighlight lang="lua">
local aPickup = createPickup ( 10.0, 10.0, 10.0, 2, 31, 3000, 50 ) --Create an M4 weapon pickup when script starts

function leftWeaponPickup( player )
outputChatBox ( "You have left the M4 weapon pickup.", player ) --Display this message in the chat box
end
addEventHandler ( "onPickupLeave", aPickup, pickedUpWeaponCheck )
</syntaxhighlight>

{{See also/Server event|Pickup events}}

SetAccountName

2018-07-01T22:29:57Z

Bonus:

{{Server function}}
__NOTOC__
This function sets the name of an [[account]].

==Syntax==
<syntaxhighlight lang="lua">
bool setAccountName ( account theAccount, string name [, bool allowCaseVariations = false] )
</syntaxhighlight>
{{OOP||[[account]]:setName||name}}
===Required Arguments===
*'''theAccount:''' The account you wish to change the name.
*'''name:''' The new name.

===Optional Arguments===
*'''allowCaseVariations:''' Whether the username is case sensitive (if this is set to true, usernames "Bob" and "bob" will refer to different accounts)

===Returns===
Returns a ''true'' if the account name was set, ''false'' if an invalid argument was specified.

==Example==
Change the name of an account.
<syntaxhighlight lang="lua">
addCommandHandler("changeaccountname", function(player, _, oldname, newname)
if not oldname or not newname then
return
end
local account = getAccount(oldname)
if not account then
return
end
setAccountName(account, newname)
end)
</syntaxhighlight>

==See Also==
{{Account_functions}}

Useful Functions/SetAccountName

2018-07-01T22:28:22Z

Bonus: Bonus moved page Useful Functions/SetAccountName to SetAccountName over redirect

#REDIRECT [[SetAccountName]]

SetAccountName

2018-07-01T22:28:22Z

Bonus: Bonus moved page Useful Functions/SetAccountName to SetAccountName over redirect

{{Server function}}
__NOTOC__
This function sets the name of an [[account]].

==Syntax==
<syntaxhighlight lang="lua">
bool setAccountName ( account theAccount, string name [, bool allowCaseVariations = false] )
</syntaxhighlight>
{{OOP||[[account]]:setName||name}}
===Required Arguments===
*'''theAccount:''' The account you wish to change the name.
*'''name:''' The new name.

===Optional Arguments===
*'''allowCaseVariations:''' Whether the username is case sensitive (if this is set to true, usernames "Bob" and "bob" will refer to different accounts)

===Returns===
Returns a ''true'' if the account name was set, ''false'' if an invalid argument was specified.

==Example==
Change the name of an account.
<syntaxhighlight lang="lua">
addCommandHandler("changeaccountname", function(player, _, oldname, newname)
if not oldname or not newname then
return
end
local account = getAccountByName(oldname)
if not account then
return
end
setAccountName(account, newname)
end)
</syntaxhighlight>

==See Also==
{{Account_functions}}

SetAccountName

2018-07-01T22:26:31Z

Bonus:

{{Server function}}
__NOTOC__
This function sets the name of an [[account]].

==Syntax==
<syntaxhighlight lang="lua">
bool setAccountName ( account theAccount, string name [, bool allowCaseVariations = false] )
</syntaxhighlight>
{{OOP||[[account]]:setName||name}}
===Required Arguments===
*'''theAccount:''' The account you wish to change the name.
*'''name:''' The new name.

===Optional Arguments===
*'''allowCaseVariations:''' Whether the username is case sensitive (if this is set to true, usernames "Bob" and "bob" will refer to different accounts)

===Returns===
Returns a ''true'' if the account name was set, ''false'' if an invalid argument was specified.

==Example==
Change the name of an account.
<syntaxhighlight lang="lua">
addCommandHandler("changeaccountname", function(player, _, oldname, newname)
if not oldname or not newname then
return
end
local account = getAccountByName(oldname)
if not account then
return
end
setAccountName(account, newname)
end)
</syntaxhighlight>

==See Also==
{{Account_functions}}

GetAccountsByData

2018-07-01T22:17:42Z

Bonus:

__NOTOC__
{{Server function}}
This function returns a [[table]] containing all accounts with specified dataName and value (set with setAccountData).

==Syntax==
<syntaxhighlight lang="lua">
table getAccountsByData ( string dataName, string value )
</syntaxhighlight>
{{OOP|This function is a static function underneath the Account class.|Account.getAllByData||}}
===Required Arguments===
*'''dataName:''' The name of the data
*'''value:''' The value the dataName should have

===Returns===
Returns ''[[table]]'' containing the accounts associated with specified value at dataName. Returns ''false'' if invalid arguments were specified.

==Example==
Useless example to show how it works.
<syntaxhighlight lang="lua">
addCommandHandler("accountsbydata", function (player)
local account = getPlayerAccount(player)
setAccountData(account, "test", "hello")
local accounts = getAccountsByData("test", "hello")
outputChatBox(getAccountName(accounts[1]), player)
end)
</syntaxhighlight>

==See Also==
{{Account_functions}}

GetAccountsByData

2018-07-01T22:17:30Z

Bonus:

__NOTOC__
{{Server function}}
This function returns a [[table]] containing all accounts with specified dataName and value (set with setAccountData).

==Syntax==
<syntaxhighlight lang="lua">
table getAccountsByData ( string dataName, string value )
</syntaxhighlight>
{{OOP|This function is a static function underneath the Account class.|Account.getAllByData||}}
===Required Arguments===
*'''dataName:''' The name of the data
*'''value:''' The value the dataName should have

===Returns===
Returns ''[[table]]'' containing the accounts associated with specified value at dataName. Returns ''false'' if invalid arguments were specified.

==Example==
<syntaxhighlight lang="lua">
Useless example to show how it works.
addCommandHandler("accountsbydata", function (player)
local account = getPlayerAccount(player)
setAccountData(account, "test", "hello")
local accounts = getAccountsByData("test", "hello")
outputChatBox(getAccountName(accounts[1]), player)
end)
</syntaxhighlight>

==See Also==
{{Account_functions}}

GetAccountsByData

2018-07-01T22:17:05Z

Bonus:

__NOTOC__
{{Server function}}
This function returns a [[table]] containing all accounts with specified dataName and value (setted with setAccountData)

==Syntax==
<syntaxhighlight lang="lua">
table getAccountsByData ( string dataName, string value )
</syntaxhighlight>
{{OOP|This function is a static function underneath the Account class.|Account.getAllByData||}}
===Required Arguments===
*'''dataName:''' The name of the data
*'''value:''' The value the dataName should have

===Returns===
Returns ''[[table]]'' containing the accounts associated with specified value at dataName. Returns ''false'' if invalid arguments were specified.

==Example==
<syntaxhighlight lang="lua">
Useless example to show how it works.
addCommandHandler("accountsbydata", function (player)
local account = getPlayerAccount(player)
setAccountData(account, "test", "hello")
local accounts = getAccountsByData("test", "hello")
outputChatBox(getAccountName(accounts[1]), player)
end)
</syntaxhighlight>

==See Also==
{{Account_functions}}

GetAccountsByData

2018-07-01T22:16:28Z

Bonus: Created page with "__NOTOC__ {{Server function}} This function returns a table containing all accounts that were logged onto from specified IP-address. ==Syntax== <syntaxhighlight lang="l..."

__NOTOC__
{{Server function}}
This function returns a [[table]] containing all accounts that were logged onto from specified IP-address.

==Syntax==
<syntaxhighlight lang="lua">
table getAccountsByData ( string dataName, string value )
</syntaxhighlight>
{{OOP|This function is a static function underneath the Account class.|Account.getAllByData||}}
===Required Arguments===
*'''dataName:''' The name of the data
*'''value:''' The value the dataName should have

===Returns===
Returns ''[[table]]'' containing the accounts associated with specified value at dataName. Returns ''false'' if invalid arguments were specified.

==Example==
<syntaxhighlight lang="lua">
Useless example to show how it works.
addCommandHandler("accountsbydata", function (player)
local account = getPlayerAccount(player)
setAccountData(account, "test", "hello")
local accounts = getAccountsByData("test", "hello")
outputChatBox(getAccountName(accounts[1]), player)
end)
</syntaxhighlight>

==See Also==
{{Account_functions}}

GetAccountByID

2018-07-01T22:12:07Z

Bonus: Created page with "__NOTOC__ {{Server function}} This function returns the account with the specific ID. ==Syntax== <syntaxhighlight lang="lua"> account getAccountByID ( int id ) </syntaxhigh..."

__NOTOC__
{{Server function}}
This function returns the account with the specific ID.

==Syntax==
<syntaxhighlight lang="lua">
account getAccountByID ( int id )
</syntaxhighlight>

===Required Arguments===
*'''id:''' The ID to get account from

===Returns===
Returns ''[[account]]'' associated with specified ID. Returns ''false'' if invalid arguments were specified or there is no account with this ID.

==Example==
This example adds command ''getAccount'' that outputs the account-name of the account with ID.
<syntaxhighlight lang="lua">
addCommandHandler("getAccount",
function (player, cmd, id)
id = tonumber(id)
local account = getAccountByID(id)
if account then
outputChatBox("The name of the account with that ID is: "..getAccountName(account), player)
else
outputChatBox("There is no account with this ID.", player)
end
end)
</syntaxhighlight>

==See Also==
{{Account_functions}}

GetAccountIP

2018-07-01T22:07:04Z

Bonus: Created page with "{{Server function}} __NOTOC__ This function retrieves the IP-address of an account. ==Syntax== <syntaxhighlight lang="lua"> string getAccountIP ( account theAccount ) </..."

{{Server function}}
__NOTOC__
This function retrieves the IP-address of an [[account]].

==Syntax==
<syntaxhighlight lang="lua">
string getAccountIP ( account theAccount )
</syntaxhighlight>
{{OOP||[[account]]:getIP|ip|}}
===Required Arguments===
*'''theAccount:''' The account you wish to get the IP of.

===Returns===
Returns a string containing the account's IP, ''false'' if the account does not exist or an invalid argument was passed to the function.

==Example==
This example announces into the debugscript when a player logs into his account.
<syntaxhighlight lang="lua">
function outputOnLogin ( previous_account, current_account, auto_login ) --when a player logs in
outputDebugScript(getPlayerName(source).."logged into his account with IP "..getAccountIP(previous_account)) -- announce it into the debugscript
end
addEventHandler("onPlayerLogin",getRootElement(),outputOnLogin ) --add an event handler
</syntaxhighlight>

==See Also==
{{Account_functions}}

GetAccountsByIP

2018-07-01T22:03:57Z

Bonus:

__NOTOC__
{{Server function}}
This function returns a [[table]] containing all accounts that were logged onto from specified IP-address.

==Syntax==
<syntaxhighlight lang="lua">
table getAccountsByIP ( string ip )
</syntaxhighlight>
{{OOP|This function is a static function underneath the Account class.|Account.getAllByIP||}}
===Required Arguments===
*'''ip:''' The IP to get accounts from

===Returns===
Returns ''[[table]]'' containing the accounts associated with specified IP-address. Returns ''false'' if invalid arguments were specified.

==Example==
This example adds command ''getAccounts'' that outputs the number of accounts a player has in the chat box.
<syntaxhighlight lang="lua">
addCommandHandler("getAccounts",
function (player, cmd)
local ip = getPlayerIP(player)
local accounts = getAccountsByIP(ip)
outputChatBox("You have " .. #accounts .. " accounts.", player)
end)
</syntaxhighlight>

==See Also==
{{Account_functions}}

GetAccountsByIP

2018-07-01T22:03:37Z

Bonus:

__NOTOC__
{{Server function}}
This function returns a [[table]] containing all accounts that were logged onto from specified IP-address.

==Syntax==
<syntaxhighlight lang="lua">
table getAccountsByIP ( string ip )
</syntaxhighlight>
{{OOP|This function is a static function underneath the Account class.|Account.getAllByIP||}}
===Required Arguments===
*'''ip:''' The IP to get accounts from

===Returns===
Returns ''[[table]]'' containing the accounts associated with specified ip. Returns ''false'' if invalid arguments were specified.

==Example==
This example adds command ''getAccounts'' that outputs the number of accounts a player has in the chat box.
<syntaxhighlight lang="lua">
addCommandHandler("getAccounts",
function (player, cmd)
local ip = getPlayerIP(player)
local accounts = getAccountsByIP(ip)
outputChatBox("You have " .. #accounts .. " accounts.", player)
end)
</syntaxhighlight>

==See Also==
{{Account_functions}}

GetAccountsByIP

2018-07-01T22:02:49Z

Bonus: Created page with "__NOTOC__ {{Server function}} This function returns a table containing all accounts that were logged onto from specified IP. ==Syntax== <syntaxhighlight lang="lua">..."

__NOTOC__
{{Server function}}
This function returns a [[table]] containing all accounts that were logged onto from specified [[IP]].

==Syntax==
<syntaxhighlight lang="lua">
table getAccountsByIP ( string ip )
</syntaxhighlight>
{{OOP|This function is a static function underneath the Account class.|Account.getAllByIP||}}
===Required Arguments===
*'''ip:''' The [[ip]] to get accounts from

===Returns===
Returns ''[[table]]'' containing the accounts associated with specified ip. Returns ''false'' if invalid arguments were specified.

==Example==
This example adds command ''getAccounts'' that outputs the number of accounts a player has in the chat box.
<syntaxhighlight lang="lua">
addCommandHandler("getAccounts",
function (player, cmd)
local ip = getPlayerIP(player)
local accounts = getAccountsByIP(ip)
outputChatBox("You have " .. #accounts .. " accounts.", player)
end)
</syntaxhighlight>

==See Also==
{{Account_functions}}

Template:Account functions

2018-07-01T21:57:45Z

Bonus:

*[[addAccount]]
*[[copyAccountData]]
*[[getAccount]]
*[[getAccountByID]]
*[[getAccountData]]
*[[getAccountID]]
*[[getAccountIP]]
*[[getAccountName]]
*[[getAccountPlayer]]
*[[getAccountSerial]]
*[[getAccounts]]
*[[getAccountsByData]]
*[[getAccountsByIP]]
*[[getAccountsBySerial]]
*[[getAllAccountData]]
*[[getPlayerAccount]]
*[[isGuestAccount]]
*[[logIn]]
*[[logOut]]
*[[removeAccount]]
*[[setAccountData]]
*[[setAccountName]]
*[[setAccountPassword]]

<noinclude>[[Category:Functions templates]]</noinclude>

Template:Account functions

2018-07-01T21:56:14Z

Bonus:

*[[addAccount]]
*[[copyAccountData]]
*[[getAccount]]
*[[getAccountData]]
*[[getAccountID]]
*[[getAccountName]]
*[[getAccountPlayer]]
*[[getAccountSerial]]
*[[getAccounts]]
*[[getAccountsBySerial]]
*[[getAllAccountData]]
*[[getPlayerAccount]]
*[[isGuestAccount]]
*[[logIn]]
*[[logOut]]
*[[removeAccount]]
*[[setAccountData]]
*[[setAccountPassword]]

<noinclude>[[Category:Functions templates]]</noinclude>

GetAccountID

2018-07-01T21:41:00Z

Bonus: /* Required Arguments */

{{Server function}}
__NOTOC__
This function retrieves the ID of an [[account]].

==Syntax==
<syntaxhighlight lang="lua">
int getAccountID ( account theAccount )
</syntaxhighlight>
{{OOP||[[account]]:getID|id|}}
===Required Arguments===
*'''theAccount:''' The account you wish to get the ID of.

===Returns===
Returns a int containing the account's ID, ''false'' if the account does not exist or an invalid argument was passed to the function.

==Example==
This example announces into the console when a player logs into his account.
<syntaxhighlight lang="lua">
function outputOnLogin ( previous_account, current_account, auto_login ) --when a player logs in
outputConsole("["..getAccountID(previous_account).."] "..getAccountName(previous_account).." Logged into ["..getAccountID(current_account).."]"..getAccountName(current_account)) -- announce it into the console
end
addEventHandler("onPlayerLogin",getRootElement(),outputOnLogin ) --add an event handler
</syntaxhighlight>

==See Also==
{{Account_functions}}

GetAccountID

2018-07-01T21:39:01Z

Bonus: Created page with "{{Server function}} __NOTOC__ This function retrieves the ID of an account. ==Syntax== <syntaxhighlight lang="lua"> int getAccountID ( account theAccount ) </syntaxhighl..."

{{Server function}}
__NOTOC__
This function retrieves the ID of an [[account]].

==Syntax==
<syntaxhighlight lang="lua">
int getAccountID ( account theAccount )
</syntaxhighlight>
{{OOP||[[account]]:getID|id|}}
===Required Arguments===
*'''theAccount:''' The account you wish to get the name of.

===Returns===
Returns a int containing the account's ID, ''false'' if the account does not exist or an invalid argument was passed to the function.

==Example==
This example announces into the console when a player logs into his account.
<syntaxhighlight lang="lua">
function outputOnLogin ( previous_account, current_account, auto_login ) --when a player logs in
outputConsole("["..getAccountID(previous_account).."] "..getAccountName(previous_account).." Logged into ["..getAccountID(current_account).."]"..getAccountName(current_account)) -- announce it into the console
end
addEventHandler("onPlayerLogin",getRootElement(),outputOnLogin ) --add an event handler
</syntaxhighlight>

==See Also==
{{Account_functions}}

OnPlayerPickupLeave

2018-07-01T21:32:38Z

Bonus: Created page with "__NOTOC__ {{Server event}} This event is triggered when a player leaves a pickup. ==Parameters== <syntaxhighlight lang="lua"> pickup pickupLeft </syntaxhighlight> *..."

__NOTOC__
{{Server event}}
This event is triggered when a [[player]] leaves a [[pickup]].

==Parameters==
<syntaxhighlight lang="lua">
pickup pickupLeft
</syntaxhighlight>

*'''pickupLeft''': the [[pickup]] the [[player]] left.

==Source==
This example creates a pickup and outputs a message to the chat box when a player leaves it.
<syntaxhighlight lang="lua">
local aPickup = createPickup ( 10.0, 10.0, 10.0, 2, 31, 3000, 50 ) --Create an M4 weapon pickup when script starts

function leftWeaponPickup( pickup )
if pickup == aPickup then
outputChatBox ( "You have left the M4 weapon pickup.", source ) --Display this message in the chat box
end
end
addEventHandler ( "onPlayerPickupLeave", root, pickedUpWeaponCheck )
</syntaxhighlight>

{{See also/Server event|Player events}}

OnPickupLeave

2018-07-01T21:28:59Z

Bonus: Created page with "__NOTOC__ {{Server event}} This event is triggered when a player leaves a pickup. ==Parameters== <syntaxhighlight lang="lua"> player thePlayer </syntaxhighlight> *..."

__NOTOC__
{{Server event}}
This event is triggered when a [[player]] leaves a [[pickup]].

==Parameters==
<syntaxhighlight lang="lua">
player thePlayer
</syntaxhighlight>

*'''thePlayer''': a [[player]] element referring to the player who left the [[pickup]].

==Source==
The [[event system#Event source|source]] of this event is the [[pickup]] that was left by the player.

==Example==
This example creates a pickup and outputs a message to the chat box when a player leaves it.
<syntaxhighlight lang="lua">
local aPickup = createPickup ( 10.0, 10.0, 10.0, 2, 31, 3000, 50 ) --Create an M4 weapon pickup when script starts

function leftWeaponPickup( player )
outputChatBox ( "You have left the M4 weapon pickup.", player ) --Display this message in the chat box
end
addEventHandler ( "onPickupLeave", aPickup, pickedUpWeaponCheck )
</syntaxhighlight>

{{See also/Server event|Pickup events}}

SetWeatherBlended

2018-06-24T10:31:14Z

Bonus: It's not directly 2 hours, it's 1-2 hours

__NOTOC__
{{Server client function}}
This function will change the current [[weather]] to another in a smooth manner, over the period of 1-2 in-game hours (unlike [[setWeather]], which sets a new weather instantly). To ensure this transition performs as expected, you should not call this function until [[getWeather]] indicates that no transition is already being done.

==Syntax==
<syntaxhighlight lang="lua">
bool setWeatherBlended ( int weatherID )
</syntaxhighlight>

===Required Arguments===
*'''weatherID:''' The ID of the [[weather]] state you wish to set. Valid values are 0 to 255 inclusive.

===Returns===
Returns ''true'' if successful, ''false'' if an invalid ''weatherID'' is passed.

==Example==
This example sets the weather to sunny, then makes it change to a foggy over the period of one-two hours (assuming that a in-game hour is a minute in real time).
<syntaxhighlight lang="lua">
-- Set the weather to sunny
setWeather ( 0 )
-- Blend the weather to foggy
setWeatherBlended ( 9 )
</syntaxhighlight>

==See Also==
{{World functions}}

[[ru:setWeatherBlended]]

OnPlayerPickupHit

2017-11-29T15:21:30Z

Bonus: There is no "matchingDimension" in onPlayerPickupHit!

__NOTOC__
{{Server event}}
This event is triggered when a [[player]] hits a [[pickup]].

==Parameters==
<syntaxhighlight lang="lua">
pickup pickupHit
</syntaxhighlight>

*'''pickupHit''': The pickup the player hit

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that hit the pickup.


==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the player will not be able to pick up this pickup.

==Example==

This example disables the use of armour pickups.

<syntaxhighlight lang="lua">
function armourBlock(pickup)
if (getPickupType(pickup) == 1) then -- If it's an armour pickup
cancelEvent() -- Cancel the event
outputChatBox("Armour pickups are disabled.",source,255,0,0)
end
end
addEventHandler("onPlayerPickupHit",getRootElement(),armourBlock)
</syntaxhighlight>

{{See also/Server event|Player events}}

Talk:FadeCamera

2017-04-29T13:25:23Z

Bonus: timeToFade info is wrong

With a gamespeed smaller than 1 you can use a fade smaller than 1.
"Any number less than 1 makes the fade instant." isn't right when gamespeed is lower than 1.
Example: timeToFade 0.3 at gamespeed 0.1 is like 3 seconds at gamespeed 1