Multi Theft Auto: Wiki - User contributions [en]

GetCursorMoveOn

2012-04-30T20:32:44Z

Ronwolf1705:

{{Useful Function}}
This function checks in which way the cursor is currently moving.
==Syntax==
<syntaxhighlight lang="lua">string getCursorMoveOn( )</syntaxhighlight>

===Returns===
Returns left,right,up or down.

==Code==
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function getCursorMoveOn()
if ( isCursorShowing() ) then
left = "left"
right = "right"
up = "up"
down = "down"
zero = "nil"
if getElementData(localPlayer,"movew") == right then
return right
elseif getElementData(localPlayer,"movew") == left then
return left
elseif getElementData(localPlayer,"movew") == up then
return up
elseif getElementData(localPlayer,"movew") == down then
return down
elseif getElementData(localPlayer,"movew") == zero then
return false
end
end
end

function executeMoveOn(cursorX,cursorY)
if ( isCursorShowing() ) then
setElementData(localPlayer,"moveX",cursorX)
setElementData(localPlayer,"moveY",cursorY)
if cursorX > cX then
setElementData(localPlayer,"movew",right)
elseif cursorX < cX then
setElementData(localPlayer,"movew",left)
elseif cursorY > cY then
setElementData(localPlayer,"movew",down)
elseif cursorY < cY then
setElementData(localPlayer,"movew",up)
end
end
end
addEventHandler("onClientCursorMove",root,executeMoveOn)

setTimer(
function()
if ( isCursorShowing() ) then
local curX = getElementData(localPlayer,"moveX")
local curY = getElementData(localPlayer,"moveY")
if cursorX == cX then
setElementData(localPlayer,"movew",zero)
elseif cursorY == cY then
setElementData(localPlayer,"movew",zero)
end
end
end
,50,0)

function previousM()
if ( isCursorShowing() ) then
cX = getElementData(localPlayer,"moveX")
cY = getElementData(localPlayer,"moveY")
end
end
setTimer(previousM,50,0)
</syntaxhighlight>
</section>

==Example==
<section name="Client-side example" class="client" show="true">
This clientside example checks in which way cursor is currently moving.
<syntaxhighlight lang="lua">
bindKey ("m", "down",
function()
showCursor( not isCursorShowing() )
end
)

addEventHandler("onClientCursorMove",root,
function()
if ( isCursorShowing() ) then
moveOn = getCursorMoveOn()
outputChatBox("cursor is moving on : " .. moveOn, localPlayer)
end
end
)
</syntaxhighlight>
</section>

By '''ronwolf1705'''.

==See Also==
{{Useful_Functions}}

GetCursorMoveOn

2012-04-30T20:32:21Z

Ronwolf1705: Created page with "{{Useful Function}} This function checks in which way the cursor is currently moving. ==Syntax== <syntaxhighlight lang="lua">string getCursorMoveOn( )</syntaxhighlight> ===Returns=== Returns left,right,u..."

{{Useful Function}}
This function checks in which way the cursor is currently moving.
==Syntax==
<syntaxhighlight lang="lua">string getCursorMoveOn( )</syntaxhighlight>

===Returns===
Returns left,right,up or down.

==Code==
{{RequiredFunctions|findRotation}}
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function getCursorMoveOn()
if ( isCursorShowing() ) then
left = "left"
right = "right"
up = "up"
down = "down"
zero = "nil"
if getElementData(localPlayer,"movew") == right then
return right
elseif getElementData(localPlayer,"movew") == left then
return left
elseif getElementData(localPlayer,"movew") == up then
return up
elseif getElementData(localPlayer,"movew") == down then
return down
elseif getElementData(localPlayer,"movew") == zero then
return false
end
end
end

function executeMoveOn(cursorX,cursorY)
if ( isCursorShowing() ) then
setElementData(localPlayer,"moveX",cursorX)
setElementData(localPlayer,"moveY",cursorY)
if cursorX > cX then
setElementData(localPlayer,"movew",right)
elseif cursorX < cX then
setElementData(localPlayer,"movew",left)
elseif cursorY > cY then
setElementData(localPlayer,"movew",down)
elseif cursorY < cY then
setElementData(localPlayer,"movew",up)
end
end
end
addEventHandler("onClientCursorMove",root,executeMoveOn)

setTimer(
function()
if ( isCursorShowing() ) then
local curX = getElementData(localPlayer,"moveX")
local curY = getElementData(localPlayer,"moveY")
if cursorX == cX then
setElementData(localPlayer,"movew",zero)
elseif cursorY == cY then
setElementData(localPlayer,"movew",zero)
end
end
end
,50,0)

function previousM()
if ( isCursorShowing() ) then
cX = getElementData(localPlayer,"moveX")
cY = getElementData(localPlayer,"moveY")
end
end
setTimer(previousM,50,0)
</syntaxhighlight>
</section>

