Multi Theft Auto: Wiki - User contributions [en]

CreateExplosion

2007-09-17T21:19:06Z

MrJax:

__NOTOC__
{{Server client function}}
Creates an explosion of a certain type at a specified point in the world.

==Syntax==
<syntaxhighlight lang="lua">
bool createExplosion ( float x, float y, float z, int type [, player creator = nil, bool makeSound = true, float camShake = -1.0, bool damaging = true ] )
</syntaxhighlight>

===Required Arguments===
*'''x:''' A float value that specifies the X world coordinate where the explosion is created at.
*'''y:''' A float value that specifies the Y world coordinate where the explosion is created at.
*'''z:''' A float value that specifies the Z world coordinate where the explosion is created at.
*'''type:''' A integer specifying the explosion type. Valid types are:
{{Explosions}}

===Optional Arguments===
*'''creator:''' The explosion's simulated creator, the [[player]] responsible for it.

===Returns===
Returns ''true'' if the explosion was created, ''false'' if invalid parameters were passed.

==Example==
<section name="Server" class="server" show="true">
'''Example 1:''' This code will create an explosion at the player's position when they spawn.
<syntaxhighlight lang="lua">function explosionOnSpawn ( )
-- get the spawned player's position
local pX, pY, pZ = getElementPosition ( source )
-- and create an explosion there, making him the creator
createExplosion ( pX, pY, pZ, 6, source )
end
-- add this function as a handler for any player that spawns
addEventHandler ( "onPlayerSpawn", getRootElement(), explosionOnSpawn )
</syntaxhighlight>

'''Example 2:''' This example allows creation of claymore mines, which trigger and explode.
<syntaxhighlight lang="lua">function createClaymore ( creator )
local x, y, z = getElementPosition ( creator )
local claymoreObject = createObject ( 1945, x, y, z - 1, 0, 0, 90 ) --create an object which looks like a claymore
local claymoreCol = createColSphere ( x, y, z, 1 ) --create a collision sphere with radius 1
setElementData ( claymoreCol , "type", "claymore" ) --store the type of colshape so it can be retrieved
setElementData ( claymoreCol, "object", claymoreObject ) --store the object of the claymore
setElementData ( claymoreCol, "creatorPlayer", creator ) --store the person who created it
end

function claymoreHit ( player )
if getElementData ( source, "type" ) == "claymore" then --ensure its a claymore
--retrieve the object associated to the claymore, and who created it
local claymoreObject = getElementData ( source, "object" )
local claymoreCreator = getElementData ( source, "creatorPlayer" )
--get the position of the claymore
local x, y, z = getElementPosition ( source )
createExplosion ( x, y, z, 12, claymoreCreator ) --create an explosion, associated to the creator, of a small size at the col's position
--destroy the claymore object, and the col shape so it doesnt trigger again.
destroyElement ( claymoreObject )
destroyElement ( source )
end
end
addEventHandler ( "onColShapeHit", getRootElement(), claymoreHit )
</syntaxhighlight>
</section>
<section name="Client" class="client">
'''Example 3:''' This code will create an explosion for the local player when they spawn.
<syntaxhighlight lang="lua">function explosionOnSpawn ( )
-- get the spawned player's position
local pX, pY, pZ = getElementPosition ( source )
-- and create an explosion there, making him the creator
createExplosion ( pX, pY, pZ, 6, source )
end
-- add this function as a handler for any player that spawns
addEventHandler ( "onClientPlayerSpawn", getLocalPlayer(), explosionOnSpawn )
</syntaxhighlight>
</section>
==See Also==
{{Explosion functions}}

Client Scripting Events

2007-09-16T09:14:48Z

MrJax:

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

===Client Events===
void [[onClientResourceStart]] ( [[resource]] resource )

void [[onClientResourceStop]] ( [[resource]] resource )

void [[onClientElementDataChange]] ( string name )

void [[onClientPlayerJoin]] ( void )

void [[onClientPlayerQuit]] ( string reason )

void [[onClientPlayerWeaponFire]] ( int weapon, int ammo, int ammoInClip, float hitX, float hitY, float hitZ, [[element]] hitElement )

void [[onClientPlayerWeaponSwitch]] ( int previous, int current )

void [[onClientPlayerTarget]] ( [[element]] target )

void [[onClientPlayerDamage]] ( [[element]] attacker, int weapon, int bodypart )

void [[onClientPlayerSpawn]] ( [[team]] hisTeam )

void [[onClientPlayerWasted]] ( [[element]] attacker, int weapon, int bodypart )

void [[onClientPlayerVehicleEnter]] ( [[vehicle]] theVehicle, int seat )

void [[onClientPlayerVehicleExit]] ( [[vehicle]] theVehicle, int seat )

void [[onClientPlayerChangeNick]] ( string oldNick )

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

void [[onClientVehicleRespawn]] ( void )

void [[onClientVehicleEnter]] ( [[player]] thePlayer, int seat )

void [[onClientVehicleExit]] ( [[player]] thePlayer, int seat )

void [[onClientVehicleStartEnter]] ( [[player]] thePlayer, int seat )

void [[onClientVehicleStartExit]] ( [[player]] thePlayer, int seat )

void [[onClientTrailerAttach]] ( [[vehicle]] towedBy )

void [[onClientTrailerDetach]] ( [[vehicle]] towedBy )

void [[onClientGUIClicked]] ( [[element]] theElement )

void [[onClientGUIDoubleClicked]] ( [[element]] theElement )

void [[onClientGUIChanged]] ( [[element]] theElement )

void [[onClientGUIAccepted]] ( [[element]] theElement )

void [[onClientGUIClose]] ( [[element]] theElement )

void [[onClientGUIKeyDown]] ( [[element]] theElement )

void [[onClientConsole]] ( text )

void [[onClientRender]] ( )

void [[onClientClick]] ( string button, string state, int absoluteX, int absoluteY, float worldX, float worldY, float worldZ, [[element]] clicked )

void [[onClientDoubleClick]] ( string button, string state, float cursorX, float cursorY, float worldX, float worldY, float worldZ, [[element]] clicked )

void [[onClientMouseMove]] ( int absoluteX, int absoluteY )

void [[onClientCursorMove]] ( float cursorX, float cursorY, int absoluteX, int absoluteY, float worldX, float worldY, float worldZ )

void [[onClientGUIMove]] ()

void [[onClientGUISize]] ()

void [[onClientColShapeHit]] ( [[entity]] theEntity, bool matchingDimension )

void [[onClientColShapeLeave]] ( [[entity]] theEntity, bool matchingDimension )

void [[onClientElementColShapeHit]] ( [[colshape]] theShape, bool matchingDimension )

void [[onClientElementColShapeLeave]] ( [[colshape]] theShape, bool matchingDimension )

GetPlayerTask

2007-09-05T15:32:07Z

MrJax:

{{Client function}}
__NOTOC__
This function is used to get the name of the current task of a certain type for a player.

