Multi Theft Auto: Wiki - User contributions [en]

GetObjectModel

2007-08-14T23:22:44Z

Xanarki: /* Example */

__NOTOC__
{{Server function}}
This function retrieves the model ID of a specified object

==Syntax==
<syntaxhighlight lang="lua">
int getObjectModel ( element object )
</syntaxhighlight>

===Required Arguments===
*'''object:''' The object which you wish to retrieve the model ID of

===Returns===
Returns an ''int'' with the object model id, or ''false'' it's no or an invalid object.

==Example==
<section name="Server" class="server" show="true">
This example destroys a haystack when a player targets it
<syntaxhighlight lang="lua">
function onPlayerTargeted ( element )
if ( getElementType ( element ) == "object" ) and ( getObjectModel ( element ) == 3374 ) then
destroyElement ( element )
end
end
addEventHandler ( "onPlayerTarget", getRootElement(), onPlayerTargeted )
</syntaxhighlight> </section>
<section name="Server" class="server" show="false">
This example outputs the model id of objects the player is targetting.

<syntaxhighlight lang="lua">
function onPlayerTargeted ( element )
if ( getElementType ( element ) == "object") then
outputChatBox(getObjectModel ( element ))
end
end
addEventHandler ( "onPlayerTarget", getRootElement(), onPlayerTargeted )
</syntaxhighlight> </section>

==See Also==
{{Object functions}}

GetObjectModel

2007-08-14T23:22:05Z

Xanarki: /* Example */

__NOTOC__
{{Server function}}
This function retrieves the model ID of a specified object

==Syntax==
<syntaxhighlight lang="lua">
int getObjectModel ( element object )
</syntaxhighlight>

===Required Arguments===
*'''object:''' The object which you wish to retrieve the model ID of

===Returns===
Returns an ''int'' with the object model id, or ''false'' it's no or an invalid object.

==Example==
<section name="Server" class="server" show="true">
This example destroys a haystack when a player targets it
<syntaxhighlight lang="lua">
function onPlayerTargeted ( element )
if ( getElementType ( element ) == "object" ) and ( getObjectModel ( element ) == 3374 ) then
destroyElement ( element )
end
end
addEventHandler ( "onPlayerTarget", getRootElement(), onPlayerTargeted )
</syntaxhighlight> </section>
<section name="Server" class="server" show="true">
This example outputs the model id of objects the player is targetting.

<syntaxhighlight lang="lua">
function onPlayerTargeted ( element )
if ( getElementType ( element ) == "object") then
outputChatBox(getObjectModel ( element ))
end
end
addEventHandler ( "onPlayerTarget", getRootElement(), onPlayerTargeted )
</syntaxhighlight> </section>

==See Also==
{{Object functions}}

GetMaxPlayers

2007-08-14T23:20:54Z

Xanarki: /* Example */

__NOTOC__
{{Server function}}
This function returns the maximum number of player slots on the server.

==Syntax==
<syntaxhighlight lang="lua">int getMaxPlayers ()</syntaxhighlight>

===Returns===
Returns the maximum number of players allowed on the server.

==Example==
<section name="Server" class="server" show="true">
This example outputs the current number of players together with the maximum number of players when a player joins.
<syntaxhighlight lang="lua">
function showPlayers()
local maxPlayers = getMaxPlayers() -- get maximum number of players on the server
local players = getElementsByType("player") -- get a table of all current players
outputChatBox("There are "..#players.."/"..maxPlayers.." players playing",source) -- output a message to the joining player
end
addEventHandler("onPlayerJoin",getRootElement(),showPlayers) -- add the Event for "onPlayerJoin" that will call the "showPlayers" function
</syntaxhighlight> </section>

==See Also==
{{Server functions}}

GetMarkerType

2007-08-14T23:20:28Z

Xanarki: /* Example */

__NOTOC__
{{Server client function}}
This function returns a marker's type.

==Syntax==
<syntaxhighlight lang="lua">string getMarkerType ( marker theMarker )</syntaxhighlight>

===Required Arguments===
* '''theMarker''': A [[marker]] element referencing the specified marker.

===Returns===
Returns one of the following strings:
{{Marker_types}}

If an invalid marker is specified, ''false'' is returned.

==Example==
<section name="Both" class="both" show="true">
This function creates a default marker at a given position and outputs its type.
<syntaxhighlight lang="lua">
function createMarkerAndOutputType ( x, y, z )
-- we create the marker
local theMarker = createMarker ( x, y, z )
-- if the marker was created,
if ( theMarker ) then
-- then get its type,
local markerType = getMarkerType ( theMarker )
-- and output it.
outputChatBox ( "It's a " .. markerType .. " marker!" )
end
-- return the created marker element (or false) where this function was called
return theMarker
end
</syntaxhighlight> </section>

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

GetMarkerSize

2007-08-14T23:19:28Z

Xanarki: /* Example */

__NOTOC__
{{Server client function}}
This function returns a [[float]] containing the size of the specified marker.

==Syntax==
<syntaxhighlight lang="lua">float getMarkerSize ( marker myMarker )</syntaxhighlight>

===Required Arguments===
*'''myMarker''': The [[marker]] that you wish to retrieve the size of.

===Returns===
Returns a [[float]] containing the size of the specified marker.

==Example==
<section name="Both" class="both" show="true">
This example creates a marker and outputs the size to everyone.
<syntaxhighlight lang="lua">
-- Create a maker
newMarker = createMarker ( 1, 1000, 1000, 1000, 1,0,0 )
-- If the marker was created successfully then...
if ( newMarker ~= false ) then
-- Tell everyone about it
outputChatBox ( "Current marker size: " .. getMarkerSize ( newMarker ) )
end
</syntaxhighlight> </section>

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

SetMarkerType

2007-08-14T23:13:51Z

Xanarki: /* Example */

__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==
<section name="Both" class="both" show="true">
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> </section>

==See Also==
{{Marker functions}}
{{Server client function}}

SetMarkerType

2007-08-14T23:13:39Z

Xanarki:

__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==
<section name="Server" class="both" show="true">
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> </section>

==See Also==
{{Marker functions}}
{{Server client function}}

SetObjectModel

2007-08-14T23:12:29Z

Xanarki:

__NOTOC__
This sets a new object model to the specified element.

==Syntax==
<syntaxhighlight lang="lua">
bool setObjectModel ( element object, int id )
</syntaxhighlight>

===Required Arguments===
*'''object:''' A valid [[element]].
*'''id:''' An [[int]] specifying the model id.

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

==Example==
<section name="Server" class="server" show="true">
This will continually change an object model every 2.5 seconds at the location -1084.52, -1634.81, 76.36 (Truth's farm).
<syntaxhighlight lang="lua">
myobject = createObject ( 5822, -1084.52, -1634.81, 76.36 )
--We create an initial object element. I choose object model 5822 to begin with.

setTimer ( objectRandomization, 2500, 0 )
--Every 2.5 seconds, the function 'objectRandomization' is called by this timer.
--Each time the function runs, it changes the object model by applying a new whole-
--integer random object ID. This timer is called an infinite amount of times since
--it's repeat value is set to 0.

function objectRandomization ()
randomobjectnumber = randInt(1, 18000)
--Choose a random number between 1 and 18000 as a whole integer and assign it to
--the varible 'randomobjectnumber'
setObjectModel ( myobject, randomobjectnumber )
--Change our object appearance by applying a new model ID
end
</syntaxhighlight> </section>

==See Also==
{{Object functions}}
{{Server function}}

SetPlayerArmor

2007-08-14T23:11:38Z

Xanarki:

__NOTOC__
This function allows you to set the armor value of a [[player]].

==Syntax==
<syntaxhighlight lang="lua">bool setPlayerArmor ( player thePlayer, float playerArmor )</syntaxhighlight>

===Required Arguments===
*'''thePlayer''': the [[player]] whose armor you want to modify.
*'''playerArmor''': the amount of armor you want to set on the player. Valid values are from 0 to 100.

===Returns===
Returns ''true'' if the armor was changed succesfully. Returns ''false'' if an invalid player is specified, or the armor value specified is out of acceptable range.

==Example==
<section name="Server" class="server" show="true">
This example removes the armor of a player.
<syntaxhighlight lang="lua">
function armoroff ( player, command )
setPlayerArmor ( player, getPlayerArmor(player) - 100 )
end

addCommandHandler ( "armoroff", armoroff )
</syntaxhighlight> </section>

==See Also==
{{Player functions}}
{{Server function}}

SetPlayerFightingStyle

2007-08-14T23:10:58Z

Xanarki:

__NOTOC__
Changes a player's fighting style, most only change the 'special attack' which is done using the Aim and Enter keys.

{| border="2" cellpadding="2" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse; font-size: 95%;"
|'''Fighting Style'''
|'''ID'''
|-
|STYLE_STANDARD
|4
|-
|STYLE_BOXING
|5
|-
|STYLE_KUNG_FU
|6
|-
|STYLE_KNEE_HEAD
|7
|-
|STYLE_GRAB_KICK
|15
|-
|STYLE_ELBOWS
|16
|-
|}

==Syntax==
<syntaxhighlight lang="lua">setPlayerFightingStyle ( player, int style ) </syntaxhighlight>

===Required Arguments===
*'''Player:''' Tells the function to give the fighting style to a player
*'''Style:''' A whole integer specifying the style of fighting you want to give to the player

==Example==
<section name="Server" class="server" show="true">
This example sets the player's fighting style to the desired style when he types "setstyle" followed by a number from 4 to 16 in console.
<syntaxhighlight lang="lua">
function consoleSetFightingStyle ( player, commandName, id ) --Calls the function
if ( player and id ) then --If both are valid
local status = setPlayerFightingStyle ( player, tonumber(id) ) --Fighting style is set
if ( not status ) then --If it can't set the fighting style (bad ID)
outputConsole ( "Failed to set fighting style.", player ) --This shows
end
end
end
addCommandHandler ( "setstyle", consoleSetFightingStyle )

</syntaxhighlight> </section>

==See Also==
{{Player functions}}
{{Server function}}

SetPlayerGravity

2007-08-14T23:09:18Z

Xanarki:

__NOTOC__
==Description==
This function sets the gravity level of a player.

==Syntax==
<syntaxhighlight lang="lua">setPlayerGravity ( player thePlayer, float level )</syntaxhighlight>

===Required Arguments===
*'''thePlayer''': The player whose gravity to change.
*'''level''': The level of gravity ( default is <b>0.008</b> )

==Example==
<section name="Server" class="server" show="true">
This example allows the user to type a command to change their gravity:
<syntaxhighlight lang="lua">function consoleSetPlayerGravity ( player, commandName, level ) --Calls the function
if ( player ) then
local success = setPlayerGravity ( player, tonumber ( level ) ) --Sets the gravity
if (not success) then
outputConsole( "Failed to set player gravity", player ) --If it can't be set, this message will show
end
end
end
addCommandHandler ( "setplayergravity", consoleSetPlayerGravity )</syntaxhighlight></section>
==See Also==
{{Player functions}}
{{Server function}}

SetPlayerHealth

2007-08-14T23:08:42Z

Xanarki:

__NOTOC__
This function allows you to set a player's health.

==Syntax==
<syntaxhighlight lang="lua">
bool setPlayerHealth ( player thePlayer, float playerHealth )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer''': The [[player]] whose health you want to set.
*'''playerHealth''': The value you want to set the health to. Valid values are from 0 (dead) to 100 (full health).

===Returns===
Returns ''true'' if the player's health was set succesfully. Returns ''false'' if the player argument is invalid, or the health argument is out of range.

==Example==
<section name="Server" class="server" show="true">
This example finds "player" and when "slap" is entered, their health is decreased
<syntaxhighlight lang="lua">
function slap ( player, command ) --calls the function
setPlayerHealth ( player, getPlayerHealth(player) - 20 ) --sets the player health
end
addCommandHandler ( "slap", slap )
</syntaxhighlight></section>

==See Also==
{{Player functions}}
{{Server function}}

SetMarkerTarget

2007-08-13T04:01:50Z

Xanarki:

[[Category:Incomplete]]

__NOTOC__
This fake function is for use with blah & blah and does blahblahblabhalbhl

{{Needs_Checking|Shouldn't it be setMarkerTarget ( marker, x, y, z ) ?|[[User:Erorr404|Erorr404]]}}
{{Needs_Checking|Also, entering anything other than 0, 0, 0 does not show the arrow (setMarkerTarget ( marker, 0, 0, 0 ) does show the arrow)|[[User:Erorr404|Erorr404]]}}

==Syntax==
<syntaxhighlight lang="lua">
bool setMarkerTarget ( marker, x, y, z )
</syntaxhighlight>

===Required Arguments===
*'''argumentName:''' description

===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' descriptiona
*'''argumentName3:''' description

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

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

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

SetPlayerHealth

2007-08-06T07:08:11Z

Xanarki:

__NOTOC__
This function allows you to set a player's health.

==Syntax==
<syntaxhighlight lang="lua">
bool setPlayerHealth ( player thePlayer, float playerHealth )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer''': The [[player]] whose health you want to set.
*'''playerHealth''': The value you want to set the health to. Valid values are from 0 (dead) to 100 (full health).

===Returns===
Returns ''true'' if the player's health was set succesfully. Returns ''false'' if the player argument is invalid, or the health argument is out of range.

==Example==
This example finds "player" and when "slap" is entered, their health is decreased
<syntaxhighlight lang="lua">
function slap ( player, command ) --calls the function
setPlayerHealth ( player, getPlayerHealth(player) - 20 ) --sets the player health
end
addCommandHandler ( "slap", slap )
</syntaxhighlight>

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

SetPlayerArmor

2007-08-06T07:06:42Z

Xanarki:

__NOTOC__
This function allows you to set the armor value of a [[player]].

==Syntax==
<syntaxhighlight lang="lua">bool setPlayerArmor ( player thePlayer, float playerArmor )</syntaxhighlight>

===Required Arguments===
*'''thePlayer''': the [[player]] whose armor you want to modify.
*'''playerArmor''': the amount of armor you want to set on the player. Valid values are from 0 to 100.

===Returns===
Returns ''true'' if the armor was changed succesfully. Returns ''false'' if an invalid player is specified, or the armor value specified is out of acceptable range.

==Example==
This example removes the armor of a player.
<syntaxhighlight lang="lua">
function armoroff ( player, command )
setPlayerArmor ( player, getPlayerArmor(player) - 100 )
end

addCommandHandler ( "armoroff", armoroff )
</syntaxhighlight>

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

SetPlayerArmor

2007-08-06T06:59:33Z

Xanarki:

__NOTOC__
This function allows you to set the armor value of a [[player]].

==Syntax==
<syntaxhighlight lang="lua">bool setPlayerArmor ( player thePlayer, float playerArmor )</syntaxhighlight>

===Required Arguments===
*'''thePlayer''': the [[player]] whose armor you want to modify.
*'''playerArmor''': the amount of armor you want to set on the player. Valid values are from 0 to 100.

===Returns===
Returns ''true'' if the armor was changed succesfully. Returns ''false'' if an invalid player is specified, or the armor value specified is out of acceptable range.

==Example==
This example removes the armor of a player.
<syntaxhighlight lang="lua">
function armoroff ( player, command )
setPlayerArmor ( player, getPlayerArmor - 100 )
end

addCommandHandler ( "armoroff", armoroff )
</syntaxhighlight>

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

SetPlayerHealth

2007-08-06T06:52:44Z

Xanarki:

__NOTOC__
This function allows you to set a player's health.

==Syntax==
<syntaxhighlight lang="lua">
bool setPlayerHealth ( player thePlayer, float playerHealth )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer''': The [[player]] whose health you want to set.
*'''playerHealth''': The value you want to set the health to. Valid values are from 0 (dead) to 100 (full health).

===Returns===
Returns ''true'' if the player's health was set succesfully. Returns ''false'' if the player argument is invalid, or the health argument is out of range.

==Example==
This example finds "player" and when "slap" is entered, their health is decreased
<syntaxhighlight lang="lua">
function slap ( player, command ) --calls the function
setPlayerHealth ( player, getPlayerHealth - 20 ) --sets the player health
end
addCommandHandler ( "slap", slap )
</syntaxhighlight>

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

SetPlayerGravity

2007-08-06T05:29:43Z

Xanarki:

__NOTOC__
==Description==
This function sets the gravity level of a player.

==Syntax==
<syntaxhighlight lang="lua">setPlayerGravity ( player thePlayer, float level )</syntaxhighlight>

===Required Arguments===
*'''thePlayer''': The player whose gravity to change.
*'''level''': The level of gravity ( default is <b>0.008</b> )

==Example==
This example allows the user to type a command to change their gravity:
<syntaxhighlight lang="lua">function consoleSetPlayerGravity ( player, commandName, level ) --Calls the function
if ( player ) then
local success = setPlayerGravity ( player, tonumber ( level ) ) --Sets the gravity
if (not success) then
outputConsole( "Failed to set player gravity", player ) --If it can't be set, this message will show
end
end
end
addCommandHandler ( "setplayergravity", consoleSetPlayerGravity )</syntaxhighlight>
==See Also==
{{Player functions}}

SetPlayerFightingStyle

2007-08-05T18:57:39Z

Xanarki:

__NOTOC__
Changes a player's fighting style, most only change the 'special attack' which is done using the Aim and Enter keys.

{| border="2" cellpadding="2" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse; font-size: 95%;"
|'''Fighting Style'''
|'''ID'''
|-
|STYLE_STANDARD
|4
|-
|STYLE_BOXING
|5
|-
|STYLE_KUNG_FU
|6
|-
|STYLE_KNEE_HEAD
|7
|-
|STYLE_GRAB_KICK
|15
|-
|STYLE_ELBOWS
|16
|-
|}

==Syntax==
<syntaxhighlight lang="lua">setPlayerFightingStyle ( player, int style ) </syntaxhighlight>

===Required Arguments===
*'''Player:''' Tells the function to give the fighting style to a player
*'''Style:''' A whole integer specifying the style of fighting you want to give to the player

==Example==
This example sets the player's fighting style to the desired style when he types "setstyle" followed by a number from 4 to 16 in console.
<syntaxhighlight lang="lua">
function consoleSetFightingStyle ( player, commandName, id ) --Calls the function
if ( player and id ) then --If both are valid
local status = setPlayerFightingStyle ( player, tonumber(id) ) --Fighting style is set
if ( not status ) then --If it can't set the fighting style (bad ID)
outputConsole ( "Failed to set fighting style.", player ) --This shows
end
end
end
addCommandHandler ( "setstyle", consoleSetFightingStyle )

</syntaxhighlight>

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

SetPlayerFightingStyle

2007-08-05T18:30:03Z

Xanarki:

__NOTOC__
Changes a player's fighting style, most only change the 'special attack' which is done using the Aim and Enter keys.

{| border="2" cellpadding="2" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse; font-size: 95%;"
|'''Fighting Style'''
|'''ID'''
|-
|STYLE_STANDARD
|4
|-
|STYLE_BOXING
|5
|-
|STYLE_KUNG_FU
|6
|-
|STYLE_KNEE_HEAD
|7
|-
|STYLE_GRAB_KICK
|15
|-
|STYLE_ELBOWS
|16
|-
|}

==Syntax==
<syntaxhighlight lang="lua">setPlayerFightingStyle ( player, int style ) </syntaxhighlight>

===Required Arguments===
*'''Player:''' Tells the function to give the fighting style to a player
*'''Style:''' A whole integer specifying the style of fighting you want to give to the player

==Example==
This example sets the player's fighting style to the desired style when he types "style" folldowed by a number from 4 to 16 in console.
<syntaxhighlight lang="lua">addCommandHandler ( "style", "style" ) -- add a command handler for setcash
function style ( player, command, id ) --when the style function is called
setPlayerFightingStyle ( player, id ) --set players fighting style
end</syntaxhighlight>

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

SetObjectRotation

2007-08-05T05:06:19Z

Xanarki:

__NOTOC__
Allows you to change an objects rotation while playing a map. The object can be from the map file or created in a script.

==Syntax==
<syntaxhighlight lang="lua">
bool setObjectRotation ( element object, float rotX, float rotY, float rotZ )
</syntaxhighlight>

===Required Arguments===
*'''Object:''' The object to be rotated
*'''rotX:''' Rotation X value
*'''rotY:''' Rotation Y value
*'''rotZ:''' Rotation Z value

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

==Example==
In this example, I refer to an object in the map file with the ID "pirateship":
<syntaxhighlight lang="xml">
<object id="pirateship" posX="-1627.319092" posY="128.543411" posZ="6.581001" rotX="-0.760854" rotY="2.421000" rotZ="0.851000" model="8493"/>
</syntaxhighlight>

<syntaxhighlight lang="lua">

function onResourceStart ( name, root )
rotX = 0
rotY = 0
rotZ = 0 -- predefined varibles, needed for the math code below
pirateship = getElementByID ( "pirateship" ) -- assign element named 'pirateship' in map file to variable
end

function chatboxShipRotateLeft ( playerSource, commandName ) -- On console command 'increaserotations'
outputChatBox ( "Rotational values increased" )
rotX = rotX + 10
rotY = rotY + 10
rotZ = rotZ + 10 -- rotations = rotations + 10
setObjectRotation ( pirateship, rotX, rotY, rotZ ) -- Changed rotation is applied
end

function chatboxShipRotateRight ( playerSource, commandName ) -- On console command 'decreaserotations'
outputChatBox ( "Rotational values decreased" )
rotX = rotX - 10
rotY = rotY - 10
rotZ = rotZ - 10 -- rotations = rotations - 10
setObjectRotation ( pirateship, rotX, rotY, rotZ ) -- Changed rotation is applied
end

addEventHandler ( "onResourceStart", getRootElement(), onResourceStart )

addCommandHandler ( "increaserotations", chatboxShipRotateLeft )
addCommandHandler ( "decreaserotations", chatboxShipRotateRight )
</syntaxhighlight>

==See Also==
{{Object functions}}

SetObjectRotation

2007-08-05T05:05:39Z

Xanarki:

__NOTOC__
Allows you to change an objects rotation while playing a map. The object can be from the map file or created in a script.

==Syntax==
<syntaxhighlight lang="lua">
bool setObjectRotation ( element object, float rotX, float rotY, float rotZ )
</syntaxhighlight>

===Required Arguments===
*'''Object:''' The object to be rotated
*'''rotX:''' Rotation X value
*'''rotY:''' Rotation Y value
*'''rotZ:''' Rotation Z value

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

==Example==
In this example, I refer to an object in the map file with the ID "pirateship":
<syntaxhighlight lang="xml">
<object id="pirateshi[" posX="-1627.319092" posY="128.543411" posZ="6.581001" rotX="-0.760854" rotY="2.421000" rotZ="0.851000" model="8493"/>
</syntaxhighlight>

<syntaxhighlight lang="lua">

function onResourceStart ( name, root )
rotX = 0
rotY = 0
rotZ = 0 -- predefined varibles, needed for the math code below
pirateship = getElementByID ( "pirateship" ) -- assign element named 'pirateship' in map file to variable
end

function chatboxShipRotateLeft ( playerSource, commandName ) -- On console command 'increaserotations'
outputChatBox ( "Rotational values increased" )
rotX = rotX + 10
rotY = rotY + 10
rotZ = rotZ + 10 -- rotations = rotations + 10
setObjectRotation ( pirateship, rotX, rotY, rotZ ) -- Changed rotation is applied
end

function chatboxShipRotateRight ( playerSource, commandName ) -- On console command 'decreaserotations'
outputChatBox ( "Rotational values decreased" )
rotX = rotX - 10
rotY = rotY - 10
rotZ = rotZ - 10 -- rotations = rotations - 10
setObjectRotation ( pirateship, rotX, rotY, rotZ ) -- Changed rotation is applied
end

addEventHandler ( "onResourceStart", getRootElement(), onResourceStart )

addCommandHandler ( "increaserotations", chatboxShipRotateLeft )
addCommandHandler ( "decreaserotations", chatboxShipRotateRight )
</syntaxhighlight>

==See Also==
{{Object functions}}

SetObjectRotation

2007-08-05T05:04:37Z

Xanarki:

__NOTOC__
Allows you to change an objects rotation while playing a map. The object can be from the map file or created in a script.

==Syntax==
<syntaxhighlight lang="lua">
bool setObjectRotation ( element object, float rotX, float rotY, float rotZ )
</syntaxhighlight>

===Required Arguments===
*'''Object:''' The object to be rotated
*'''rotX:''' Rotation X value
*'''rotY:''' Rotation Y value
*'''rotZ:''' Rotation Z value

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

==Example==
In this example, I refer to an object in the map file with the ID "pirateship":
<syntaxhighlight lang="xml">
<object id="pirateshi[" posX="-1627.319092" posY="128.543411" posZ="6.581001" rotX="-0.760854" rotY="2.421000" rotZ="0.851000" model="8493"/>
</syntaxhighlight>

<syntaxhighlight lang="lua">

function onResourceStart ( name, root )
rotX = 0
rotY = 0
rotZ = 0 -- predefined varibles, needed for the math code below
pirateship = getElementByID ( "pirateship" ) -- assign element named 'pirateship' in map file to varible
end

function chatboxShipRotateLeft ( playerSource, commandName ) -- On console command 'increaserotations'
outputChatBox ( "Rotational values increased" )
rotX = rotX + 10
rotY = rotY + 10
rotZ = rotZ + 10 -- rotations = rotations + 10
setObjectRotation ( pirateship, rotX, rotY, rotZ ) -- Changed rotation is applied
end

function chatboxShipRotateRight ( playerSource, commandName ) -- On console command 'decreaserotations'
outputChatBox ( "Rotational values decreased" )
rotX = rotX - 10
rotY = rotY - 10
rotZ = rotZ - 10 -- rotations = rotations - 10
setObjectRotation ( pirateship, rotX, rotY, rotZ ) -- Changed rotation is applied
end

addEventHandler ( "onResourceStart", getRootElement(), onResourceStart )

addCommandHandler ( "increaserotations", chatboxShipRotateLeft )
addCommandHandler ( "decreaserotations", chatboxShipRotateRight )
</syntaxhighlight>

==See Also==
{{Object functions}}

SetObjectModel

2007-08-05T04:08:38Z

Xanarki:

__NOTOC__
This sets a new object model to the specified element.

==Syntax==
<syntaxhighlight lang="lua">
bool setObjectModel ( element object, int id )
</syntaxhighlight>

===Required Arguments===
*'''object:''' A valid [[element]].
*'''id:''' An [[int]] specifying the model id.

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

==Example==
This will continually change an object model every 2.5 seconds at the location -1084.52, -1634.81, 76.36 (Truth's farm).
<syntaxhighlight lang="lua">
myobject = createObject ( 5822, -1084.52, -1634.81, 76.36 )
--We create an initial object element. I choose object model 5822 to begin with.

setTimer ( objectRandomization, 2500, 0 )
--Every 2.5 seconds, the function 'objectRandomization' is called by this timer.
--Each time the function runs, it changes the object model by applying a new whole-
--integer random object ID. This timer is called an infinite amount of times since
--it's repeat value is set to 0.

function objectRandomization ()
randomobjectnumber = randInt(1, 18000)
--Choose a random number between 1 and 18000 as a whole integer and assign it to
--the varible 'randomobjectnumber'
setObjectModel ( myobject, randomobjectnumber )
--Change our object appearance by applying a new model ID
end
</syntaxhighlight>

==See Also==
{{Object functions}}

Weapons

2007-07-12T09:45:55Z

Xanarki:

The weapon argument is an integer that refers to the GTASA weapon id list. The following values are valid:

''Note: I have also included amounts held in each weapon's ammo clip, to make it easier to determine exact clips.''

[http://vces.net/info/WeaponIDs.html Alternative Weapons List (Brophy/Ratt):]
*'''Slot 0: No Weapon'''
**'''0:''' Fist
**'''1:''' Brass Knuckles
<br>
*'''Slot 1 : Melee'''
**'''2:''' Golf Club
**'''3:''' Nightstick
**'''4:''' Knife
**'''5:''' Baseball Bat
**'''6:''' Shovel
**'''7:''' Pool Cue
**'''8:''' Katana
**'''9:''' Chainsaw
**'''15:''' Cane
<br>
*'''Slot 2: Handguns'''
**'''22:''' Pistol (17, dual 34)
**'''23:''' Silenced Pistol (17)
**'''24:''' Desert Eagle (7)
<br>
*'''Slot 3: Shotguns'''
**'''25:''' Shotgun (1)
**'''26:''' Sawn-Off Shotgun (2, dual 4)
**'''27:''' SPAZ-12 Combat Shotgun (7)
<br>
*'''Slot 4: Sub-Machine Guns'''
**'''28:''' Uzi (50, dual 100)
**'''29:''' MP5 (30)
**'''32:''' TEC-9 (50, dual 100)
<br>
*'''Slot 5: Machine Guns'''
**'''30:''' AK47 (30)
**'''31:''' M4 (50)
<br>
*'''Slot 6: Rifles'''
**'''33:''' Country Sniper Rifle (1)
**'''34:''' Sniper Rifle (1)
<br>
*'''Slot 7: Heavy Weapons'''
**'''35:''' Rocket Launcher (1)
**'''36:''' Heat Seeking RPG (1)
**'''37:''' Flame Thrower (50)
**'''38:''' Minigun (500)
<br>
*'''Slot 8: Projectiles'''
**'''16:''' Grenade (1)
**'''17:''' Tear Gas (1)
**'''18:''' Molotov Cocktails (1)
**'''39:''' Satchel Charges (1)
<br>
*'''Slot 9: Special 1'''
**'''42:''' Fire Extinguisher (500)
**'''43:''' Camera (36)
<br>
*'''Slot 10: Gifts/Other'''
**'''10:''' Long Purple Dildo
**'''11:''' Short tan Dildo
**'''12:''' Vibrator
**'''14:''' Flowers
<br>
*'''Slot 11: Special 2'''
**'''44:''' Night-Vision Goggles
**'''45:''' Infra-Red Goggles
**'''46:''' Parachute
<br>
*'''Slot 12: Satchel Detonator'''
**'''40''' Satchel Detonator

==See Also==
[[id]]

OnResourceStop

2007-07-05T03:32:12Z

Xanarki:

This event is triggered when the resource is changed or unloaded.

==Example==
This example displays a message in the textbox when the resource is changed / unloaded

<syntaxhighlight lang="lua">

addEventHandler ( "onResourceStop", root, "onResourceStop" )
function onResourceStop ( )
outputChatBox ( "Script Unloaded!", root, 255, 255, 255 )
end

</syntaxhighlight>

OnVehicleExplode

2007-07-03T20:49:52Z

Xanarki:

__NOTOC__
This event is triggered when a vehicle explodes.

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

==Example==
This example tells the players when a vehicle explodes
<syntaxhighlight lang="lua">
function onVehicleExplode () --The function in which when a vehicle explodes
local VagosVehicleHealth = getVehicleHealth ( VagosVehicle ) --Gets the HP of the Vagos' vehicle

if ( VagosVehicleHealth == 0 ) then --If the vehicle's health is "0" (exploded)
showTextForAll ( 3000, 0, 10, 125, 1.5, " VAGOS' LOAD HAS EXPLODED!" ) --shows the text
end
addEventHandler ( "onVehicleExplode", root, onVehicleExplode ) --Event is triggered
</syntaxhighlight>

OnVehicleExplode

2007-07-03T20:48:29Z

Xanarki: /* Example */

[[Category:Incomplete Event]]

__NOTOC__
This event is triggered when a vehicle explodes.

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

==Example==
This example tells the players when a vehicle explodes
<syntaxhighlight lang="lua">
function onVehicleExplode () --The function in which when a vehicle explodes
local VagosVehicleHealth = getVehicleHealth ( VagosVehicle ) --Gets the HP of the Vagos' vehicle

if ( VagosVehicleHealth == 0 ) then --If the vehicle's health is "0" (exploded)
showTextForAll ( 3000, 0, 10, 125, 1.5, " VAGOS' LOAD HAS EXPLODED!" ) --shows the text
end
addEventHandler ( "onVehicleExplode", root, onVehicleExplode ) --Event is triggered
</syntaxhighlight>

OnClientPlayerJoin

2007-07-03T20:40:16Z

Xanarki:

__NOTOC__
This event is when a player joins.

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

==Example==
This example does...
<syntaxhighlight lang="lua">
function onPlayerJoin () --When the player joins
showTextForPlayer ( source, 5000, 0, 0, 180, 1.5, "We be gangstas!" ) --Shows text for the player
end
addEventHandler ( "onPlayerJoin", root, onPlayerJoin ) --Event is triggered
</syntaxhighlight>

OnPlayerQuit

2007-07-03T20:35:19Z

Xanarki:

__NOTOC__
This event is triggered when a player leaves the game, for whatever reason.

==Syntax==
<syntaxhighlight lang="lua">
void [[onPlayerQuit]] ( string reason )
</syntaxhighlight>

==Example==
This example does...
<syntaxhighlight lang="lua">
outputDebugString ( "Kills blip when player exits" ) --Outputs to debug console
function onPlayerQuit () --When the player quits
destroyBlipsAttachedTo ( source ) --Destorys the blips
removePlayerFromTeam ( source ) --Also removes player from the previously selected team
end

addEventHandler ( "onPlayerQuit", root, onPlayerQuit ) --The event
</syntaxhighlight>

OnPlayerQuit

2007-07-03T20:34:33Z

Xanarki: /* Example */

[[Category:Incomplete Event]]

__NOTOC__
This event is triggered when a player leaves the game, for whatever reason.

==Syntax==
<syntaxhighlight lang="lua">
void [[onPlayerQuit]] ( string reason )
</syntaxhighlight>

==Example==
This example does...
<syntaxhighlight lang="lua">
outputDebugString ( "Kills blip when player exits" ) --Outputs to debug console
function onPlayerQuit () --When the player quits
destroyBlipsAttachedTo ( source ) --Destorys the blips
removePlayerFromTeam ( source ) --Also removes player from the previously selected team
end

addEventHandler ( "onPlayerQuit", root, onPlayerQuit ) --The event
</syntaxhighlight>

XmlSaveFile

2007-07-03T04:48:29Z

Xanarki:

__NOTOC__
This function saves a loaded XML file.

==Syntax==
<syntaxhighlight lang="lua">bool xmlSaveFile ( xmlnode rootNode ) </syntaxhighlight>

===Required Arguments===
*'''rootNode:''' the root [[xmlnode]] of the loaded XML file.

===Returns===
Returns ''true'' if save was successful, ''false'' if the XML file does not exist.

==Example==
<syntaxhighlight lang="lua">
xmlSaveFile("/resources/nwayo/meta.xml", doc) --Saves the XML file as a .doc
</syntaxhighlight>

==See Also==
{{XML_functions}}

XmlSaveFile

2007-07-03T04:47:52Z

Xanarki: /* Example */

SetCameraPosition

2007-07-03T04:43:50Z

Xanarki:

__NOTOC__
This function allows you to move a specified player's camera to a specific location if it is fixed (see [[setCameraMode]]).

==Syntax==
<syntaxhighlight lang="lua">
bool setCameraPosition ( player thePlayer, float x, float y, float z )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player whose camera you wish to modify.
*'''x:''' The x co-ordinate of the new position.
*'''y:''' The x co-ordinate of the new position.
*'''z:''' The x co-ordinate of the new position.

===Returns===
Returns a [[bool]] with a value of ''true'' if the function was successful, ''false'' otherwise.

==Example==

<syntaxhighlight lang="lua">

function spawnScreen ( source ) --Calls the function spawnScreen
setCameraMode ( source, "fixed" ) --Classifies which camera mode to use for the spawn screen
setTimer ( "setCameraPosition", 1000, 1, source, 160.15, -1951.68, 50 ) --Coords for the fixated camera. This will "set the location" of the camera, so to speak.
setTimer ( "setCameraLookAt", 1000, 1, source, 165, -1951.68, 50 ) --Coords for the fixated camera
bindKey ( source, "F1", "down", "spawnVagos" ) --Spawns player as team #1. In this case, a new function is created later on
bindKey ( source, "F2", "down", "spawnAztecs" ) --Spawns player as team #2. In this case, a new function is created later on
end
</syntaxhighlight>

==See Also==
{{Camera functions}}

SetCameraPosition

2007-07-03T04:43:19Z

Xanarki: /* Example */

SetCameraLookAt

2007-07-03T04:42:16Z

Xanarki:

__NOTOC__
This function allows you to set a specified player's camera to look at a specific point when the camera is fixed (see [[setCameraMode]]).
==Syntax==
<syntaxhighlight lang="lua">
bool setCameraLookAt ( player thePlayer, float x, float y, float z )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player whose camera you wish to modify.
*'''x:''' The x co-ordinate of the point to be looked at.
*'''y:''' The y co-ordinate of the point to be looked at.
*'''z:''' The z co-ordinate of the point to be looked at.

===Returns===
Returns a [[bool]] with a value of ''true'' if the function was successful, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">

function spawnScreen ( source ) --Calls the function spawnScreen
setCameraMode ( source, "fixed" ) --Classifies which camera mode to use for the spawn screen
setTimer ( "setCameraPosition", 1000, 1, source, 160.15, -1951.68, 50 ) --Coords for the fixated camera
setTimer ( "setCameraLookAt", 1000, 1, source, 165, -1951.68, 50 ) --Coords for the fixated camera. This will "point" the camera, so to speak.
bindKey ( source, "F1", "down", "spawnVagos" ) --Spawns player as team #1. In this case, a new function is created later on
bindKey ( source, "F2", "down", "spawnAztecs" ) --Spawns player as team #2. In this case, a new function is created later on
end
</syntaxhighlight>

==See Also==
{{Camera functions}}

SetCameraLookAt

2007-07-03T04:41:54Z

Xanarki: /* Example */

SetCameraMode

2007-07-03T04:39:56Z

Xanarki:

__NOTOC__
<h2 style="margin:0; background:#990000; font-size:120%; font-weight:bold; border:1px solid #a3bfb1; text-align:left; color:#fff; padding:0.2em 0.4em;">Please remember to set players camera mode back to "player" on resource unload, or you will encounter the invisible player 'bug' if players camera is still set to fixed</h2>

This function allows you to change a player's camera mode to either "player" or "fixed".

==Syntax==
<syntaxhighlight lang="lua">
bool setCameraMode ( player thePlayer, string mode )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player whose camera you wish to modify.
*'''mode:''' The mode to be set. It has the following possible values:
** '''"player":''' Sets the camera to follow a player.
** '''"fixed":''' Fixes the camera in a set position/rotation.

===Returns===
Returns a [[bool]] with a value of ''true'' if the function was successful, ''false'' otherwise.

==Example==

<syntaxhighlight lang="lua">

function spawnScreen ( source ) --Calls the function spawnScreen
setCameraMode ( source, "fixed" ) --Classifies which camera mode to use for the spawn screen
setTimer ( "setCameraPosition", 1000, 1, source, 160.15, -1951.68, 50 ) --Coords for the fixated camera
setTimer ( "setCameraLookAt", 1000, 1, source, 165, -1951.68, 50 ) --Coords for the fixated camera
bindKey ( source, "F1", "down", "spawnVagos" ) --Spawns player as team #1. In this case, a new function is created later on
bindKey ( source, "F2", "down", "spawnAztecs" ) --Spawns player as team #2. In this case, a new function is created later on
end
</syntaxhighlight>

==See Also==
{{Camera functions}}

SetCameraMode

2007-07-03T04:38:25Z

Xanarki: /* Example */

TextDestroyDisplay

2007-06-14T07:27:10Z

Xanarki:

__NOTOC__
This function destroys a text display and will unlink all the [[textitem]]s on it. This does not stop the textitems existing, but anyone who was observing the textitems through this display will stop seeing them.

==Syntax==
<syntaxhighlight lang="lua">
void textDestroyDisplay ( textdisplay display )
</syntaxhighlight>

===Required Arguments===
* '''display:''' This is the [[textdisplay]] that you wish to have destroyed.

==Example==
This example creates a display then destroys it again straight away.
<syntaxhighlight lang="lua">
myDisplay = textCreateDisplay ()
textDestroyDisplay ( myDisplay )
</syntaxhighlight>

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

Character Skins

2007-06-07T06:22:36Z

Xanarki:

Skins that the player may use (pedestrian skins).

[[All Skins Page]] - Not recommended for slow Internet

'''Sectioned Skin Pages:'''
----
*[[Skins Page 1]]: 7, 9-29
*[[Skins Page 2]]: 30-41, 43-52
*[[Skins Page 3]]: 53-64, 66-73, 75-76
*[[Skins Page 4]]: 77-85, 87-99
*[[Skins Page 5]]: 100-118, 120-122
*[[Skins Page 6]]: 123-144
*[[Skins Page 7]]: 145-148, 150-167
*[[Skins Page 8]]: 168-189
*[[Skins Page 9]]: 190-207, 209-212
*[[Skins Page 10]]: 213-234
*[[Skins Page 11]]: 235-238, 240-257
*[[Skins Page 12]]: 258-264, 274-288

==Notes:==
*22 Skins per page (minus CJ), 12 pages: 264 total.

*IDs 1-8 (except 7) are non-functional

*The following pairs of IDs produce same character (1st ID used in lists)
**78:239
**118:119
**148:149

==See Also==
[[id]]

User:Xanarki

2007-06-04T00:47:45Z

Xanarki:

NIИ