==Example==
<section name="Client-side example" class="client" show="true">
This clientside example checks in which way cursor is currently moving.
<syntaxhighlight lang="lua">
bindKey ("m", "down",
function()
showCursor( not isCursorShowing() )
end
)

addEventHandler("onClientCursorMove",root,
function()
if ( isCursorShowing() ) then
moveOn = getCursorMoveOn()
outputChatBox("cursor is moving on : " .. moveOn, localPlayer)
end
end
)
</syntaxhighlight>
</section>

By '''ronwolf1705'''.

==See Also==
{{Useful_Functions}}

Template:Useful Functions

2012-04-30T20:21:06Z

Ronwolf1705:

*[[callClientFunction]] » This function allows you to call any clientside function from the server's side.

*[[callServerFunction]] » This function allows you to call any server-side function from the client's side.

*[[centerWindow]] » This function center the window in any resolution.

*[[Check]] » This function checks if it's arguments are of the right types and calls the error-function if one isn't.

*[[coroutine.resume]] » Fix for hidden coroutine error messages

*[[doForAllElements]] » This function can be used to execute a specified function for all elements of a specified type.

*[[dxDrawColorText]] » This function draws a dx text with #RRGGBB color codes support.

*[[findRotation]] » Takes two points and returns the direction from point A to point B.

*[[FormatDate]] » Formats a date on the basis of a format string and returns it.

*[[getAge]] » This function calculates the age of a birthday.

*[[getAlivePlayersInTeam]] » This function returns a table of the alive players in a team.

*[[getCursorMoveOn]] » This function checks in which way the cursor is currently moving.

*[[getElementSpeed]] » This function allows you to get element speed in kph or mph units.

*[[getPedGoTo]] » This function allows you to get the position set by setPedGoTo.

*[[getPlayerFromNamePart]] » This function allows you to get player From his Name part.

*[[getPointFromDistanceRotation]] » Finds a point based on a starting point, direction and distance.

*[[getResourceSettings]] » This function returns a table of the resource settings.

