Multi Theft Auto: Wiki - User contributions [en]

Server Scripting Events

2007-03-21T09:41:21Z

PhatLooser: /* Client Events */

This is a list of server-side scripting events that currently exist. More will come soon.

===Server Events===
void [[onClientLogin]] ( [[account]] previous_account, [[account]] current_account, bool auto-login )

void [[onClientLogout]] ( [[account]] previous_account, [[account]] current_account )

void [[onColShapeHit]] ( [[player]] player, bool matchingDimension )

void [[onColShapeLeave]] ( [[player]] player, bool matchingDimension )

void [[onConsole]] ( string message )

void [[onElementDataChange]] ( string name )

void [[onElementColShapeHit]] ( [[colshape]] hitcolshape, bool matchingDimension )

void [[onElementColShapeLeave]] ( [[colshape]] leftcolshape, bool matchingDimension )

void [[onElementClicked]] ( string button, string state, [[player]] clicker, float posX, float posY, float posZ )

void [[onMarkerHit]] ( [[player]] hitplayer, bool matchingDimension )

void [[onPlayerChat]] ( string message, bool teamchat )

void [[onPlayerDamage]] ( [[player]] attacker, int attackerweapon, int bodypart, float loss )

void [[onPlayerJoin]] ()

void [[onPlayerQuit]] ( string reason )

void [[onPlayerSpawn]] ( [[spawnpoint]] spawnpoint, team )

void [[onPlayerWasted]] ( int ammo, [[player]] killer, int killerweapon, int bodypart )

void [[onPlayerTarget]] ( [[element]] targetedElement )

void [[onPlayerEnterVehicle]] ( [[vehicle]] vehicle, int seat, [[player]] jacked )

void [[onPlayerExitVehicle]] ( [[vehicle]] vehicle, int seat, [[player]] jacker )

void [[onPlayerWeaponSwitch]] ( int previousWeaponID, int currentWeaponID )

void [[onPlayerTask]] ( string priority, int type, string name )

void [[onPlayerMarkerHit]] ( [[marker]] hitmarker, bool matchingDimension )

void [[onPlayerPickupHit]] ( [[pickup]] hitpickup, bool matchingDimension )

void [[onPlayerPickupUse]] ( [[pickup]] usedpickup )

void [[onPickupSpawn]] ()

void [[onPickupHit]] ( [[player]] player, bool matchingDimension )

void [[onPickupUse]] ( [[player]] player )

void [[onPlayerClick]] ( string button, string state, [[element]] clickedElement, float posX, float posY, float posZ )

void [[onResourceStart]] ( string name )

void [[onResourceStop]] ()

void [[onSpawnpointUse]] ( [[player]] player )

void [[onTrailerAttach]] ( [[vehicle]] towedBy )

void [[onTrailerDetach]] ( [[vehicle]] towedBy )

void [[onVehicleDamage]] ( float loss )

void [[onVehicleRespawn]] ( bool explosion )

void [[onVehicleStartEnter]] ( [[player]] player, int seat, [[player]] jacked )

void [[onVehicleStartExit]] ( [[player]] player, int seat, [[player]] jacker )

void [[onVehicleEnter]] ( [[player]] player, int seat, [[player]] jacked )

void [[onVehicleExit]] ( [[player]] player, int seat, [[player]] jacker )

void [[onVehicleExplode]] ()

===Client Events===
void [[onClientWeaponFire]] ( [[weapon]] weapon, int ammo, int ammoInClip, float fX, float fY, float fZ, [[element]] hitElement )

OnClientWeaponFire

2007-03-21T09:40:34Z

PhatLooser: /* Example */

__NOTOC__
This event is triggered when a player switches weapons.

==Syntax==
<syntaxhighlight lang="lua">
void onClientWeaponFire ( [[weapon]] weapon, int ammo, int ammoInClip, float fX, float fY, float fZ, [[element]] hitElement )
</syntaxhighlight>

==Variables==
* The source of this event is (clientside) the player which fired the gun.
*'''weapon''': An integer representing the weapon that was fired
*'''ammo''': An integer representing the remaining ammo
*'''ammoInClip''': An integer representing the remaining ammo in clip
*'''fx fy fz''': The coordinates where the shot hit
*'''hitElement''': Returns the element hit. Value is nil if nothing was hit.

==Example==
This example calls server events, when an object was hit, or the player shot at something with a special gun.
<syntaxhighlight lang="lua">
--add an event handler for onClientWeaponFire
addEventHandler ( "onClientWeaponFire", getRootElement (), "gunfire" )
function gunfire ( weapon, ammo, ammoInClip, fX, fY, fZ, hitElement )
--something was hit?
if ( hitElement ~= nil ) then
triggerServerEvent( "object_hit" , getLocalPlayer () , hitElement )
end
-- filters if the player himself shot the gun, and if its weapon 33
if source == getLocalPlayer () and weapon == 33 then
triggerServerEvent( "teleport_me" , getLocalPlayer () , fX, fY, fZ )
end
end
</syntaxhighlight>

==See Also==
{{Event_functions}}

OnClientWeaponFire

2007-03-21T09:39:41Z

PhatLooser:

__NOTOC__
This event is triggered when a player switches weapons.

==Syntax==
<syntaxhighlight lang="lua">
void onClientWeaponFire ( [[weapon]] weapon, int ammo, int ammoInClip, float fX, float fY, float fZ, [[element]] hitElement )
</syntaxhighlight>

==Variables==
* The source of this event is (clientside) the player which fired the gun.
*'''weapon''': An integer representing the weapon that was fired
*'''ammo''': An integer representing the remaining ammo
*'''ammoInClip''': An integer representing the remaining ammo in clip
*'''fx fy fz''': The coordinates where the shot hit
*'''hitElement''': Returns the element hit. Value is nil if nothing was hit.

==Example==
This example calls server events, when an object was hit, or the player shot at something with a special gun.
<syntaxhighlight lang="lua">
--add an event handler for onClientWeaponFire
addEventHandler ( "onClientWeaponFire", getRootElement (), "gunfire" )
function gunfire ( weapon, ammo, ammoInClip, fX, fY, fZ, hitElement )
--something was hit?
if ( hitElement ~= nil ) then
triggerServerEvent( "object_hit" , getLocalPlayer () , hitElement )
end
-- filters if the player himself shot the gun, and if its weapon 33
if source == getLocalPlayer () and weapon == 33 then
triggerServerEvent( "teleport_me" , getLocalPlayer () , fX, fY, fZ )
end
end

</syntaxhighlight>

==See Also==
{{Event_functions}}

Server Scripting Events

2007-03-21T09:30:46Z

PhatLooser: