Multi Theft Auto: Wiki - User contributions [en]

IsLineOfSightClear

2009-02-01T12:44:58Z

SpZ:

__NOTOC__
{{Client function}}
This function checks if there are obstacles between two points of the game world, optionally ignoring certain kinds of elements.

==Syntax==
<syntaxhighlight lang="lua">
bool isLineOfSightClear ( float startX, float startY, float startZ, float endX, float endY, float endZ, [ bool checkBuildings = true, bool checkVehicles = true, bool checkPeds = true, bool checkObjects = true, bool checkDummies = true, bool seeThroughStuff = false, bool ignoreSomeObjectsForCamera = false, element ignoredElement = nil ] )
</syntaxhighlight>

===Required Arguments===
*'''startX:''' The first point's world X coordinate.
*'''startY:''' The first point's world Y coordinate.
*'''startZ:''' The first point's world Z coordinate.
*'''endX:''' The second point's world X coordinate.
*'''endY:''' The second point's world Y coordinate.
*'''endZ:''' The second point's world Z coordinate.

===Optional Arguments===
{{OptionalArg}}
*'''checkBuildings:''' Allow the line of sight to be blocked by GTA's internally placed buildings, i.e. the world map.
*'''checkVehicles:''' Allow the line of sight to be blocked by [[Vehicle|vehicles]].
*'''checkPeds:''' Allow the line of sight to be blocked by peds, i.e. [[Player|players]].
*'''checkObjects:''' Allow the line of sight to be blocked by [[Object|objects]].
*'''checkDummies:''' Allow the line of sight to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to ''false''.
*'''seeThroughStuff:''' Allow the line of sight to be blocked by translucent game objects, e.g. glass.
*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to be blocked by certain objects.
*'''shootThroughStuff:''' Allow the line of sight to be blocked by certain entities.
*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element.

===Returns===
Returns ''true'' if the line between the specified points is clear, ''false'' if there's an obstacle or if invalid parameters are passed.

==Example==
This page does not have an example
<syntaxhighlight lang="lua">
--add an example here
</syntaxhighlight>

==See Also==
{{Client world functions}}
[[Category:Needs_Example]]

IsLineOfSightClear

2009-02-01T12:44:31Z

SpZ:

__NOTOC__
{{Client function}}
This function checks if there are obstacles between two points of the game world, optionally ignoring certain kinds of elements.

==Syntax==
<syntaxhighlight lang="lua">
bool isLineOfSightClear ( float startX, float startY, float startZ, float endX, float endY, float endZ, [ bool checkBuildings = true, bool checkVehicles = true, bool checkPeds = true, bool checkObjects = true, bool checkDummies = true, bool seeThroughStuff = false, bool ignoreSomeObjectsForCamera = false, element ignoredElement ] )
</syntaxhighlight>

===Required Arguments===
*'''startX:''' The first point's world X coordinate.
*'''startY:''' The first point's world Y coordinate.
*'''startZ:''' The first point's world Z coordinate.
*'''endX:''' The second point's world X coordinate.
*'''endY:''' The second point's world Y coordinate.
*'''endZ:''' The second point's world Z coordinate.

===Optional Arguments===
{{OptionalArg}}
*'''checkBuildings:''' Allow the line of sight to be blocked by GTA's internally placed buildings, i.e. the world map.
*'''checkVehicles:''' Allow the line of sight to be blocked by [[Vehicle|vehicles]].
*'''checkPeds:''' Allow the line of sight to be blocked by peds, i.e. [[Player|players]].
*'''checkObjects:''' Allow the line of sight to be blocked by [[Object|objects]].
*'''checkDummies:''' Allow the line of sight to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to ''false''.
*'''seeThroughStuff:''' Allow the line of sight to be blocked by translucent game objects, e.g. glass.
*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to be blocked by certain objects.
*'''shootThroughStuff:''' Allow the line of sight to be blocked by certain entities.
*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element.

===Returns===
Returns ''true'' if the line between the specified points is clear, ''false'' if there's an obstacle or if invalid parameters are passed.

==Example==
This page does not have an example
<syntaxhighlight lang="lua">
--add an example here
</syntaxhighlight>

==See Also==
{{Client world functions}}
[[Category:Needs_Example]]

GuiGridListSetSelectedItem

2008-02-16T22:54:26Z

SpZ: /* Required Arguments */

{{Client function}}
__NOTOC__
This function selects an item from a gridlist.

==Syntax==
<syntaxhighlight lang="lua">
bool guiGridListSetSelectedItem ( element gridList, int rowIndex, int columnIndex )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' the grid list you want to select an item from
*'''rowIndex:''' the row you want to select (index 0 is the first row)
*'''columnIndex:''' the column you want to select (index 1 is the first column)

===Returns===
Returns ''true'' if the passed arguments are correct and the item has been selected, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
-- provide an example here
</syntaxhighlight>

==See Also==
{{GUI functions}}

GuiGridListSetSelectedItem

2008-02-16T22:54:11Z

SpZ: /* Required Arguments */

{{Client function}}
__NOTOC__
This function selects an item from a gridlist.

==Syntax==
<syntaxhighlight lang="lua">
bool guiGridListSetSelectedItem ( element gridList, int rowIndex, int columnIndex )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' the grid list you want to select an item from
*'''rowIndex:''' the row index you want to select (index 0 is the first row)
*'''columnIndex:''' the column index you want to select (index 1 is the first column)

===Returns===
Returns ''true'' if the passed arguments are correct and the item has been selected, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
-- provide an example here
</syntaxhighlight>

==See Also==
{{GUI functions}}

User talk:SpZ

2008-02-15T12:51:40Z

SpZ: New page: Founder and developer of the GTA:FRP freeroaming and roleplaying community. Website: www.gta-frp.com

Founder and developer of the GTA:FRP freeroaming and roleplaying community.
Website: www.gta-frp.com

GuiGridListSetSelectedItem

2008-02-15T12:47:48Z

SpZ: /* Required Arguments */

{{Client function}}
__NOTOC__
This function selects an item from a gridlist.

==Syntax==
<syntaxhighlight lang="lua">
bool guiGridListSetSelectedItem ( element gridList, int rowIndex, int columnIndex )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' the grid list you want to select a row from
*'''rowIndex:''' the row index you want to select (index ''0'' is the first row)
*'''columnIndex:''' the column index from which you want to select a row (index ''1'' is the first column)

===Returns===
Returns ''true'' if the passed arguments are correct and the item has been selected, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
-- provide an example here
</syntaxhighlight>

==See Also==
{{GUI functions}}

GuiGridListSetSelectedItem

2008-02-15T12:47:33Z

SpZ: /* Required Arguments */

{{Client function}}
__NOTOC__
This function selects an item from a gridlist.

==Syntax==
<syntaxhighlight lang="lua">
bool guiGridListSetSelectedItem ( element gridList, int rowIndex, int columnIndex )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' the grid list you want to select a row from
*'''rowIndex:''' the row index you want to select (index '0' is the first row)
*'''columnIndex:''' the column index from which you want to select a row (index '1' is the first column)

===Returns===
Returns ''true'' if the passed arguments are correct and the item has been selected, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
-- provide an example here
</syntaxhighlight>

==See Also==
{{GUI functions}}

GuiGridListSetSelectedItem

2008-02-15T12:45:57Z

SpZ:

{{Client function}}
__NOTOC__
This function selects an item from a gridlist.

==Syntax==
<syntaxhighlight lang="lua">
bool guiGridListSetSelectedItem ( element gridList, int rowIndex, int columnIndex )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' the grid list you want to select a row from
*'''rowIndex:''' the row index you want to select
*'''columnIndex:''' the column index from which you want to select a row

===Returns===
Returns ''true'' if the passed arguments are correct and the item has been selected, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
-- provide an example here
</syntaxhighlight>

==See Also==
{{GUI functions}}

GuiGridListSetSelectedItem

2008-02-15T12:45:31Z

