Multi Theft Auto: Wiki - User contributions [en]

OnClientKey

2013-04-28T10:50:58Z

Bass:

{{Client event}}
__NOTOC__
This event triggers whenever the user presses a button on their keyboard.
This event can also be used to see if the client scrolls his mousewheel.

==Parameters==
<syntaxhighlight lang="lua">string button, bool pressOrRelease
</syntaxhighlight>
* '''button''': This refers the button pressed.
* '''pressOrRelease''': This refers to whether they were pressing or releasing the key, true when pressing, false when releasing.
==Source==
The [[event system#Event source|source]] of this event is the client's [[root element]].

==Example==
This example will say in chatbox every time the user presses down a a key.
<syntaxhighlight lang="lua">
function playerPressedKey(button, press)
if (press) then -- Only output when they press it down
outputChatBox("You pressed the "..button.." key!")
end
end
addEventHandler("onClientKey", root, playerPressedKey)
</syntaxhighlight>

This example outputs if the client moves his mousewheel.
<syntaxhighlight lang="lua">
addEventHandler( "onClientKey", root, function(button,press)
-- Since mouse_wheel_up and mouse_wheel_down cant return a release, we dont have to check the press.
if button == "mouse_wheel_up" or button == "mouse_wheel_down" then
outputDebugString( button .. " moved." )
return true
end
return false
end )
</syntaxhighlight>

==See Also==
===GUI events===
{{GUI_events}}
===Client event functions===
{{Client_event_functions}}

IsControlEnabled

2013-04-01T19:54:06Z

Bass:

{{Server client function}}
__NOTOC__
Checks whether a GTA control is enabled or disabled for a certain player.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool isControlEnabled ( player thePlayer, string control )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish the control status of.
*'''control:''' The control you wish to check. See [[control names]] for a list of possible controls.
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">bool isControlEnabled ( string control ) </syntaxhighlight>

===Required Arguments===
*'''control:''' The control you wish to check. See [[control names]] for a list of possible controls.
</section>

===Returns===
Returns ''true'' if control is enabled, ''false'' otherwise.

==Example==
<section name="Example 1" class="server" show="true">
This example uses a command handler to allow a player to toggle whether he can use vehicle weapons by disabling or enabling the primary and secondary vehicle fire keys. The command handler is trigged with 'toggleweapons'
<syntaxhighlight lang="lua">function changeWeaponControls ( player, commandName )
--Check to see if the player can use primary/secondary vehicle fire controls
primaryWeaponControl = isControlEnabled ( player, "vehicle_fire" )
secondaryWeaponControl = isControlEnabled ( player, "vehicle_secondary_fire" )
--Toggle the use of the primary vehicle fire control ability.
if ( primaryWeaponControl == true ) then
toggleControl ( player, "vehicle_fire", false )
outputChatBox ( "Disabled your ability to use primary vehicle weapons." )
else
toggleControl ( player, "vehicle_fire", true )
outputChatBox ( "Enabled your ability to use primary vehicle weapons." )
end
--Toggle the use of the secondar vehicle fire control ability.
if ( secondaryWeaponControl == true ) then
toggleControl ( player, "vehicle_secondary_fire", false )
outputChatBox ( "Disabled your ability to use secondary vehicle weapons." )
else
toggleControl ( player, "vehicle_secondary_fire", true )
outputChatBox ( "Enabled your ability to use secondary vehicle weapons." )
end
end
addCommandHandler ( "toggleweapons", changeWeaponControls )</syntaxhighlight>
</section>

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

String.split

2013-01-11T22:00:44Z

Bass:

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function splits a string into a table. There is no separator in this function, so all characters will be split no matter what.<br/>
If you are looking for a function to split a string from a separator, you should look at [[split]].

==Syntax==
<syntaxhighlight lang="lua">table string.split( string str )</syntaxhighlight>

===Required Arguments===
* '''str''': The string to split.

===Returns===
Returns a table containing the pieces of the split string.

==Code==
<section name="Server- and/or clientside Script" class="both" show="true">
<syntaxhighlight lang="lua">
function string.split(str)

if not str or type(str) ~= "string" then return false end

local splitStr = {}
for i=1,string.len(str) do
local char = str:sub( i, i )
table.insert( splitStr , char )
end

return splitStr
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example splits the string "test string" into a table.
<syntaxhighlight lang="lua">
local splitStr = string.split( "test string" )
outputDebugString( splitStr[1] ) -- >> "t"
outputDebugString( splitStr[2] ) -- >> "e"
outputDebugString( splitStr[3] ) -- >> "s"
outputDebugString( splitStr[4] ) -- >> "t"
</syntaxhighlight>
</section>

Author: Wafamde

==See Also==
{{Useful_Functions}}

String.split

2013-01-07T17:01:10Z

Bass: Created page with "{{Useful Function}} <lowercasetitle></lowercasetitle> __NOTOC__ This function splits a string into a table. There is no separator in this function, so all characters will be spli..."

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function splits a string into a table. There is no separator in this function, so all characters will be split no matter what.<br/>
If you are looking for a function to split a string from a separator, you should look at [[split]].

==Syntax==
<syntaxhighlight lang="lua">table string.split( string str )</syntaxhighlight>

===Required Arguments===
* '''str''': The string to split.

===Returns===
Returns a table containing the pieces of the split string.

==Code==
{{RequiredFunctions|Check}}
<section name="Server- and/or clientside Script" class="both" show="true">
<syntaxhighlight lang="lua">
function string.split(str)

if not str or type(str) ~= "string" then return false end

local splitStr = {}
for i=1,string.len(str) do
local char = str:sub( i, i )
table.insert( splitStr , char )
end

return splitStr
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example splits the string "test string" into a table.
<syntaxhighlight lang="lua">
local splitStr = string.split( "test string" )
outputDebugString( splitStr[1] ) -- >> "t"
outputDebugString( splitStr[2] ) -- >> "e"
outputDebugString( splitStr[3] ) -- >> "s"
outputDebugString( splitStr[4] ) -- >> "t"
</syntaxhighlight>
</section>

Author: Wafamde

==See Also==
{{Useful_Functions}}

Talk:Math.neg

2013-01-02T00:30:51Z

Bass:

How is this necessary at all when if you want to make a number negative you do "-variable" you don't need a strange function.<br/>
.. What he said ^

Talk:Math.neg

2013-01-02T00:30:37Z

Bass:

How is this necessary at all when if you want to make a number negative you do "-variable" you don't need a strange function.
.. What he said ^

GuiEditSetCaretIndex

2012-12-24T21:23:14Z

Bass:

__NOTOC__
{{Client function}}
This function sets the current position of the caret (the text cursor) within the edit box.

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

===Required Arguments===
*'''theElement:''' The edit box to be changed.
*'''index:''' An integer referring to the desired position within the box.

===Returns===
Returns ''true'' if the index was successfully set, ''false'' otherwise.

==Example==
This example makes the text cursor jump to the end of an edit box if the user is holding the Left Control button.
<syntaxhighlight lang="lua">
function moveToEndOnClick()
if ( getKeyState ( "lctrl" ) == true ) and ( getElementType(source) == "gui-edit" ) then -- if the user is holding down left control
local text = guiGetText ( source )
local textLength = string.len ( text )
guiEditSetCaretIndex ( source, textLength ) -- set the caret index. No need to check if the clicked control is actually an edit box as this function won't work on other controls anyway
end
end
addEventHandler ( "onClientGUIClick", getRootElement(), moveToEndOnClick ) -- add an event handler for clicks
</syntaxhighlight>

==See Also==
{{GUI_functions}}

SetPedOxygenLevel

2012-11-25T16:49:29Z

Bass: /* Required Arguments */

__NOTOC__
{{Client function}}
This function allows you to set the oxygen level of a [[ped]].

==Syntax==
<syntaxhighlight lang="lua">bool setPedOxygenLevel ( ped thePed, float oxygen )</syntaxhighlight>

===Required Arguments===
*'''thePed''': the [[ped]] whose oxygen level you want to modify.
*'''oxygen''': the amount of oxygen you want to set on the ped. Native values are from 0 to 1000 (At the maximum value of UNDERWATER_STAMINA full oxygen level is 2500. Higher values do not appear in the HUD).

===Returns===
Returns ''true'' if the oxygen level was changed succesfully. Returns ''false'' if an invalid ped and/or oxygen level was specified.

==Example==
<section name="Client" class="client" show="true">
This example fills the local player's oxygen.
<syntaxhighlight lang="lua">
function fillOxygen ( command )
local maxOxygen = getPedStat ( localPlayer, 225 ) * 1.502 + 1750
setPedOxygenLevel ( localPlayer, maxOxygen )
end
addCommandHandler ( "filloxygen", fillOxygen )
</syntaxhighlight>
</section>

==See Also==
{{Client_ped_functions}}

DxDrawImage

2012-11-10T13:44:20Z

Bass:

__NOTOC__
{{Client function}}

Draws an image on the screen for a single frame. In order for the image to stay visible continuously, you need to call this function with the same parameters on each frame update (see [[onClientRender]]).<br/>
Image files should ideally have dimensions that are a power of two, to prevent possible blurring.<br/>
<b>Power of two: 2px, 4px, 8px, 16px, 32px, 64px, 128px, 256px, 512px, 1024px...</b>

==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawImage ( float posX, float posY, float width, float height, mixed image [, float rotation = 0, float rotationCenterOffsetX = 0,
float rotationCenterOffsetY = 0, int color = white, bool postGUI = false ] )
</syntaxhighlight>

===Required Arguments===
*'''posX:''' the absolute X coordinate of the top left corner of the image
*'''posY:''' the absolute Y coordinate of the top left corner of the image
*'''width:''' the absolute width of the image
*'''height:''' the absolute height of the image
*'''image:''' Either a [[material]] element or a [[filepath]] of the image which is going to be drawn. (.dds images are also supported). Image files should ideally have dimensions that are a power of two, to prevent possible blurring.

===Optional Arguments===
*'''rotation:''' the rotation, in degrees for the image.
*'''rotationCenterOffsetX:''' the absolute X offset from the image center for which to rotate the image from.
*'''rotationCenterOffsetY:''' the absolute Y offset from the image center for which to rotate the image from.
*'''color:''' Tints the image with a value produced by [[tocolor]] or hexadecimal number in format: 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
*'''postgui :''' A bool representing whether the image should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

===Returns===
Returns ''true'' if successful, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
Example of a pendulum swinging from the top of the screen, made using dxDrawImage.
<syntaxhighlight lang="lua">
local screenWidth,screenHeight = guiGetScreenSize() -- Get screen resolution.

function renderDisplay ( )
local seconds = getTickCount() / 1000
local angle = math.sin(seconds) * 80
-- This will draw the graphic file 'arrow.png' at the top middle of the screen
-- using the size of 100 pixels wide, and 240 pixels high.
-- The center of rotation is at the top of the image.
dxDrawImage ( screenWidth/2 - 50, 0, 100, 240, 'arrow.png', angle, 0, -120 )
end

function HandleTheRendering ( )
addEventHandler("onClientRender", getRootElement(), renderDisplay) -- Keep everything visible with onClientRender.
end
addEventHandler("onClientResourceStart",resourceRoot, HandleTheRendering)
</syntaxhighlight>
</section>

==See Also==
{{Drawing_functions}}

SetElementID

2012-07-13T20:34:18Z

Bass:

{{Server client function}}
__NOTOC__
This function sets the ID of an element to a string. This can be anything from an identifying number, to a name.
You can only change the ID of an element clientside if that element has been created clientside as well.
==Syntax==
<syntaxhighlight lang="lua">
bool setElementID ( element theElement, string name )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The [[element]] you want to set the ID of.
*'''name:''' The new ID for theElement.

===Returns===
This returns ''true'' if successful. It will return ''false'' if '''theElement''' is invalid, or does not exist, or if '''name''' is invalid, or is not a string.

==Example==
<syntaxhighlight lang="lua">
local players = getElementsByType( "player" )

for i=1,#players do
setElementID( players[i], "player" .. i ) -- Change element IDs to 'player1', 'players2', 'players3'...
outputDebugString( "Player[" .. i .. "] = " .. getElementID( players[i] ) ) -- Output all the new element IDs
end

-- Could also be --

for i=1,#players do
setElementID( players[i], getPlayerName( players[i] ) ) -- Change the element ID to the players name.
outputDebugString( "Player[" .. i .. "] = " .. getElementID( players[i] ) )
end
</syntaxhighlight>

==See Also==
{{element_functions}}

[[Category:Needs Example]]

SetElementID

2012-07-13T20:17:00Z

Bass: /* Example */

{{Server client function}}
__NOTOC__
This function sets the ID of an element to a string. This can be anything from an identifying number, to a name.

==Syntax==
<syntaxhighlight lang="lua">
bool setElementID ( element theElement, string name )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The [[element]] you want to set the ID of.
*'''name:''' The new ID for theElement.

===Returns===
This returns ''true'' if successful. It will return ''false'' if '''theElement''' is invalid, or does not exist, or if '''name''' is invalid, or is not a string.

==Example==
<syntaxhighlight lang="lua">
local players = getElementsByType( "player" )

for i=1,#players do
setElementID( players[i], "player" .. i ) -- Change element IDs to 'player1', 'players2', 'players3'...
outputDebugString( "Player[" .. i .. "] = " .. getElementID( players[i] ) ) -- Output all the new element IDs
end

-- Could also be --

for i=1,#players do
setElementID( players[i], getPlayerName( players[i] ) ) -- Change the element ID to the players name.
outputDebugString( "Player[" .. i .. "] = " .. getElementID( players[i] ) )
end
</syntaxhighlight>

==See Also==
{{element_functions}}

[[Category:Needs Example]]

SetElementID

2012-07-13T19:58:12Z

Bass: /* Example */

{{Server client function}}
__NOTOC__
This function sets the ID of an element to a string. This can be anything from an identifying number, to a name.

==Syntax==
<syntaxhighlight lang="lua">
bool setElementID ( element theElement, string name )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The [[element]] you want to set the ID of.
*'''name:''' The new ID for theElement.

===Returns===
This returns ''true'' if successful. It will return ''false'' if '''theElement''' is invalid, or does not exist, or if '''name''' is invalid, or is not a string.

==Example==
<syntaxhighlight lang="lua">
local players = getElementsByType( "player" )

for i=1,#players do
setElementID( players[i], "player" .. tostring(i) ) -- Change element IDs to 'player1', 'players2', 'players3'...
outputDebugString( "Player[" .. i .. "] = " .. getElementID( players[i] ) ) -- Output all the new element IDs
end

-- Could also be --

for i=1,#players do
setElementID( players[i], getPlayerName( players[i] ) ) -- Change the element ID to the players name.
outputDebugString( "Player[" .. i .. "] = " .. getElementID( players[i] ) )
end
</syntaxhighlight>

==See Also==
{{element_functions}}

[[Category:Needs Example]]

SetElementID

2012-07-13T19:52:21Z

Bass: /* Example */

{{Server client function}}
__NOTOC__
This function sets the ID of an element to a string. This can be anything from an identifying number, to a name.

==Syntax==
<syntaxhighlight lang="lua">
bool setElementID ( element theElement, string name )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The [[element]] you want to set the ID of.
*'''name:''' The new ID for theElement.

===Returns===
This returns ''true'' if successful. It will return ''false'' if '''theElement''' is invalid, or does not exist, or if '''name''' is invalid, or is not a string.

==Example==
<syntaxhighlight lang="lua">
local players = getElementsByType( "player" ) -- Get a table of all players.

for i=1,#players do
setElementID( players[i], "player" .. tostring(i) ) -- Loop the table and change the element IDs to 'player1', 'player2', 'player3'...
outputDebugString( "Player[" .. i .. "] = " .. getElementID( players[i] ) ) -- Output the new element IDs to debugstring.
end
</syntaxhighlight>

==See Also==
{{element_functions}}

[[Category:Needs Example]]

SetElementID

2012-07-13T19:45:37Z

Bass: /* Example */

{{Server client function}}
__NOTOC__
This function sets the ID of an element to a string. This can be anything from an identifying number, to a name.

==Syntax==
<syntaxhighlight lang="lua">
bool setElementID ( element theElement, string name )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The [[element]] you want to set the ID of.
*'''name:''' The new ID for theElement.

===Returns===
This returns ''true'' if successful. It will return ''false'' if '''theElement''' is invalid, or does not exist, or if '''name''' is invalid, or is not a string.

==Example==
<syntaxhighlight lang="lua">
local players = getElementsByType( "player" ) -- Get a table of all players.

for i=1,#players do
setElementID( players[i], "player" .. tostring(i) ) -- Loop the table and change the element IDs to 'player1', 'player2', 'player3'...
end
-- COULD ALSO BE --
for i=1,#players do
setElementID( players[i], getPlayerName( players[i] ) -- This will change the element ID to the players name.
end

for i=1,#players do
outputDebugString( "Player[" .. i .. "] = " .. getElementID( players[i] ) ) -- Output the new element IDs to debugstring.
end
</syntaxhighlight>

==See Also==
{{element_functions}}

[[Category:Needs Example]]

GetElementCollisionsEnabled

2012-07-13T19:07:32Z

Bass:

{{Server client function}}
__NOTOC__
This function indicates if a specific element is set to have collisions disabled. An element without collisions does not interact with the physical environment and remains static.

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

===Required Arguments===
*'''theElement:''' The element for which you want to check whether collisions are enabled

===Returns===
Returns ''true'' if the collisions are enabled, ''false'' otherwise.

==Example==
This example check if there are any players with collisions disabled.
<syntaxhighlight lang="lua">
for _,player in ipairs( getElementsByType( "player" ) ) do
if not getElementCollisionsEnabled( player ) then -- If we get a false return from the function, we know that the collisions are disabled.
outputConsole( "Player " .. getPlayerName( player ) .. " has collisions disabled." )
end
end
</syntaxhighlight>

==See Also==
{{Element functions}}

User:Bass

2012-07-13T18:43:47Z

Bass: Created page with "Its just me... Wafamde."

Its just me... Wafamde.

Template:Engine functions

2012-07-13T18:40:14Z

Bass:

* [[engineImportTXD]]
* [[engineLoadCOL]]
* [[engineLoadDFF]]
* [[engineLoadTXD]]
* [[engineReplaceCOL]]
* [[engineReplaceModel]]
* [[engineRestoreCOL]]
* [[engineRestoreModel]]
* [[engineSetAsynchronousLoading]]
* [[engineSetModelLODDistance]]
* [[engineApplyShaderToWorldTexture]]
* [[engineRemoveShaderFromWorldTexture]]
* [[engineGetModelNameFromID]]
* [[engineGetModelIDFromName]]
* [[engineGetVisibleTextureNames]]
* [[engineGetModelTextureNames]]
<noinclude>[[Category:Functions templates]]</noinclude>

EngineGetModelTextureNames

2012-07-13T18:39:19Z

Bass: Created page with "{{Client function}} __NOTOC__ This function returns a table of the world textures which are applied to the specified model. ==Syntax== <syntaxhighlight lang="lua"> table engineGetModelTexture..."

{{Client function}}
__NOTOC__
This function returns a table of the world textures which are applied to the specified model.

==Syntax==
<syntaxhighlight lang="lua">
table engineGetModelTextureNames( string modelId = "" )
</syntaxhighlight>

===Required Arguments===
*'''modelId :''' You can either use the model id or the model name.

===Returns===
Returns a table if this function succeeds, false if it fails for some reason.

==Example==
This example will output the texture names applied to the Comet.
<syntaxhighlight lang="lua">
for _,name in ipairs( engineGetModelTextureNames( "480" ) ) do
outputConsole( name )
end
</syntaxhighlight>

The model name can also be used.
<syntaxhighlight lang="lua">
for _,name in ipairs( engineGetModelTextureNames( "Comet" ) ) do
outputConsole( name )
end
</syntaxhighlight>

==See Also==
{{Engine_functions}}
{{Drawing_functions}}

Template talk:Engine functions

2012-07-11T15:26:30Z

Bass: Created page with "Should engineGetModelTextureNames be added? If so. I wont mind doing it."

Should engineGetModelTextureNames be added? If so. I wont mind doing it.

Template:Engine functions

2012-07-11T15:26:11Z

Bass:

* [[engineImportTXD]]
* [[engineLoadCOL]]
* [[engineLoadDFF]]
* [[engineLoadTXD]]
* [[engineReplaceCOL]]
* [[engineReplaceModel]]
* [[engineRestoreCOL]]
* [[engineRestoreModel]]
* [[engineSetAsynchronousLoading]]
* [[engineSetModelLODDistance]]
* [[engineApplyShaderToWorldTexture]]
* [[engineRemoveShaderFromWorldTexture]]
* [[engineGetModelNameFromID]]
* [[engineGetModelIDFromName]]
* [[engineGetVisibleTextureNames]]
<noinclude>[[Category:Functions templates]]</noinclude>

Template:Engine functions

2012-07-11T15:25:40Z

Bass:

OnPlayerChangeNick

2012-04-12T07:10:13Z

Bass: /* Cancel effect */

{{Server event}}
__NOTOC__
This event is triggered when a player changes his nickname.

==Parameters==
<syntaxhighlight lang="lua">
string oldNick, string newNick
</syntaxhighlight>
*'''oldNick:''' the nickname the player had before.
*'''newNick:''' the new nickname of the player.

==Source==
The source of this event is the player that changed his nick

==Cancel effect==
Cancelling this event depends on how it is called, if it is called by the scripting event then it is NOT cancelable. If it is called from the /nick command it IS cancelable. If this event is cancelled and can be cancelled then the name will not change.

==Example==
<syntaxhighlight lang="lua">
function nickChangeHandler(oldNick, newNick)
-- check if there's account with newNick as username
if getAccount(newNick) then
outputChatBox("Sorry, there already exists an account with your new nickname as username.", source, 0, 255, 0)
outputChatBox("Please choose another one.", source, 0, 255, 0)
-- cancel the event to prevent the nick from being changed
cancelEvent()
end
end
-- add an event handler
addEventHandler("onPlayerChangeNick", getRootElement(), nickChangeHandler)
</syntaxhighlight>

This example displays a message to everyone every time player changed his nick
<syntaxhighlight lang="lua">
function nickChangeHandler(oldNick, newNick)
outputChatBox(oldNick.." is now known as "..newNick, getRootElement(), 255, 100, 100) -- display the message
end
addEventHandler("onPlayerChangeNick", getRootElement(), nickChangeHandler) -- add an event handler
</syntaxhighlight>
{{See also/Server event|Player events}}

GetPedMoveState

2012-04-11T13:54:34Z

Bass: /* Example */

{{Client function}}
This function returns the current move state for the specified [[ped]].

==Syntax==
<syntaxhighlight lang="lua">
string getPedMoveState ( ped thePed )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The [[ped]] whose move state you want to know

===Returns===
Returns a [[string]] indicating the ped's move state, or ''false'' if the ped is not streamed in, the movement type is unknown, the ped is in a vehicle or the ped is invalid.

{{Ped move states}}

==Example==
<section show="true">
'''Example 1:''' This example shows how you can output a players current movestate.
<syntaxhighlight lang="lua">
function getMoveState( command, playerName )
-- If the player name exists we will have our 'player'
local player = getPlayerFromName( playerName )

-- If the player does not exist, the script will stop.
if not player then
outputChatBox( "No player named " .. playerName .. " was found.", 250, 0, 0, true )
return false
end

-- If we found the player from the name, we can get his movestate.
local moveState = getPedMoveState( player )
-- If a player and a movestate is found, the script will output it to the chatbox.
outputChatBox( playerName .. "'s current moveState is: " .. moveState, 0, 150, 0, true )
end
addCommandHandler( "getMoveState", getMoveState ) -- To execute this command, simply write: /getMoveState playerName
</syntaxhighlight></section>

==See Also==
{{Ped functions}}

GetPedMoveState

2012-01-09T14:36:17Z

Bass: /* Example */

{{Client function}}
This function returns the current move state for the specified [[ped]].

==Syntax==
<syntaxhighlight lang="lua">
string getPedMoveState ( ped thePed )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The [[ped]] whose move state you want to know

===Returns===
Returns a [[string]] indicating the ped's move state, or ''false'' if the ped is not streamed in, the movement type is unknown, the ped is in a vehicle or the ped is invalid.

{{Ped move states}}

==Example==
<section show="true">
'''Example 1:''' This example shows how you can output a players current movestate.
<syntaxhighlight lang="lua">
function getMoveState( command, playerName )
-- If the player name exists we will have out 'player'
local player = getPlayerFromName( playerName )

-- If the player does not exist, the script will stop.
if not player then
outputChatBox( "No player named " .. playerName .. " was found.", 250, 0, 0, true )
return false
end

-- If we found the player from the name, we can get his movestate.
local moveState = getPedMoveState( player )
-- If a player and a movestate is found, the script will output it to the chatbox.
outputChatBox( playerName .. "'s current moveState is: " .. moveState, 0, 150, 0, true )
end
addCommandHandler( "getMoveState", getMoveState ) -- To execute this command, simply write: /getMoveState playerName
</syntaxhighlight></section>

==See Also==
{{Ped functions}}

GetPedMoveState

2012-01-09T11:21:54Z

Bass: /* Example */

{{Client function}}
This function returns the current move state for the specified [[ped]].

==Syntax==
<syntaxhighlight lang="lua">
string getPedMoveState ( ped thePed )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The [[ped]] whose move state you want to know

===Returns===
Returns a [[string]] indicating the ped's move state, or ''false'' if the ped is not streamed in, the movement type is unknown, the ped is in a vehicle or the ped is invalid.

{{Ped move states}}

==Example==
<section show="true">
'''Example 1:''' This example shows how you can output a players current movestate.
<syntaxhighlight lang="lua">
function getMoveState( command, playerName )
-- If the player name exists we will have out 'player'
local player = getPlayerFromName( playerName )

-- If the player does not exist, the script will stop.
if not player then
outputChatBox( "No player named " .. playerName .. " was found.", 250, 0, 0, true )
return false
end

-- If we found the player from the name, we can get his movestate.
local moveState = getPedMoveState( player )
-- If a player and a movestate is found, the script will output it to the chatbox.
outputChatBox( playerName .. "'s current moveState is: " .. moveState, 0, 150, 0, true )
end
addCommandHandler( "getMoveState", getMoveState) -- To execute this command, simply write: /getMoveState playerName
</syntaxhighlight></section>

==See Also==
{{Ped functions}}

GetPedMoveState

2012-01-09T11:21:34Z

Bass: /* Example */

{{Client function}}
This function returns the current move state for the specified [[ped]].

==Syntax==
<syntaxhighlight lang="lua">
string getPedMoveState ( ped thePed )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The [[ped]] whose move state you want to know

===Returns===
Returns a [[string]] indicating the ped's move state, or ''false'' if the ped is not streamed in, the movement type is unknown, the ped is in a vehicle or the ped is invalid.

{{Ped move states}}

==Example==
<section name="Client" show="true">
'''Example 1:''' This example shows how you can output a players current movestate.
<syntaxhighlight lang="lua">
function getMoveState( command, playerName )
-- If the player name exists we will have out 'player'
local player = getPlayerFromName( playerName )

-- If the player does not exist, the script will stop.
if not player then
outputChatBox( "No player named " .. playerName .. " was found.", 250, 0, 0, true )
return false
end

-- If we found the player from the name, we can get his movestate.
local moveState = getPedMoveState( player )
-- If a player and a movestate is found, the script will output it to the chatbox.
outputChatBox( playerName .. "'s current moveState is: " .. moveState, 0, 150, 0, true )
end
addCommandHandler( "getMoveState", getMoveState) -- To execute this command, simply write: /getMoveState playerName
</syntaxhighlight></section>

==See Also==
{{Ped functions}}

GetPedMoveState

2012-01-09T11:19:15Z

Bass:

{{Client function}}
This function returns the current move state for the specified [[ped]].

==Syntax==
<syntaxhighlight lang="lua">
string getPedMoveState ( ped thePed )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The [[ped]] whose move state you want to know

===Returns===
Returns a [[string]] indicating the ped's move state, or ''false'' if the ped is not streamed in, the movement type is unknown, the ped is in a vehicle or the ped is invalid.

{{Ped move states}}

==Example==
<section name="Client" class="client" show="true">
'''Example 1:''' This example shows how you can output a players current movestate.
<syntaxhighlight lang="lua">
function getMoveState( command, playerName )
-- If the player name exists we will have out 'player'
local player = getPlayerFromName( playerName )

-- If the player does not exist, the script will stop.
if not player then
outputChatBox( "No player named " .. playerName .. " was found.", 250, 0, 0, true )
return false
end

-- If we found the player from the name, we can get his movestate.
local moveState = getPedMoveState( player )
-- If a player and a movestate is found, the script will output it to the chatbox.
outputChatBox( playerName .. "'s current moveState is: " .. moveState, 0, 150, 0, true )
end
addCommandHandler( "getMoveState", getMoveState) -- To execute this command, simply write: /getMoveState playerName
</syntaxhighlight></section>

==See Also==
{{Ped functions}}

GetPedMoveState

2012-01-09T11:17:58Z

Bass: /* Example */

{{Client function}}
{{Needs Example}}
__NOTOC__
This function returns the current move state for the specified [[ped]].

==Syntax==
<syntaxhighlight lang="lua">
string getPedMoveState ( ped thePed )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The [[ped]] whose move state you want to know

===Returns===
Returns a [[string]] indicating the ped's move state, or ''false'' if the ped is not streamed in, the movement type is unknown, the ped is in a vehicle or the ped is invalid.

{{Ped move states}}

==Example==
<section name="Client" class="client" show="true">
'''Example 1:''' This example shows how you can output a players current movestate.
<syntaxhighlight lang="lua">
function getMoveState( command, playerName )
-- If the player name exists we will have out 'player'
local player = getPlayerFromName( playerName )

-- If the player does not exist, the script will stop.
if not player then
outputChatBox( "No player named " .. playerName .. " was found.", 250, 0, 0, true )
return false
end

-- If we found the player from the name, we can get his movestate.
local moveState = getPedMoveState( player )
-- If a player and a movestate is found, the script will output it to the chatbox.
outputChatBox( playerName .. "'s current moveState is: " .. moveState, 0, 150, 0, true )
end
addCommandHandler( "getMoveState", getMoveState) -- To execute this command, simply write: /getMoveState playerName
</syntaxhighlight></section>

==See Also==
{{Ped functions}}

GetPedMoveState

2012-01-09T11:17:03Z

Bass: /* Example */

Talk:GetPedMoveState

2012-01-09T11:00:13Z

Bass: Created page with "'''getPedMoveState should be removed from Server Functions as that function is Clientside ONLY.'''"

'''getPedMoveState should be removed from Server Functions as that function is Clientside ONLY.'''

Talk:Server Scripting Functions

2012-01-09T10:59:57Z

Bass:

Added links for remaining functions. [[User:Vandalite|Vandalite]] 13:20, 23 March 2006 (CST)<br>

Talk:Server Scripting Functions

2012-01-06T06:36:37Z

Bass:

Added links for remaining functions. [[User:Vandalite|Vandalite]] 13:20, 23 March 2006 (CST)<br>
'''getPedMoveState should be removed from Server Functions as that function is Clientside ONLY.'''

DxCreateTexture

2011-08-28T11:11:36Z

Bass: /* Example */

{{Client function}}
__NOTOC__
{{New feature|3.0110|1.1|
Only available in 1.1
}}
This function creates a [[texture]] element that can be used in the dxDraw functions
==Syntax==
<syntaxhighlight lang="lua">
element dxCreateTexture ( string filepath )
</syntaxhighlight>

===Required Arguments===
*'''filepath:''' The filepath of the image. (.dds images are also supported). Image files should ideally have dimensions that are a power of two, to prevent possible blurring.

===Returns===
Returns a [[texture]] if successful, ''false'' if invalid arguments were passed to the function.

==Example==
<syntaxhighlight lang="lua">
local root = getRootElement()

addEventHandler( "onClientRender", root,
function()
if myImage then
dxDrawImage( 100, 350, 300, 350, myImage )
end
end
)

-- Use 'toggle' command to switch image on and off
addCommandHandler( "toggle",
function()
if not myImage then
myImage = dxCreateTexture( "moonpig.png" ) -- Create texture
else
destroyElement( myImage ) -- Destroy texture
myImage = nil
end
end
)
</syntaxhighlight>

==See Also==
{{Drawing_functions}}

DxCreateTexture

2011-08-28T11:08:29Z

Bass: /* Example */

{{Client function}}
__NOTOC__
{{New feature|3.0110|1.1|
Only available in 1.1
}}
This function creates a [[texture]] element that can be used in the dxDraw functions
==Syntax==
<syntaxhighlight lang="lua">
element dxCreateTexture ( string filepath )
</syntaxhighlight>

===Required Arguments===
*'''filepath:''' The filepath of the image. (.dds images are also supported). Image files should ideally have dimensions that are a power of two, to prevent possible blurring.

===Returns===
Returns a [[texture]] if successful, ''false'' if invalid arguments were passed to the function.

==Example==
<syntaxhighlight lang="lua">
root = getRootElement()

addEventHandler( "onClientRender", root,
function()
if myImage then
dxDrawImage( 100, 350, 300, 350, myImage )
end
end
)

-- Use 'toggle' command to switch image on and off
addCommandHandler( "toggle",
function()
if not myImage then
myImage = dxCreateTexture( "moonpig.png" ) -- Create texture
else
destroyElement( myImage ) -- Destroy texture
myImage = nil
end
end
)
</syntaxhighlight>

==See Also==
{{Drawing_functions}}