==Syntax==
<syntaxhighlight lang="lua">
string getPlayerTask ( player thePlayer, string priority, int taskType, [int index = 0] )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer''': The [[player]] whose task you want to retrieve.
*'''priority''': A string determining which set of tasks you want to retrieve it from. This must be either "primary" or "secondary".
*'''taskType''': An integer value representing the task type (or slot) you want to get the task from. Types can be:
**'''PRIMARY TASKS'''
***'''0:''' TASK_PHYSICAL_RESPONSE
***'''1:''' TASK_EVENT_RESPONSE_TEMP
***'''2:''' TASK_EVENT_RESPONSE_NONTEMP
***'''3:''' TASK_PRIMARY
***'''4:''' TASK_DEFAULT
**'''SECONDARY TASKS'''
***'''0:''' TASK_SECONDARY_ATTACK
***'''1:''' TASK_SECONDARY_DUCK
***'''2:''' TASK_SECONDARY_SAY
***'''3:''' TASK_SECONDARY_FACIAL_COMPLEX
***'''4:''' TASK_SECONDARY_PARTIAL_ANIM
***'''5:''' TASK_SECONDARY_IK

===Optional Arguments===
*'''index''': An integer value representing how many sub tasks to go through. -1 to get the simplest task, 0 to get the most complex task.

===Returns===
Returns a string containing the name of a task. See [[list of player tasks]] for valid strings. Returns ''false'' if invalid arguments are specified or if there is no task of the type or index specified.

==Example==
<section name="Client" class="client" show="true">
This example prints the name of a player's task to the chat when they use the "task" command in the console.
<syntaxhighlight lang="lua">
function myTask ( commandName, priority, taskType )
task = getPlayerTask ( source, priority, tonumber(taskType) )
taskName = "none"
if ( task ) then
taskName = task
end
outputChatBox ( getClientName ( source ) .. "'s " .. priority .. "(" .. taskType .. ") task is: " .. taskName )
end
addCommandHandler ( "task", myTask )
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

BindKey

2007-08-29T11:50:05Z

MrJax:

{{Server client function}}
__NOTOC__
Binds a player's key to a handler function, which will be called when the key is pressed. Keys that are bound to actual keyboard keys are displayed and can be modified by the user from the settings window.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">bindKey ( player thePlayer, string key, string keyState, function handlerFunction, [ var arguments, ... ] )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish to bind the key of.
*'''key:''' The key or control you wish to bind to the command. See [[key names]] for a list of possible keys and [[control names]] for a list of possible controls.
*'''keyState:''' A string that has one of the following values:
**'''"up":''' If the bound key should trigger the function when the key is released
**'''"down":''' If the bound key should trigger the function when the key is pressed
**'''"both":''' If the bound key should trigger the function when the key is pressed or released
*'''handlerFunction:''' The function that will be triggered when the player's key is pressed. This function should have the form:
:<syntaxhighlight lang="lua">function functionName ( source, key, keyState, [ var arguments, ... ] )</syntaxhighlight>
:The values passed to this function are:
:*'''source:''' The player who pressed the key
:*'''key:''' The key that was pressed
:*'''keyState:''' The state of the key that was pressed, ''down'' if it was pressed, ''up'' if it was released.
:*'''arguments''' The optional arguments you specified when calling [[bindKey]] (see below).
</section>

<section name="Client" class="client">
<syntaxhighlight lang="lua">bindKey ( string key, string keyState, string bindName, function handlerFunction, [ var arguments, ... ] ) </syntaxhighlight>

===Required Arguments===
*'''key:''' The key or control you wish to bind to the command. See [[key names]] for a list of possible keys and [[control names]] for a list of possible controls.
*'''keyState:''' A string that has one of the following values:
**'''"up":''' If the bound key should trigger the function when the key is released
**'''"down":''' If the bound key should trigger the function when the key is pressed
**'''"both":''' If the bound key should trigger the function when the key is pressed or released
*'''bindName:''' The name for this key bind when it appears in the client's settings dialog.
*'''handlerFunction:''' The function that will be triggered when the player's key is pressed. This function should have the form:
:<syntaxhighlight lang="lua">function functionName ( key, keyState, [ var arguments, ... ] )</syntaxhighlight>
:The values passed to this function are:
:*'''key:''' The key that was pressed
:*'''keyState:''' The state of the key that was pressed, ''down'' if it was pressed, ''up'' if it was released.
:*'''arguments''' The optional arguments you specified when calling [[bindKey]] (see below).
</section>

===Optional Arguments===
{{OptionalArg}}
*'''arguments:''' Any arguments you may want to pass to the function when the key is pressed by the user. Any number of arguments of can be specified, each being passed to the designated function.

==Example==
Example 1
<section name="Server" class="server" show="true">
This example will bind a player's 'F1' key and 'fire' control to 1 input function.
<syntaxhighlight lang="lua">
function funcInput ( source, key, keyState )
local state = "let go of"
if ( keyState == "down" ) then
state = "pressed"
end
outputChatBox ( getClientName ( source ) .. " " .. state .. " the " .. key .. " key!" )
end

function bindTheKeys ( source )
bindKey ( source, "F1", "down",, funcInput ) -- bind the player's F1 down key
bindKey ( source, "F1", "up", funcInput ) -- bind the player's F1 up key
bindKey ( source, "fire", "both", funcInput ) -- bind the player's fire down and up control
end
addCommandHandler ( "bindme", bindTheKeys )
</syntaxhighlight>
</section>

Example 2
<section name="Client" class="client" show="false">
This example will bind a player's 'F1' key and 'fire' control to 1 input function, clientside.
<syntaxhighlight lang="lua">
function funcInput ( key, keyState )
local state = "let go of"
if ( keyState == "down" ) then
state = "pressed"
end
outputChatBox ( "You " .. state .. " the " .. key .. " key!" )
end

function bindTheKeys ( source )
bindKey ( "F1", "down", funcInput ) -- bind the player's F1 down key
bindKey ( "F1", "up", funcInput ) -- bind the player's F1 up key
bindKey ( "fire", "both", funcInput ) -- bind the player's fire down and up control
end
addCommandHandler ( "bindme", bindTheKeys )
</syntaxhighlight>
</section>

==See Also==
{{Input functions}}

BindKey

2007-08-29T11:49:23Z

MrJax:

{{Server client function}}
__NOTOC__
Binds a player's key to a handler function, which will be called when the key is pressed. Keys that are bound to actual keyboard keys are displayed and can be modified by the user from the settings window.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">bindKey ( player thePlayer, string key, string keyState, function handlerFunction, [ var arguments, ... ] )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish to bind the key of.
*'''key:''' The key or control you wish to bind to the command. See [[key names]] for a list of possible keys and [[control names]] for a list of possible controls.
*'''keyState:''' A string that has one of the following values:
**'''"up":''' If the bound key should trigger the function when the key is released
**'''"down":''' If the bound key should trigger the function when the key is pressed
**'''"both":''' If the bound key should trigger the function when the key is pressed or released
*'''handlerFunction:''' The function that will be triggered when the player's key is pressed. This function should have the form:
:<syntaxhighlight lang="lua">function functionName ( source, key, keyState, [ var arguments, ... ] )</syntaxhighlight>
:The values passed to this function are:
:*'''source:''' The player who pressed the key
:*'''key:''' The key that was pressed
:*'''keyState:''' The state of the key that was pressed, ''down'' if it was pressed, ''up'' if it was released.
:*'''arguments''' The optional arguments you specified when calling [[bindKey]] (see below).
</section>

<section name="Client" class="client">
<syntaxhighlight lang="lua">bindKey ( string key, string keyState, string bindName, function handlerFunction, [ var arguments, ... ] ) </syntaxhighlight>

===Required Arguments===
*'''key:''' The key or control you wish to bind to the command. See [[key names]] for a list of possible keys and [[control names]] for a list of possible controls.
*'''keyState:''' A string that has one of the following values:
**'''"up":''' If the bound key should trigger the function when the key is released
**'''"down":''' If the bound key should trigger the function when the key is pressed
**'''"both":''' If the bound key should trigger the function when the key is pressed or released
*'''bindName:''' The name for this key bind when it appears in the client's settings dialog.
*'''handlerFunction:''' The function that will be triggered when the player's key is pressed. This function should have the form:
:<syntaxhighlight lang="lua">function functionName ( key, keyState, [ var arguments, ... ] )</syntaxhighlight>
:The values passed to this function are:
:*'''key:''' The key that was pressed
:*'''keyState:''' The state of the key that was pressed, ''down'' if it was pressed, ''up'' if it was released.
:*'''arguments''' The optional arguments you specified when calling [[bindKey]] (see below).
</section>

===Optional Arguments===
{{OptionalArg}}
*'''arguments:''' Any arguments you may want to pass to the function when the key is pressed by the user. Any number of arguments of can be specified, each being passed to the designated function.

==Example==
Example 1
<section name="Server" class="server" show="true">
This example will bind a player's 'F1' key and 'fire' control to 1 input function.
<syntaxhighlight lang="lua">
function funcInput ( source, key, keyState )
local state = "let go of"
if ( keyState == "down" ) then
state = "pressed"
end
outputChatBox ( getClientName ( source ) .. " " .. state .. " the " .. key .. " key!" )
end

function bindTheKeys ( source )
bindKey ( source, "F1", "down", "", funcInput ) -- bind the player's F1 down key
bindKey ( source, "F1", "up", "", funcInput ) -- bind the player's F1 up key
bindKey ( source, "fire", "both", "", funcInput ) -- bind the player's fire down and up control
end
addCommandHandler ( "bindme", bindTheKeys )
</syntaxhighlight>
</section>

Example 2
<section name="Client" class="client" show="false">
This example will bind a player's 'F1' key and 'fire' control to 1 input function, clientside.
<syntaxhighlight lang="lua">
function funcInput ( key, keyState )
local state = "let go of"
if ( keyState == "down" ) then
state = "pressed"
end
outputChatBox ( "You " .. state .. " the " .. key .. " key!" )
end

function bindTheKeys ( source )
bindKey ( "F1", "down", "", funcInput ) -- bind the player's F1 down key
bindKey ( "F1", "up", "", funcInput ) -- bind the player's F1 up key
bindKey ( "fire", "both", "", funcInput ) -- bind the player's fire down and up control
end
addCommandHandler ( "bindme", bindTheKeys )
</syntaxhighlight>
</section>

==See Also==
{{Input functions}}

Template:Player functions

2007-08-11T11:06:11Z

MrJax:

* [[addPlayerClothes]]
* [[canPlayerUseFunction]]
* [[doesPlayerHaveJetPack]]
* [[getPlayerArmor]]
* [[getPlayerClothes]]
* [[getPlayerCount]]
* [[getPlayerWeapon]]
* [[getPlayerWeaponSlot]]
* [[getPlayerAmmoInClip]]
* [[getPlayerTotalAmmo]]
* [[getPlayerFromNick]]
* [[getPlayerHealth]]
* [[getPlayerLevel]]
* [[getPlayerMoney]]
* [[getPlayerOccupiedVehicle]]
* [[getPlayerOccupiedVehicleSeat]]
* [[getPlayerPing]]
* [[getPlayerRotation]]
* [[getPlayerSkin]]
* [[getPlayerStat]]
* [[getPlayerTarget]]
* [[getPlayerTeam]]
* [[getRandomPlayer]]
* [[getPlayerWantedLevel]]
* [[givePlayerJetPack]]
* [[givePlayerMoney]]
* [[isPlayerDead]]
* [[isPlayerDucked]]
* [[isPlayerInVehicle]]
* [[isPlayerMuted]]
* [[isPlayerOnGround]]
* [[isPlayerInWater]]
* [[isPlayerMapForced]]
* [[getAlivePlayers]]
* [[getDeadPlayers]]
* [[getPlayerNametagText]]
* [[getPlayerNametagColor]]
* [[isPlayerNametagShowing]]
* [[getPlayerFightingStyle]]
* [[getPlayerGravity]]
* [[getPlayerBlurLevel]]
* [[getPlayerContactElement]]
* [[killPlayer]]
* [[removePlayerClothes]]
* [[removePlayerFromVehicle]]
* [[removePlayerJetPack]]
* [[setPlayerArmor]]
* [[setPlayerHealth]]
* [[setPlayerMoney]]
* [[setPlayerRotation]]
* [[setPlayerSkin]]
* [[setPlayerStat]]
* [[setPlayerWeaponSlot]]
* [[setPlayerWantedLevel]]
* [[showPlayerHudComponent]]
* [[spawnPlayer]]
* [[spawnPlayerAtSpawnpoint]]
* [[takePlayerMoney]]
* [[warpPlayerIntoVehicle]]
* [[forcePlayerMap]]
* [[setPlayerNametagText]]
* [[setPlayerNametagColor]]
* [[setPlayerNametagShowing]]
* [[setPlayerFightingStyle]]
* [[setPlayerGravity]]
* [[setPlayerBlurLevel]]

GetPlayerContactElement

2007-08-07T21:10:16Z

MrJax: New page: __NOTOC__ {{Client function}}  This function detects the vehicle a player is standi...

__NOTOC__
{{Client function}}

This function detects the vehicle a player is standing on.

==Syntax==

<syntaxhighlight lang="lua">
element getPlayerContactElement ( player thePlayer )
</syntaxhighlight>

===Required Arguments===

*'''thePlayer:''' The player you want to get the vehicle he is touching from.

===Returns===

Returns a [[vehicle]] if the player is touching one, ''false'' if he is touching none or is a invalid player.

==Example==

This example shows the name of the vehicle the player is standing on. It will output 'false' if he is not.

<syntaxhighlight lang="lua">
local vehicle = getPlayerContactVehicle ( getLocalPlayer() )
local name = getVehicleName(vehicle)
outputChatBox(tostring(name))
</syntaxhighlight>

==See Also==

{{Player functions}}

Template:Client player functions

2007-08-07T21:09:26Z

MrJax:

* [[doesPlayerHaveJetPack]]
* [[isPlayerDead]]
* [[isPlayerDoingTask]]
* [[isPlayerDucked]]
* [[isPlayerInVehicle]]
* [[isPlayerMuted]]
* [[isPlayerOnGround]]
* [[isPlayerUnderWater]]
* [[getLocalPlayer]]
* [[getPlayerAmmoInClip]]
* [[getPlayerArmor]]
* [[getPlayerHealth]]
* [[getPlayerName]]
* [[getPlayerOccupiedVehicle]]
* [[getPlayerPing]]
* [[getPlayerTarget]]
* [[getPlayerTargetStart]]
* [[getPlayerTargetEnd]]
* [[getPlayerTargetRange]]
* [[getPlayerTargetCollision]]
* [[getPlayerTeam]]
* [[getPlayerTotalAmmo]]
* [[getPlayerTask]]
* [[getPlayerSimplestTask]]
* [[getPlayerStat]]
* [[getPlayerWeaponSlot]]
* [[getPlayerWeapon]]
* [[getPlayerContactElement]]
* [[setPlayerWeaponSlot]]
* [[setPlayerSkin]]
* [[showPlayerHudComponent]]

ToggleAllControls

2007-08-06T08:43:25Z

MrJax:

__NOTOC__
Enables or disables the use of all GTA controls for a specified player.

==Syntax==
<syntaxhighlight lang="lua">bool toggleAllControls ( player thePlayer, bool enabled, [bool gtaContols=true, bool mtaControls=true] ) </syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish to toggle the control ability of.
*'''enable:''' A boolean value representing whether or not the controls will be usable or not.

==Example==
This function will disable the use of all controls in order to freeze a player, which will be used every time someone enters a vehicle.
<syntaxhighlight lang="lua">
function freezeThisDude ( thePlayer, time )
toggleAllControls ( thePlayer, false ) -- disable this players controls
setTimer ( "toggleAllControls", time, 1, thePlayer, true ) -- enable this players controls after the specified time
end

addEventHandler ( "onPlayerEnterVehicle", root, "onPlayerEnterVehicle" )
function onPlayerEnterVehicle ( theVehicle, seat, jacked )
freezeThisDude ( source, 5000 ) -- 'freeze' him for 5000ms/5secs
end
</syntaxhighlight>

==See Also==
{{Input functions}}

TextCreateTextItem

2007-08-04T16:18:25Z

MrJax:

__NOTOC__
This function creates a text item. A text item represents a single area of text, much like a label does in standard GUI programming. A text item can only be seen by players if it is added to a [[textdisplay]] using [[textDisplayAddText]]. Each text item can be added to multiple displays, if need be.

==Syntax==
<syntaxhighlight lang="lua">
textitem textCreateTextItem ( [string text, float x, float y, string priority, int red = 255, int green = 0, int blue = 0, int alpha = 255, float scale = 1, string alignX = "left", string alignY = "top"] )
</syntaxhighlight>

===Required Arguments===

''None.''

===Optional Arguments===
{{OptionalArg}}
* '''text''': A string of text you want to display
* '''x''': A floating point number between 0.0 and 1.0 indicating how far across the screen the text should be shown, as a percentage of the width, from the left hand side.
* '''y''': A floating point number between 0.0 and 1.0 indicating how far down the screen the text should be shown, as a percentage of the height, from the top.
* '''priority''': How important it is that this text should be up to date on client's screens. Valid values are: "low", "medium", "high" which are aliases for 0, 1 and 2 respectively.
* '''red''': A value between 0 and 255 indicating how red the text should be.
* '''green''': A value between 0 and 255 indicating how green the text should be.
* '''blue''': A value between 0 and 255 indicating how blue the text should be.
* '''alpha''': A value between 0 and 255 indicating how transparent the text should be, with 0 being fully transparent, and 255 being opaque.
* '''scale''': A floating point value indicating the scale of the text. The default is 1.0, which is around 12pt.
* '''alignX''': A string representing the X-alignment of the text. ("left", "center", "right")
* '''alignY''': A string representing the Y-alignment of the text. ("top", "center", "bottom")

===Returns===
Returns a [[textitem]] object.

==Example==
<syntaxhighlight lang="lua">
myDisplay = textCreateDisplay () --created display
textDisplayAddObserver ( myDisplay, myPlayer ) --made display visible to player
myTextItem = textCreateTextItem ( "Hello world!", 0.5, 0.5 ) --created item for the display
textDisplayAddText ( myDisplay, myTextItem ) --added created item for display to display
</syntaxhighlight>

==See Also==
{{Text functions}}

TextCreateTextItem

2007-08-04T16:11:12Z

MrJax:

__NOTOC__
This function creates a text item. A text item represents a single area of text, much like a label does in standard GUI programming. A text item can only be seen by players if it is added to a [[textdisplay]] using [[textDisplayAddText]]. Each text item can be added to multiple displays, if need be.

==Syntax==
<syntaxhighlight lang="lua">
textitem textCreateTextItem ( [string text, float x, float y, string priority, int red = 255, int green = 0, int blue = 0, int alpha = 255, float scale = 1, int alignX = 0, int alignY = 0] )
</syntaxhighlight>

===Required Arguments===

''None.''

===Optional Arguments===
{{OptionalArg}}
* '''text''': A string of text you want to display
* '''x''': A floating point number between 0.0 and 1.0 indicating how far across the screen the text should be shown, as a percentage of the width, from the left hand side.
* '''y''': A floating point number between 0.0 and 1.0 indicating how far down the screen the text should be shown, as a percentage of the height, from the top.
* '''priority''': How important it is that this text should be up to date on client's screens. Valid values are: "low", "medium", "high" which are aliases for 0, 1 and 2 respectively.
* '''red''': A value between 0 and 255 indicating how red the text should be.
* '''green''': A value between 0 and 255 indicating how green the text should be.
* '''blue''': A value between 0 and 255 indicating how blue the text should be.
* '''alpha''': A value between 0 and 255 indicating how transparent the text should be, with 0 being fully transparent, and 255 being opaque.
* '''scale''': A floating point value indicating the scale of the text. The default is 1.0, which is around 12pt.
* '''alignX''': An integer representing the X-alignment of the text. (0=LEFT,1=CENTER,2=RIGHT)
* '''alignY''': An integer representing the Y-alignment of the text. (0=TOP,1=CENTER,2=BOTTOM)

===Returns===
Returns a [[textitem]] object.

==Example==
<syntaxhighlight lang="lua">
myDisplay = textCreateDisplay () --created display
textDisplayAddObserver ( myDisplay, myPlayer ) --made display visible to player
myTextItem = textCreateTextItem ( "Hello world!", 0.5, 0.5 ) --created item for the display
textDisplayAddText ( myDisplay, myTextItem ) --added created item for display to display
</syntaxhighlight>

==See Also==
{{Text functions}}

SetPlayerBlurLevel

2007-08-04T12:19:54Z

MrJax:

==Syntax==
<syntaxhighlight lang="lua">
bool setPlayerBlurLevel ( player thePlayer, int level )
</syntaxhighlight>

GetPlayerBlurLevel

2007-08-04T12:19:44Z

MrJax:

==Syntax==
<syntaxhighlight lang="lua">
int getPlayerBlurLevel ( player thePlayer )
</syntaxhighlight>

Template:Player functions

2007-08-04T12:18:33Z

MrJax:

* [[addPlayerClothes]]
* [[canPlayerUseFunction]]
* [[doesPlayerHaveJetPack]]
* [[getPlayerArmor]]
* [[getPlayerClothes]]
* [[getPlayerCount]]
* [[getPlayerWeapon]]
* [[getPlayerWeaponSlot]]
* [[getPlayerAmmoInClip]]
* [[getPlayerTotalAmmo]]
* [[getPlayerFromNick]]
* [[getPlayerHealth]]
* [[getPlayerLevel]]
* [[getPlayerMoney]]
* [[getPlayerOccupiedVehicle]]
* [[getPlayerOccupiedVehicleSeat]]
* [[getPlayerPing]]
* [[getPlayerRotation]]
* [[getPlayerSkin]]
* [[getPlayerStat]]
* [[getPlayerTarget]]
* [[getPlayerTeam]]
* [[getRandomPlayer]]
* [[getPlayerWantedLevel]]
* [[givePlayerJetPack]]
* [[givePlayerMoney]]
* [[isPlayerDead]]
* [[isPlayerDucked]]
* [[isPlayerInVehicle]]
* [[isPlayerMuted]]
* [[isPlayerOnGround]]
* [[isPlayerInWater]]
* [[isPlayerMapForced]]
* [[getAlivePlayers]]
* [[getDeadPlayers]]
* [[getPlayerTask]]
* [[getPlayerSimplestTask]]
* [[isPlayerDoingTask]]
* [[getPlayerNametagText]]
* [[getPlayerNametagColor]]
* [[isPlayerNametagShowing]]
* [[getPlayerFightingStyle]]
* [[getPlayerGravity]]
* [[getPlayerBlurLevel]]
* [[killPlayer]]
* [[removePlayerClothes]]
* [[removePlayerFromVehicle]]
* [[removePlayerJetPack]]
* [[setPlayerArmor]]
* [[setPlayerHealth]]
* [[setPlayerMoney]]
* [[setPlayerRotation]]
* [[setPlayerSkin]]
* [[setPlayerStat]]
* [[setPlayerWeaponSlot]]
* [[setPlayerWantedLevel]]
* [[showPlayerHudComponent]]
* [[spawnPlayer]]
* [[spawnPlayerAtSpawnpoint]]
* [[takePlayerMoney]]
* [[warpPlayerIntoVehicle]]
* [[forcePlayerMap]]
* [[setPlayerNametagText]]
* [[setPlayerNametagColor]]
* [[setPlayerNametagShowing]]
* [[setPlayerFightingStyle]]
* [[setPlayerGravity]]
* [[setPlayerBlurLevel]]

CreateProjectile

2007-08-03T09:54:38Z

MrJax:

__NOTOC__
This creates a projectile of the specified type on the specified coords.

==Usage==
Client-side only.

==Syntax==
<syntaxhighlight lang="lua">
bool createProjectile ( element creator, int weapon, [ float posX, float posY, float posZ, float force = 1.0, element target = nil, float rotX, float rotY, float rotZ, float velX, float velY, float velZ ] )
</syntaxhighlight>

==Required Arguments==
*'''creator:''' The [[element]] representing creator of the projectile. In case you want the projectile to be synced for everybody creator must be [[getLocalPlayer]]().
*'''weapon:''' [[int]] representing the projectile weapon ID. Valid IDs are:
{{Projectiles}}

==Optional Arguments==
{{OptionalArg}}
*'''posX''','''posY''','''posZ''': [[float]] starting coordinates for the projectile. They are coordinates of creator by default.
*'''force''': [[float]] representing the starting force of the projectile.
*'''target''': [[element]] target used for heat seeking rockets.
*'''rotX''','''rotY''','''rotZ''': [[float]] starting rotation for the projectile.
*'''velX''','''velY''','''velZ''': [[float]] starting velocity for the projectile.

==Returns==
Returns ''true'' if projectile creation was succesfull. Returns ''false'' if unable to create a projectile (wrong weapon ID or projectiles limit was reached).

==Example==
This example makes a rocket minigun (minigun shooting with rockets).
<syntaxhighlight lang="lua">
-- This function gets triggered everytime player shoots.
function onClientPlayerWeaponFireFunc(weapon,ammo,ammoInClip,hitX,hitY,hitZ,hitElement)
if source == getLocalPlayer() and weapon == 38 then -- if source is a local player and he uses minigun...
if not createProjectile(getLocalPlayer(),19,getElementPosition(getLocalPlayer()),200) then -- then we either create a projectile...
outputChatBox ( "Rocket minigun overheated! Give it a rest pal!", source ) -- or if projectile limit is reached we output player a chat message
end
end
end
-- Don't forget to add the onClientPlayerWeaponFireFunc function as a handler for onClientPlayerWeaponFire.
addEventHandler("onClientPlayerWeaponFire",getRootElement(),onClientPlayerWeaponFireFunc)
</syntaxhighlight>

IsElementOnScreen

2007-07-24T18:27:33Z

MrJax:

==Syntax==
<syntaxhighlight lang="lua">
bool isElementOnScreen ( element theElement )
</syntaxhighlight>

Template:Client element functions

2007-07-24T18:26:32Z

MrJax:

*[[createElement]]
*[[destroyElement]]
*[[getElementBoundingBox]]
*[[getElementChild]]
*[[getElementChildren]]
*[[getElementChildrenCount]]
*[[getElementData]]
*[[getElementDimension]]
*[[getElementInterior]]
*[[getElementsByType]]
*[[getElementType]]
*[[getElementParent]]
*[[getElementPosition]]
*[[getElementRadius]]
*[[getElementVelocity]]
*[[getRootElement]]
*[[isElement]]
*[[isElementWithinColShape]]
*[[getElementsWithinColShape]]
*[[isElementAttached]]
*[[isElementOnScreen]]
*[[getElementAttachedTo]]
*[[getAttachedElements]]
*[[getElementDistanceFromCentreOfMassToBaseOfModel]]
*[[setElementData]]
*[[setElementDimension]]
*[[setElementInterior]]
*[[setElementPosition]]
*[[setElementVelocity]]
*[[attachElementToElement]]
*[[detachElementFromElement]]
*[[getElementByID]]

SetElementAlpha

2007-07-24T17:09:04Z

MrJax:

==Syntax==
<syntaxhighlight lang="lua">
bool setElementAlpha ( element theElement, int alpha )
</syntaxhighlight>

GetElementAlpha

2007-07-24T17:08:56Z

MrJax:

==Syntax==
<syntaxhighlight lang="lua">
int getElementAlpha ( element theElement )
</syntaxhighlight>

Template:Element functions

2007-07-24T17:07:44Z

MrJax:

*[[createElement]]
*[[destroyElement]]
*[[cloneElement]]
*[[isElement]]
*[[getElementByID]]
*[[getElementByIndex]]
*[[getElementChild]]
*[[getElementChildren]]
*[[getElementChildrenCount]]
*[[getElementData]]
*[[getElementID]]
*[[getElementParent]]
*[[getElementsByType]]
*[[getElementType]]
*[[getRootElement]]
*[[isElementVisibleTo]]
*[[isElementWithinColShape]]
*[[getElementsWithinColShape]]
*[[getElementPosition]]
*[[getElementVelocity]]
*[[getElementInterior]]
*[[getElementDimension]]
*[[getElementZoneName]]
*[[isElementAttached]]
*[[getElementAttachedTo]]
*[[getAttachedElements]]
*[[getElementColShape]]
*[[getElementAlpha]]
*[[setElementData]]
*[[setElementID]]
*[[setElementParent]]
*[[setElementVisibleTo]]
*[[clearElementVisibleTo]]
*[[setElementPosition]]
*[[setElementVelocity]]
*[[setElementInterior]]
*[[setElementDimension]]
*[[attachElementToElement]]
*[[detachElementFromElement]]
*[[setElementAlpha]]

Template:Vehicle functions

2007-07-23T12:13:21Z

MrJax:

*[[blowVehicle]]
*[[createVehicle]]
*[[fixVehicle]]
*[[respawnVehicle]]

*[[getVehicleColor]]
*[[getVehicleHealth]]
*[[getVehicleID]]
*[[getVehicleIDFromName]]
*[[getVehicleMaxPassengers]]
*[[getVehicleName]]
*[[getVehicleOccupant]]
*[[getVehicleController]]
*[[getVehicleRotation]]
*[[getVehicleTurnVelocity]]
*[[getVehicleTurretPosition]]
*[[getVehiclesOfType]]
*[[getVehicleUpgradeOnSlot]]
*[[getVehicleUpgrades]]
*[[getVehicleUpgradeSlotName]]
*[[getVehicleCompatibleUpgrades]]
*[[getVehicleDoorState]]
*[[getVehicleWheelStates]]
*[[getVehicleLightState]]
*[[getVehicleOverrideLights]]
*[[getVehicleTowedByVehicle]]
*[[getVehicleTowingVehicle]]
*[[getVehiclePaintjob]]
*[[getVehicleSirensOn]]
*[[getVehicleLandingGearDown]]

*[[isVehicleFrozen]]
*[[isVehicleLocked]]
*[[isVehicleFuelTankExplodable]]

*[[setVehicleColor]]
*[[setVehicleFrozen]]
*[[setVehicleHealth]]
*[[setVehicleLocked]]
*[[setVehicleDoorsUndamageable]]
*[[setVehicleRotation]]
*[[setVehicleTurnSpeed]]
*[[addVehicleUpgrade]]
*[[removeVehicleUpgrade]]
*[[setVehicleDoorState]]
*[[setVehicleWheelStates]]
*[[setVehicleLightState]]
*[[toggleVehicleRespawn]]
*[[setVehicleOverrideLights]]
*[[attachTrailerToVehicle]]
*[[detachTrailerFromVehicle]]
*[[setVehiclePaintjob]]
*[[setVehicleEngineState]]
*[[setVehicleFuelTankExplodable]]
*[[setVehicleSirensOn]]
*[[setVehicleLandingGearDown]]
*[[setVehicleMaxPassengers]]
*[[setVehicleDamageProof]]

SetVehicleDamageProof

2007-07-23T12:13:03Z

MrJax:

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleDamageProof ( vehicle theVehicle, bool damageProof )
</syntaxhighlight>

UnbanIP

2007-07-22T11:34:03Z

MrJax:

__NOTOC__
This function will unban the specified IP.

==Syntax==
<syntaxhighlight lang="lua">
bool unbanIP ( string ipToUnban, [player unbanningPlayer = null] )
</syntaxhighlight>

===Required Arguments===
*'''unbanningPlayer:''' The who is unbanning the ip
*'''ipToUnban:''' The IP that should be unbanned

===Optional Arguments===
{{OptionalArg}}
(none)

===Returns===
Returns ''true'' if the unban was successful, ''false'' otherwise.

==Example==

==See Also==
{{Admin_functions}}

SetMarkerType

2007-07-22T09:06:50Z

MrJax:

__NOTOC__
This function changes a marker's type.

==Syntax==
server:
<syntaxhighlight lang="lua">bool setMarkerType ( marker theMarker, string markerType )</syntaxhighlight>
client:
<syntaxhighlight lang="lua">marker setMarkerType ( marker theMarker, string markerType )</syntaxhighlight>

===Required Arguments===
* '''theMarker''': A [[marker]] element referencing the specified marker.
* '''markerType''': A string denoting the marker type. Valid values are:
{{Marker types}}

==Returns==
Returns ''true'' if the marker type was changed, ''false'' if it wasn't or marker values were invalid.

==Example==
This function changes all existing markers' type to the specified one.
<syntaxhighlight lang="lua">
function changeAllMarkersType ( newMarkerType )
-- we store a table with all markers
local allMarkers = getElementsByType( "marker" )
-- for each marker in it,
for index, aMarker in ipairs(allMarkers) do
-- set its type to the one passed to this function
setMarkerType( aMarker, newMarkerType )
end
end
</syntaxhighlight>

==See Also==
{{Marker functions}}

SpawnPlayer

2007-07-21T12:00:29Z

MrJax:

__NOTOC__
This function spawns the player at an arbitary point on the map.

==Syntax==
<syntaxhighlight lang="lua">
bool spawnPlayer ( player thePlayer, float x, float y, float z, [ int rotation = 0, int skinID = 0, int interior = 0, int dimension = 0, team theTeam = nil ] )
</syntaxhighlight>

===Required Arguments===
*'''x:''' The x co-ordinate to spawn the player at
*'''y:''' The y co-ordinate to spawn the player at
*'''z:''' The z co-ordinate to spawn the player at
*'''rotation:''' rotation of the player on spawn
*'''skinID:''' players skin on spawn

===Optional Arguments===
*'''interior:''' interior the player will spawn into
*'''dimension:''' The ID of the [[dimension]] that the player should be in
*'''theTeam:''' the team the player will join

===Returns===
Returns ''true'' if the player was spawned successfully, ''false'' otherwise.

==Example==
This example spawns all the players in the map at the first spawnpoint there is.
<syntaxhighlight lang="lua">
-- Get a table of all the players
players = getElementsByType ( "player" )
-- Go through every player
for playerKey, playerValue in ipairs(players) do
-- Spawn them at the desired coordinates
spawnPlayer ( playerValue, 0.0, 0.0, 0.0, 90.0, 7 )
end
</syntaxhighlight>

==See Also==
{{Player_functions}}

Template:Client element functions

2007-06-09T00:07:20Z

MrJax:

*[[createElement]]
*[[destroyElement]]
*[[getElementBoundingBox]]
*[[getElementChild]]
*[[getElementChildren]]
*[[getElementChildrenCount]]
*[[getElementData]]
*[[getElementDimension]]
*[[getElementInterior]]
*[[getElementsByType]]
*[[getElementType]]
*[[getElementParent]]
*[[getElementPosition]]
*[[getElementRadius]]
*[[getElementVelocity]]
*[[getRootElement]]
*[[isElement]]
*[[isElementWithinColShape]]
*[[getElementsWithinColShape]]
*[[isElementAttached]]
*[[getElementAttachedTo]]
*[[getAttachedElements]]
*[[getElementDistanceFromCentreOfMassToBaseOfModel]]
*[[setElementData]]
*[[setElementDimension]]
*[[setElementInterior]]
*[[setElementPosition]]
*[[setElementVelocity]]
*[[attachElementToElement]]
*[[detachElementFromElement]]

CreateProjectile

2007-06-09T00:03:12Z

MrJax:

==Syntax==
<syntaxhighlight lang="lua">
bool createProjectile ( element creator, int weapon, [ float x = x, float y = y, float z = z, float force = 1.0, element target = nil ] )
</syntaxhighlight>

CreateProjectile

2007-06-09T00:02:47Z

MrJax:

==Syntax==
<syntaxhighlight lang="lua">
bool createProjectile ( element creator, int weapon, [ float x=x, float y=y, float z=z, float force=1.0, element target=nil ] )
</syntaxhighlight>

CreateProjectile

2007-06-09T00:02:02Z

MrJax:

==Syntax==
<syntaxhighlight lang="lua">
bool createProjectile ( element creator, int weapon, [ float x, float y, float z, float force, element target ] )
</syntaxhighlight>

SetWaveHeight

2007-06-09T00:01:27Z

MrJax:

==Syntax==
<syntaxhighlight lang="lua">
bool setWaveHeight ( float height )
</syntaxhighlight>

GetWaveHeight

2007-06-09T00:01:16Z

MrJax:

==Syntax==
<syntaxhighlight lang="lua">
float getWaveHeight ( void )
</syntaxhighlight>

GetWorldFromScreenPosition

2007-06-09T00:01:03Z

MrJax:

==Syntax==
<syntaxhighlight lang="lua">
float float float getWorldFromScreenPosition ( float x, float y )
</syntaxhighlight>

GetScreenFromWorldPosition

2007-06-09T00:00:44Z

MrJax:

==Syntax==
<syntaxhighlight lang="lua">
float float getScreenFromWorldPosition ( float x, float y, float z )
</syntaxhighlight>

Template:Client world functions

2007-06-09T00:00:06Z

MrJax:

*[[getGameSpeed]]
*[[getGravity]]
*[[getGroundPosition]]
*[[getScreenFromWorldPosition]]
*[[getTime]]
*[[getWaterLevel]]
*[[getWeather]]
*[[getWorldFromScreenPosition]]
*[[getZoneName]]
*[[isLineOfSightClear]]
*[[processLineOfSight]]
*[[getWaveHeight]]

*[[setGameSpeed]]
*[[setGravity]]
*[[setSkyGradient]]
*[[setTime]]
*[[setWeather]]
*[[setWeatherBlended]]
*[[resetSkyGradient]]
*[[testLineAgainstWater]]
*[[setWaveHeight]]

CreateProjectile

2007-06-08T23:59:12Z

MrJax:

==Syntax==
<syntaxhighlight lang="lua">
bool createProjectile ( element creator, int weapon, float x, float y, float z, float force, element target )
</syntaxhighlight>

Template:Client projectile functions

2007-06-08T23:59:01Z

MrJax:

*[[createProjectile]]

ShowChat

2007-06-08T23:58:43Z

MrJax:

==Syntax==
<syntaxhighlight lang="lua">
bool showChat ( bool show )
</syntaxhighlight>

GetElementDistanceFromCentreOfMassToBaseOfModel

2007-06-08T23:58:29Z

MrJax:

==Syntax==
<syntaxhighlight lang="lua">
float getElementDistanceFromCentreOfMassToBaseOfModel ( element theElement )
</syntaxhighlight>

Template:Client projectile functions

2007-06-08T23:57:18Z

MrJax:

==Syntax==
<syntaxhighlight lang="lua">
bool createProjectile ( element creator, int weapon, float x, float y, float z, float force, element target )
</syntaxhighlight>

Client Scripting Functions

2007-06-08T23:53:46Z

MrJax:

This page lists all the '''client-side''' 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]]
__TOC__
'''Please check all the client side functions work and mark them on this page - [[Temp_Log]], the list on that page should be upto date with newly added functions copied from the server with the same syntax.'''

==Audio functions==
{{Client_audio_functions}}

==Blip functions==
{{Client_blip_functions}}

==Camera functions==
{{Client_camera_functions}}

==Collision shape functions==
{{Client_collision_shape_functions}}

==Element functions==
{{Client_element_functions}}

==Event functions==
{{Client_event_functions}}

==Explosion functions==
{{Client_explosion_functions}}

==GUI functions==
{{GUI_functions}}

==Input functions==
{{Client_input_functions}}

==Marker functions==
{{Client_marker_functions}}

==Object functions==
{{Client_object_functions}}

==Output functions==
{{Client_output_functions}}

==Pickup functions==
{{Client_pickup_functions}}

==Player functions==
{{Client_player_functions}}

==Projectile functions==
{{Client_projectile_functions}}

==Radar-area functions==
{{Client_radar-area_functions}}

==Resource functions==
{{Client_resource_functions}}

==Team functions==
{{Client_team_functions}}

==Utility functions==
{{Client_utility_functions}}

==Vehicle functions==
{{Client_vehicle_functions}}

==Weapon functions==
{{Client_weapon_functions}}

==World functions==
{{Client_world_functions}}

==XML functions==
{{Client_xml_functions}}

Template:Client output functions

2007-06-08T21:09:29Z

MrJax:

* [[outputChatBox]]
* [[outputConsole]]
* [[showChat]]

Template:Client world functions

2007-06-08T18:40:46Z

MrJax:

*[[getGameSpeed]]
*[[getGravity]]
*[[getGroundPosition]]
*[[getScreenFromWorldPosition]]
*[[getTime]]
*[[getWaterLevel]]
*[[getWeather]]
*[[getWorldFromScreenPosition]]
*[[getZoneName]]
*[[getWaveHeight]]
*[[isLineOfSightClear]]
*[[processLineOfSight]]
*[[getWaveHeight]]

*[[setGameSpeed]]
*[[setGravity]]
*[[setSkyGradient]]
*[[setTime]]
*[[setWeather]]
*[[setWeatherBlended]]
*[[resetSkyGradient]]
*[[testLineAgainstWater]]
*[[setWaveHeight]]

Template:World functions

2007-06-08T18:40:12Z

MrJax:

*[[getGameSpeed]]
*[[getGravity]]
*[[getTime]]
*[[getWeather]]
*[[getZoneName]]
*[[getWaveHeight]]

*[[setGameSpeed]]
*[[setGravity]]
*[[setTime]]
*[[setWeather]]
*[[setWeatherBlended]]
*[[setWaveHeight]]

OnClientPlayerWeaponSwitch

2007-06-06T20:41:33Z

MrJax:

[[Category:Incomplete Event]]

__NOTOC__
This event is blahblah and is used for blahblah.

==Syntax==
<syntaxhighlight lang="lua">
void onClientPlayerWeaponSwitch ( int previous, int current )
</syntaxhighlight>

==Example==
This example does...
<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

Client Scripting Events

2007-06-06T20:40:47Z

MrJax:

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

===Client Events===
void [[onClientResourceStart]] ( [[resource]] resource )

void [[onClientResourceStop]] ( [[resource]] resource )

void [[onClientElementDataChange]] ( string name )

void [[onClientPlayerJoin]] ( void )

void [[onClientPlayerQuit]] ( string reason )

void [[onClientPlayerWeaponFire]] ( int weapon, int ammo, int ammoInClip, float hitX, float hitY, float hitZ, [[element]] hitElement )

void [[onClientPlayerWeaponSwitch]] ( int previous, int current )

void [[onClientPlayerTarget]] ( [[element]] target )

void [[onClientPlayerDamage]] ( [[element]] attacker, int weapon, int bodypart )

void [[onClientPlayerSpawn]] ( [[team]] hisTeam )

void [[onClientPlayerWasted]] ( [[element]] attacker, int weapon, int bodypart )

void [[onClientPlayerVehicleEnter]] ( [[vehicle]] theVehicle, int seat )

void [[onClientPlayerVehicleExit]] ( [[vehicle]] theVehicle, int seat )

void [[onClientPlayerChangeNick]] ( string oldNick )

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

void [[onClientVehicleRespawn]] ( void )

void [[onClientVehicleEnter]] ( [[player]] thePlayer, int seat )

void [[onClientVehicleExit]] ( [[player]] thePlayer, int seat )

void [[onClientVehicleStartEnter]] ( [[player]] thePlayer, int seat )

void [[onClientVehicleStartExit]] ( [[player]] thePlayer, int seat )

void [[onClientTrailerAttach]] ( [[vehicle]] towedBy )

void [[onClientTrailerDetach]] ( [[vehicle]] towedBy )

void [[onClientGUIClicked]] ( [[element]] theElement )

void [[onClientGUIDoubleClicked]] ( [[element]] theElement )

void [[onClientGUIChanged]] ( [[element]] theElement )

void [[onClientGUIAccepted]] ( [[element]] theElement )

void [[onClientGUIClose]] ( [[element]] theElement )

void [[onClientGUIKeyDown]] ( [[element]] theElement )

void [[onClientConsole]] ( text )

void [[onClientRender]] ( )

void [[onClientClick]] ( string button, string state, float cursorX, float cursorY, float worldX, float worldY, float worldZ, [[element]] clicked )

void [[onClientCursorMove]] ( float cursorX, float cursorY, int absoluteX, int absoluteY, float worldX, float worldY, float worldZ )

void [[onClientColShapeHit]] ( [[entity]] theEntity, bool matchingDimension )

void [[onClientColShapeLeave]] ( [[entity]] theEntity, bool matchingDimension )

void [[onClientElementColShapeHit]] ( [[colshape]] theShape, bool matchingDimension )

void [[onClientElementColShapeLeave]] ( [[colshape]] theShape, bool matchingDimension )

Template:Client player functions

2007-06-06T20:34:56Z

MrJax:

* [[doesPlayerHaveJetPack]]
* [[isPlayerDead]]
* [[isPlayerDoingTask]]
* [[isPlayerDucked]]
* [[isPlayerInVehicle]]
* [[isPlayerMuted]]
* [[isPlayerOnGround]]
* [[isPlayerUnderWater]]
* [[getLocalPlayer]]
* [[getPlayerAmmoInClip]]
* [[getPlayerArmor]]
* [[getPlayerHealth]]
* [[getPlayerName]]
* [[getPlayerOccupiedVehicle]]
* [[getPlayerPing]]
* [[getPlayerTarget]]
* [[getPlayerTargetStart]]
* [[getPlayerTargetEnd]]
* [[getPlayerTargetRange]]
* [[getPlayerTargetCollision]]
* [[getPlayerTeam]]
* [[getPlayerTotalAmmo]]
* [[getPlayerTask]]
* [[getPlayerSimplestTask]]
* [[getPlayerStat]]
* [[getPlayerWeaponSlot]]
* [[getPlayerWeapon]]
* [[getPlayerContactVehicle]]
* [[setPlayerWeaponSlot]]
* [[setPlayerSkin]]
* [[showPlayerHudComponent]]

Server Scripting Events

2007-06-06T17:27:21Z

MrJax:

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 [[onMarkerLeave]] ( [[player]] leftplayer, bool matchingDimension )

void [[onPickupSpawn]] ()

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

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

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

void [[onPlayerChat]] ( string message, int type )

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

void [[onPlayerJoin]] ()

void [[onPlayerQuit]] ( string reason )

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

void [[onPlayerWasted]] ( int ammo, [[element]] 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 [[onPlayerMarkerLeave]] ( [[marker]] leftmarker, bool matchingDimension )

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

void [[onPlayerPickupLeave]] ( [[pickup]] leftpickup, bool matchingDimension )

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

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

void [[onResourceStart]] ( [[resource]] resource )

void [[onResourceStop]] ( [[resource]] resource )

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]] ()

OnClientClick

2007-06-06T16:40:14Z

MrJax:

[[Category:Incomplete Event]]

__NOTOC__
This event is blahblah and is used for blahblah.

==Syntax==
<syntaxhighlight lang="lua">
void onClientClick ( string button, string state, cursorX, cursorY, worldX, worldY, worldZ, element clickedWorld, element clickedGUI )
</syntaxhighlight>

==Example==
This example does...
<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

Template:Client player functions

2007-06-01T09:06:01Z

MrJax:

* [[doesPlayerHaveJetPack]]
* [[isPlayerDead]]
* [[isPlayerDoingTask]]
* [[isPlayerDucked]]
* [[isPlayerInVehicle]]
* [[isPlayerMuted]]
* [[isPlayerOnGround]]
* [[isPlayerUnderWater]]
* [[getLocalPlayer]]
* [[getPlayerAmmoInClip]]
* [[getPlayerArmor]]
* [[getPlayerHealth]]
* [[getPlayerName]]
* [[getPlayerOccupiedVehicle]]
* [[getPlayerPing]]
* [[getPlayerTarget]]
* [[getPlayerTargetStart]]
* [[getPlayerTargetEnd]]
* [[getPlayerTargetRange]]
* [[getPlayerTargetCollision]]
* [[getPlayerTeam]]
* [[getPlayerTotalAmmo]]
* [[getPlayerTask]]
* [[getPlayerSimplestTask]]
* [[getPlayerStat]]
* [[getPlayerWeaponSlot]]
* [[getPlayerContactVehicle]]
* [[setPlayerWeaponSlot]]
* [[setPlayerSkin]]
* [[showPlayerHudComponent]]

Template:Client input functions

2007-05-31T20:57:06Z

MrJax:

*[[bindKey]]
*[[unbindKey]]
*[[getKeyState]]
*[[getControlState]]
*[[isControlEnabled]]
*[[setControlState]]
*[[toggleControl]]
*[[toggleAllControls]]
*[[getCursorPosition]]
*[[addCommandHandler]]
*[[removeCommandHandler]]
*[[executeCommandHandler]]