SpZ: New page: {{Client function}} __NOTOC__ This function selects a specified row (and column) from a gridlist. ==Syntax== <syntaxhighlight lang="lua"> bool guiGridListSetSelectedItem ( element gridList, int rowInde...

{{Client function}}
__NOTOC__
This function selects a specified row (and column) from a gridlist.

==Syntax==
<syntaxhighlight lang="lua">
bool guiGridListSetSelectedItem ( element gridList, int rowIndex, int columnIndex )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' the grid list you want to select a row from
*'''rowIndex:''' the row index you want to select
*'''columnIndex:''' the column index from which you want to select a row

===Returns===
Returns ''true'' if the passed arguments are correct and the item has been selected, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
-- provide an example here
</syntaxhighlight>

==See Also==
{{GUI functions}}

SetPlayerSkin

2008-01-23T22:11:58Z

SpZ: /* Example */

{{Server client function}}
__NOTOC__
This function changes the skin of a player.

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

===Required Arguments===
*'''thePlayer:''' The [[player]] whose model will be changed.
*'''skinID:''' A GTASA player model (skin) ID. See [[Character Skins]].

==Example==
This example sets you a police skin when you type the command /law.
<syntaxhighlight lang="lua">
function enterTheLaw(playerSource)
if (getPlayerSkin(playerSource) == 280) then
outputChatBox("You are already in the law!", playerSource)
else
setPlayerSkin(playerSource, 280)
outputChatBox("Welcome to the law, protect the innocents.", playerSource)
end
end

addCommandHandler("law", enterTheLaw)
</syntaxhighlight>

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

SetVehiclePanelState

2008-01-23T21:18:18Z

SpZ:

__NOTOC__
{{Server client function}}

==Syntax==
<syntaxhighlight lang="lua">setVehiclePanelState ( vehicle theVehicle, int panelID, int state )</syntaxhighlight>

==Required Arguments==
*'''panelID:''' 0-6
*'''state:''' 0-255 (check what range is effective, it may be much smaller e.g. 0-3)

==Returns==
Returns ''true'' if it works, ''false'' otherwise

==See Also==
{{Vehicle functions}}

SetVehiclePanelState

2008-01-23T21:16:11Z

SpZ:

GetPlayerSerial

2008-01-22T17:58:13Z

SpZ:

__NOTOC__
{{Server client function}}
This function returns the serial for a specified [[player]].

==Syntax==
<syntaxhighlight lang="lua">
string getPlayerSerial ( player thePlayer )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' A player object referencing the specified player.

===Returns===
Returns the serial as a string if it was found, ''false'' otherwise.

==See Also==
{{Serial functions}}

GetPlayerSerial

2008-01-22T17:57:36Z

SpZ:

__NOTOC__
{{Client function}}
This function returns the serial for a specified [[player]].

==Syntax==
<syntaxhighlight lang="lua">
string getPlayerSerial ( player thePlayer )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' A player object referencing the specified player.

===Returns===
Returns the serial as a string if it was found, ''false'' otherwise.

==See Also==
{{Serial functions}}

GetPlayerSerial

2008-01-22T17:57:07Z

SpZ:

GetPlayerSerial

2008-01-22T17:55:12Z

SpZ:

__NOTOC__
==Syntax==
<syntaxhighlight lang="lua">
string getPlayerSerial ( player thePlayer )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' A player object referencing the specified player.

===Returns===
Returns the serial as a string if it was found, ''false'' otherwise.

==See Also==
{{Serial functions}}

GetPlayerSerial

2008-01-22T17:54:50Z

SpZ: /* Syntax */

__NOTOC__

__NOTOC__
==Syntax==
<syntaxhighlight lang="lua">
string getPlayerSerial ( player thePlayer )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' A player object referencing the specified player.

===Returns===
Returns the serial as a string if it was found, ''false'' otherwise.

==See Also==
{{Serial functions}}

GetPlayerSerial

2008-01-22T17:54:36Z

SpZ: /* Syntax */

__NOTOC__

==Syntax==
<syntaxhighlight lang="lua">
string getPlayerSerial ( player thePlayer )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' A player object referencing the specified player.

===Returns===
Returns the serial as a string if it was found, ''false'' otherwise.

==See Also==
{{Serial functions}}

GetPlayerSerial

2008-01-22T17:53:08Z

SpZ: /* Returns */

==Syntax==
<syntaxhighlight lang="lua">
string getPlayerSerial ( player thePlayer )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' A player object referencing the specified player.

===Returns===
Returns the serial as a string if it was found, ''false'' otherwise.

==See Also==
{{Serial functions}}

GetPlayerSerial

2008-01-22T17:48:04Z

SpZ: New page: ==Syntax== <syntaxhighlight lang="lua"> string getPlayerSerial ( player thePlayer ) </syntaxhighlight> ===Required Arguments=== *'''thePlayer:''' A player object referencing the specified player. ===Returns=== Re...