BindKey

2007-09-10T13:58:41Z

Bosss: /* Example */

{{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}}

IsRadarAreaFlashing

2007-08-30T05:33:17Z

Bosss: /* Example */

{{Server function}}
__NOTOC__
This function allows detection of whether a radar area is flashing or not.

==Syntax==
<syntaxhighlight lang="lua">
bool isRadarAreaFlashing ( radararea theRadararea )
</syntaxhighlight>

===Required Arguments===
*'''theRadararea:''' The radar area you wish to check the state of flashing

===Returns===
Returns ''true'' if the radar area is flashing, ''false'' if it is not or if it doesn't exist.

==Example==
This example checks whether the radar area in the variable ''glenpark'' is flashing, and announces it if it is.
<syntaxhighlight lang="lua">
function checkArea(sourcePlayer)
if ( isRadarAreaFlashing ( glenpark ) ) then -- if the radar area in the variable glenpark is flashing
outputChatBox ( "Glen Park is under attack!!!" ) -- announce it
end
end
addCommandHandler("checkArea", checkArea)
</syntaxhighlight>

==See Also==
{{Radar area functions}}

PreloadMissionAudio

2007-07-07T18:10:00Z

Bosss:

__NOTOC__
This function preloads a game sound into a specific sound slot. The sound can then be played with [[PlayMissionAudio]].

==Usage==
Both server-side and client-side. "thePlayer" argument isn't used in client-side version of this function.

==Syntax==
<syntaxhighlight lang="lua">
bool preloadMissionAudio ( player thePlayer, int sound, int slot )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer''': the [[player]] you want to play the sound for.
*'''sound''': the [[int]] sound id to play (interpreted as unsigned short). Valid values are those from the '''data/AudioEvents.txt''' file.
*'''slot''': [[int]] sound slot in which you preloaded the sound.

===Returns===
Returns ''true'' if the sound was successfully preloaded, ''false'' otherwise.

==Example==
See [[PlayMissionAudio]].

==See Also==
{{Audio_functions}}

Template:Projectiles

2007-07-07T13:15:31Z

Bosss:

** '''16:''' Grenade
** '''17:''' Tear Gas Grenade
** '''18:''' Molotov
** '''19:''' Rocket (simple)
** '''20:''' Rocket (heat seeking)
** '''21:''' Air Bomb

Multi Theft Auto: Wiki - User contributions [en]

BindKey

IsRadarAreaFlashing

PreloadMissionAudio

Template:Projectiles