*[[getTimestamp]] » With this function you can get the [http://en.wikipedia.org/wiki/Unix_time UNIX timestamp].

*[[IfElse]] » Returns one of two values based on a boolean expression.

*[[isLeapYear]] » Checks if the given year is a leap year.

*[[iterElements]] » Returns an iterator for your for loops saving time typing ipairs( getElementsByType( type ) ), instead you type: iterElements( type ).

*[[math.round]] » Rounds a number whereas the number of decimals to keep and the method may be set.

*[[onVehicleWeaponFire]] » This code implements an event that is triggered when a player in a vehicle fires a vehicles weapon.

*[[RGBToHex]] » This function returns a string representing the color in hexadecimal.

*[[setElementSpeed]] » This function allows you to set moving element speed in kph or mph units.

*[[setTableProtected]] » Protects a table and makes it read-only.

*[[setVehicleGravityPoint]] » This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.

*[[setPedGoTo]] » This function allows you to set target position of ped or player, and makes them move.

*[[string.explode]] » This function splits a string at a given separator pattern and returns a table with the pieces.

*[[table.copy]] » This function copies a whole table and all the tables in that table.

*[[table.map]] » This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.

*[[table.size]] » Finds the absolute size of a table.

*[[toHex]] » This function converts a decimal number to a hexadecimal number, as a fix to be used clientside.

*[[var_dump]] »This function outputs information about one or more variables using outputConsole(). 

*[[multi_check]] » This function checks one element to many, handy and clean. 

[[Category:Useful Functions]]

XmlCreateFile

2012-04-28T12:49:19Z

Ronwolf1705:

__NOTOC__
{{Server client function}}
This function creates a new XML document, which can later be saved to a file by using [[xmlSaveFile]]. This function will overwrite the file specified if it already exists.

{{Needs_Checking|it's server-side only// ronwolf1705}}

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
xmlnode xmlCreateFile ( string filePath, string rootNodeName )
</syntaxhighlight>

===Required Arguments===
*'''filePath:''' The [[filepath]] of the file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file will be in, and 'path' is the path from the root directory of the resource to the file.
:For example, if you want to create a file named 'new.xml' in the resource 'ctf', it can be created from another resource this way: ''xmlCreateFile(":ctf/new.xml", "newroot")''.
:If the file is in the current resource, only the file path is necessary, e.g. ''xmlCreateFile("new.xml", "newroot")''.
:Note that if a different resource than default is being accessed, the caller resource needs access to general.ModifyOtherObjects in the [[ACL]].
*'''rootNodeName:''' the name of the root node in the XML document.

</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
xmlnode xmlCreateFile ( string filePath, string rootNodeName )
</syntaxhighlight>

===Required Arguments===
*'''filePath:''' The [[filepath]] of the file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file will be in, and 'path' is the path from the root directory of the resource to the file.
:For example, if you want to create a file named 'new.xml' in the resource 'ctf', it can be created from another resource this way: ''xmlCreateFile(":ctf/new.xml", "newroot")''.
:If the file is in the current resource, only the file path is necessary, e.g. ''xmlCreateFile("new.xml", "newroot")''.
:Note that if a different resource than default is being accessed, the caller resource needs access to general.ModifyOtherObjects in the [[ACL]].
*'''rootNodeName:''' the name of the root node in the XML document.
</section>

===Returns===
Returns the root [[xmlnode]] object of the new XML file if successful, or ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
This example allows a player to use the command 'createfile' to create an .xml file.
<syntaxhighlight lang="lua">
-- Creates a file named "new.xml" with root node "newroot" and childnode "newchild".
function createFileHandler()
local RootNode = xmlCreateFile("new.xml"," newroot")
local NewNode = xmlCreateChild(RootNode, "newchild")
xmlSaveFile(RootNode)
end

addCommandHandler("createfile", createFileHandler)
</syntaxhighlight>
</section>

==See Also==
{{XML_functions}}

XmlCreateFile

2012-04-28T12:48:53Z

Ronwolf1705:

__NOTOC__
{{Server client function}}
This function creates a new XML document, which can later be saved to a file by using [[xmlSaveFile]]. This function will overwrite the file specified if it already exists.

{{Needs_Checking|it's server-side only}}

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
xmlnode xmlCreateFile ( string filePath, string rootNodeName )
</syntaxhighlight>

===Required Arguments===
*'''filePath:''' The [[filepath]] of the file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file will be in, and 'path' is the path from the root directory of the resource to the file.
:For example, if you want to create a file named 'new.xml' in the resource 'ctf', it can be created from another resource this way: ''xmlCreateFile(":ctf/new.xml", "newroot")''.
:If the file is in the current resource, only the file path is necessary, e.g. ''xmlCreateFile("new.xml", "newroot")''.
:Note that if a different resource than default is being accessed, the caller resource needs access to general.ModifyOtherObjects in the [[ACL]].
*'''rootNodeName:''' the name of the root node in the XML document.

</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
xmlnode xmlCreateFile ( string filePath, string rootNodeName )
</syntaxhighlight>

===Required Arguments===
*'''filePath:''' The [[filepath]] of the file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file will be in, and 'path' is the path from the root directory of the resource to the file.
:For example, if you want to create a file named 'new.xml' in the resource 'ctf', it can be created from another resource this way: ''xmlCreateFile(":ctf/new.xml", "newroot")''.
:If the file is in the current resource, only the file path is necessary, e.g. ''xmlCreateFile("new.xml", "newroot")''.
:Note that if a different resource than default is being accessed, the caller resource needs access to general.ModifyOtherObjects in the [[ACL]].
*'''rootNodeName:''' the name of the root node in the XML document.
</section>

===Returns===
Returns the root [[xmlnode]] object of the new XML file if successful, or ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
This example allows a player to use the command 'createfile' to create an .xml file.
<syntaxhighlight lang="lua">
-- Creates a file named "new.xml" with root node "newroot" and childnode "newchild".
function createFileHandler()
local RootNode = xmlCreateFile("new.xml"," newroot")
local NewNode = xmlCreateChild(RootNode, "newchild")
xmlSaveFile(RootNode)
end

addCommandHandler("createfile", createFileHandler)
</syntaxhighlight>
</section>

==See Also==
{{XML_functions}}

SetPedAnimation

2012-04-28T12:41:34Z

Ronwolf1705: /* Optional Arguments */

__NOTOC__
{{Server client function}}

Sets the current animation of a player or ped. Not specifying the type of animation will automatically cancel the current one.

==Syntax==
<syntaxhighlight lang="lua">
bool setPedAnimation ( ped thePed [, string block=nil, string anim=nil, int time=-1, bool loop=true, bool updatePosition=true, bool interruptable=true, bool freezeLastFrame = true] )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the player or ped you want to apply an animation to.

===Optional Arguments===
{{OptionalArg}}
*'''block:''' the [[Animations|animation]] block's name.
*'''anim:''' the name of the [[Animations|animation]] within the block.
*'''time:''' how long the animation will run for in milliseconds.
*'''loop:''' indicates whether or not the animation will loop.
*'''updatePosition:''' will change the actual coordinates of the ped according to the animation. Use this for e.g. walking animations.
*'''interruptable:''' if set to 'false' other tasks wont be able to interupt the animation.
*'''freezeLastFrame:''' ... (From 1.1 onwards).

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

==Example==

<section name="Server" class="server" show="true">
This example creates a ped, rotates him, and makes him walk:
<syntaxhighlight lang="lua">
function makePed()
ped1 = createPed(56, 1, 1, 4)
setPedRotation(ped1, 315)
setPedAnimation( ped1, "ped", "WOMAN_walknorm")
end
addCommandHandler("makemyped", makePed)
</syntaxhighlight>
</section>

==See Also==
{{Ped_functions}}
[[ru:setPedAnimation]]

SetPedAnimation

2012-04-28T12:41:10Z

Ronwolf1705: /* Optional Arguments */

__NOTOC__
{{Server client function}}

Sets the current animation of a player or ped. Not specifying the type of animation will automatically cancel the current one.

==Syntax==
<syntaxhighlight lang="lua">
bool setPedAnimation ( ped thePed [, string block=nil, string anim=nil, int time=-1, bool loop=true, bool updatePosition=true, bool interruptable=true, bool freezeLastFrame = true] )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the player or ped you want to apply an animation to.

===Optional Arguments===
{{OptionalArg}}
*'''block:''' the [[Animations|animation]] block's name.
*'''anim:''' the name of the [[Animations#run_1armed|animation]] within the block.
*'''time:''' how long the animation will run for in milliseconds.
*'''loop:''' indicates whether or not the animation will loop.
*'''updatePosition:''' will change the actual coordinates of the ped according to the animation. Use this for e.g. walking animations.
*'''interruptable:''' if set to 'false' other tasks wont be able to interupt the animation.
*'''freezeLastFrame:''' ... (From 1.1 onwards).

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

==Example==

<section name="Server" class="server" show="true">
This example creates a ped, rotates him, and makes him walk:
<syntaxhighlight lang="lua">
function makePed()
ped1 = createPed(56, 1, 1, 4)
setPedRotation(ped1, 315)
setPedAnimation( ped1, "ped", "WOMAN_walknorm")
end
addCommandHandler("makemyped", makePed)
</syntaxhighlight>
</section>

==See Also==
{{Ped_functions}}
[[ru:setPedAnimation]]

Template:Useful Functions

2012-04-28T12:19:40Z

Ronwolf1705:

*[[callClientFunction]] » This function allows you to call any clientside function from the server's side.

*[[callServerFunction]] » This function allows you to call any server-side function from the client's side.

*[[centerWindow]] » This function center the window in any resolution.

*[[Check]] » This function checks if it's arguments are of the right types and calls the error-function if one isn't.

*[[coroutine.resume]] » Fix for hidden coroutine error messages

*[[doForAllElements]] » This function can be used to execute a specified function for all elements of a specified type.

*[[dxDrawColorText]] » This function draws a dx text with #RRGGBB color codes support.

*[[findRotation]] » Takes two points and returns the direction from point A to point B.

*[[FormatDate]] » Formats a date on the basis of a format string and returns it.

*[[getAge]] » This function calculates the age of a birthday.

*[[getAlivePlayersInTeam]] » This function returns a table of the alive players in a team.

*[[getElementSpeed]] » This function allows you to get element speed in kph or mph units.

*[[getPlayerFromNamePart]] » This function allows you to get player From his Name part.

*[[getPointFromDistanceRotation]] » Finds a point based on a starting point, direction and distance.

*[[getResourceSettings]] » This function returns a table of the resource settings.

*[[getTimestamp]] » With this function you can get the [http://en.wikipedia.org/wiki/Unix_time UNIX timestamp].

*[[IfElse]] » Returns one of two values based on a boolean expression.

*[[isLeapYear]] » Checks if the given year is a leap year.

*[[iterElements]] » Returns an iterator for your for loops saving time typing ipairs( getElementsByType( type ) ), instead you type: iterElements( type ).

*[[math.round]] » Rounds a number whereas the number of decimals to keep and the method may be set.

*[[onVehicleWeaponFire]] » This code implements an event that is triggered when a player in a vehicle fires a vehicles weapon.

*[[RGBToHex]] » This function returns a string representing the color in hexadecimal.

*[[setElementSpeed]] » This function allows you to set moving element speed in kph or mph units.

*[[setTableProtected]] » Protects a table and makes it read-only.

*[[setVehicleGravityPoint]] » This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.

*[[setPedGoTo]] » This function allows you to set target position of ped or player, and makes them move.

*[[string.explode]] » This function splits a string at a given separator pattern and returns a table with the pieces.

*[[table.copy]] » This function copies a whole table and all the tables in that table.

*[[table.map]] » This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.

*[[table.size]] » Finds the absolute size of a table.

*[[toHex]] » This function converts a decimal number to a hexadecimal number, as a fix to be used clientside.

*[[var_dump]] »This function outputs information about one or more variables using outputConsole(). 

*[[multi_check]] » This function checks one element to many, handy and clean. 

[[Category:Useful Functions]]