Multi Theft Auto: Wiki - User contributions [en]

GuiSetFont

2008-04-28T08:45:32Z

Stevvo: Undo revision 16633 by Stevvo (Talk) Asshat next to me pressed random keys on edit page.jhg

{{Client function}}
__NOTOC__
This function sets the font of a GUI element to be used when drawing text.

==Syntax==
<syntaxhighlight lang="lua">
bool guiSetFont ( element guiElement, string font )
</syntaxhighlight>

===Required Arguments===
*'''guiElement:''' The GUI element you wish to change the font of
*'''font:''' The font name. See [[GUI Fonts]]

===Returns===
Returns ''true'' if the font has been successfully set on the gui element, ''false'' otherwise.

==Example==

This example sets and gets the font of a pre-made gui element and outputs it to chat box.

<syntaxhighlight lang="lua">
-- We create a dummy gui label to get text of
local dummyGUIElement = guiCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true )
guiSetFont ( dummyGUIElement, "sa-gothic" )
-- Output the font of the label to chat box
outputChatBox ( "Font used in the GUI label: " .. guiGetFont ( dummyGuiElement ) )
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GuiSetFont

2008-04-28T08:44:27Z

Stevvo: /* See Also */

XmlFindSubNode

2008-04-27T19:23:07Z

Stevvo: Removed semicolons from example, it isn't normal to use semicolons in lua?

__NOTOC__
{{Server client function}}
This function returns a named sub node of a particular XML node.

==Syntax==
<syntaxhighlight lang="lua">xmlnode xmlFindSubNode ( xmlnode parent, string subnode, int index )</syntaxhighlight>

===Required Arguments===
* '''parent''': This is an [[xmlnode]] that you want to find the subnode under. This could be a node returned from another call to [[xmlFindSubNode]].
* '''subnode''': This is the name of the subnode you wish to find.
* '''index''': This is the index of the node you wish to find. For example, to find the 5th subnode with a particular name, you would use 4 as the index value. To find the first occurence, use 0.

===Returns===
Returns an [[xmlnode]] object if the node was found, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
If you wanted to find the 'instructions' node in a map file like this:
<syntaxhighlight lang="xml">
<map version="2.0">
<options>
<instructions>Start at the begining and keep going until the end!</instructions>
</options>
</map>
</syntaxhighlight>

You could use the following code:
<syntaxhighlight lang="lua">
maproot = getLoadedMapXMLRoot ()
optionsnode = xmlFindSubNode ( maproot, "options", 0 )
instructionsnode = xmlFindSubNode ( optionsnode, "instructions", 0 )
</syntaxhighlight>

Note: You could use [[getMapOption]] to do the same thing.
</section>

==See Also==
{{XML functions}}

Help:Main Page

2008-04-25T12:18:34Z

Stevvo: Irrelevant content: Undo revision 16607 by KANiS (Talk)

Can you please add a link to the Italian main page(<nowiki>[[it:Pagina principale]]</nowiki>)? Thanks.<br/><span style="font-family:Courier New, Courier, monospace">[[User:Shadd|Shadd]]</span><sub>([[User_talk:Shadd|Сто?]])</sub> 11:49, 25 January 2008 (CST)
:Done :) Keep up the good work! [[User:EAi|eAi]] 20:06, 25 January 2008 (CST)

The Dutch one too please (<nowiki>[[nl:Main Page]]</nowiki>)? :P
:Done :) [[User:EAi|eAi]] 11:24, 26 January 2008 (CST)

<br/>
http://development.mtasa.com/index.php?title=Vehicle_Upgrades
There is no link in 'Vehicle Upgrades' in the 'ID list'. I already knew that there is this page, but unfortunately we can't modify this page... :( <br/> [[User:Atti|Atti]] 03:29, 27 January 2008 (CST)

Talk:CreateProjectile

2008-04-19T11:19:12Z

Stevvo:

If it isn't too much hastle could you add support for rocket id 58 in the future? You can set it at an offset of +0 at 0xC891A8 just like 19 and 20 for the normal rockets, however this function returns false if an ID that it deems invalid is passed through it.--[[User:Stevvo|Stevvo]] 17:14, 18 April 2008 (CDT)
:We could arrange that, I'm not sure why we haven't already got it. ['''Note to someone in QA''', can you add an issue for this (just that we should have projectile id 58, we don't need the offset stuff)?] [[User:EAi|eAi]] 19:38, 18 April 2008 (CDT)
::Thanks, much appreciated :D--[[User:Stevvo|Stevvo]] 06:19, 19 April 2008 (CDT)

Talk:CreateProjectile

2008-04-18T22:14:08Z

Stevvo: New page: If it isn't too much hastle could you add support for rocket id 58 in the future? You can set it at an offset of +0 at 0xC891A8 just like 19 and 20 for the normal rockets, however this fun...

Talk:Weather

2008-04-18T04:08:46Z

Stevvo:

The page lists ID's up to 45, however the setWeather() function returns false if you try to set an ID over 19, should those above 19 be removed?
It is possible to use all the IDs listed on the page by manually editing the memory of your game.
:Are the IDs over 19 useful? Remove them for now, but if they're useful we can consider re-adding them. [[User:EAi|eAi]] 17:34, 17 April 2008 (CDT)
They could be usefull after a future build is released if the Weather scripting functions are changed to allow ID's over 19.--[[User:Stevvo|Stevvo]] 23:08, 17 April 2008 (CDT)

Weather

2008-04-18T04:06:30Z

Stevvo:

Weather can be changed using [[setWeather]] and [[setWeatherBlended]].
==Weather IDs==
* '''0 to 7:''' Different Versions of Blue Skies / Clouds
* '''8:''' Stormy
* '''9:''' Cloudy and Foggy
* '''10:''' Clear Blue Sky
* '''11:''' Scorching Hot (Los Santos heat waves)
* '''12 to 15:''' Very Dull, Colourless, Hazy
* '''16:''' Dull, Cloudy, Rainy
* '''17 to 18:''' Scorching Hot
* '''19:''' Sandstorm

Talk:Weather

2008-04-17T19:36:27Z

Stevvo: New page: The page lists ID's up to 45, however the setWeather() function returns false if you try to set an ID over 19, should those above 19 be removed? It is possible to use all the IDs listed on...

Talk:SetWeather

2008-04-17T19:34:50Z

Stevvo: New page: Could you remove the check that looks if the weather id is below 19 in a future build? The weather id page lists weathers up to 45, manually editing the memory i have had success with weat...

Could you remove the check that looks if the weather id is below 19 in a future build?
The weather id page lists weathers up to 45, manually editing the memory i have had success with weather IDs as high as 900.
Some weather IDs, such as 700 produce really crazy effects that are similar to a nuke going off, there could be some creative use for these.

SetGameSpeed

2008-04-02T15:43:17Z

Stevvo: Confirmed to work client-side

__NOTOC__
{{Server client function}}
==Description==
This function sets the game speed to the given value.

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

===Required Arguments===
*'''value''': The int value of the game speed (Range 0 - 10)

==Example==
<syntaxhighlight lang="lua">
function gamespeedfunction ( sourcePlayer, command, value )
setGameSpeed ( tonumber ( value ) )
end
addCommandHandler ( "setgamespeed", gamespeedfunction )
</syntaxhighlight>

==See Also==
{{World functions}}

SetGameSpeed

2008-04-02T15:25:25Z

Stevvo:

{{Needs Checking| Is this function implemented client-side? if so, does it work correctly client-side? }}
__NOTOC__
{{Server client function}}
==Description==
This function sets the game speed to the given value.

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

===Required Arguments===
*'''value''': The int value of the game speed (Range 0 - 10)

==Example==
<syntaxhighlight lang="lua">
function gamespeedfunction ( sourcePlayer, command, value )
setGameSpeed ( tonumber ( value ) )
end
addCommandHandler ( "setgamespeed", gamespeedfunction )
</syntaxhighlight>

==See Also==
{{World functions}}

Talk:PreloadMissionAudio

2008-04-02T12:54:10Z

Stevvo: New page: Looks like the code for this function is fully working, but it has been left out for some reason? Any word on when it will be added? Sooner rather than later would be nice.

Looks like the code for this function is fully working, but it has been left out for some reason? Any word on when it will be added? Sooner rather than later would be nice.

Talk:PlayMissionAudio

2008-04-02T12:53:02Z

Stevvo: New page: Looks like the code for this function is fully working, but it has been left out for some reason? Any word on when it will be added? Sooner rather than later would be nice.

Looks like the code for this function is fully working, but it has been left out for some reason?
Any word on when it will be added? Sooner rather than later would be nice.

CreatePed

2008-03-14T17:56:33Z

Stevvo:

__NOTOC__
{{Server client function}}
Creates a Ped in the GTA world.

==Syntax==
<syntaxhighlight lang="lua">ped createPed ( int modelid, float x, float y, float z, float r )</syntaxhighlight>

===Required Arguments===
*'''modelid:''' A whole integer specifying the GTASA skin ID.
*'''x:''' A floating point number representing the X coordinate on the map.
*'''y:''' A floating point number representing the Y coordinate on the map.
*'''z:''' A floating point number representing the Z coordinate on the map.

===Returns===
Unknown, possibly the element of the ped?

==Example==
This example creates an ped when the map starts:
<syntaxhighlight lang="lua">
function pedLoad ( name )
-- create an object at a specified position with a specified rotation
createPed ( 120, 5540.6654, 1020.55122, 1240.545 )
end
addEventHandler ( "onResourceStart", getRootElement(), pedLoad )
</syntaxhighlight>

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

CreatePed

2008-03-13T21:45:26Z

Stevvo: New page: __NOTOC__ {{Server client function}} Creates a Ped in the GTA world. ==Syntax== <syntaxhighlight lang="lua">object createPed ( int modelid, float x, float y, float z, float r )</syntaxhighlight> ===Required Ar...

__NOTOC__
{{Server client function}}
Creates a Ped in the GTA world.

==Syntax==
<syntaxhighlight lang="lua">object createPed ( int modelid, float x, float y, float z, float r )</syntaxhighlight>

===Required Arguments===
*'''modelid:''' A whole integer specifying the GTASA skin ID.
*'''x:''' A floating point number representing the X coordinate on the map.
*'''y:''' A floating point number representing the Y coordinate on the map.
*'''z:''' A floating point number representing the Z coordinate on the map.

===Returns===
Unknown

==Example==
This example creates an ped when the map starts:
<syntaxhighlight lang="lua">
function pedLoad ( name )
-- create an object at a specified position with a specified rotation
createPed ( 120, 5540.6654, 1020.55122, 1240.545 )
end
addEventHandler ( "onResourceStart", getRootElement(), pedLoad )
</syntaxhighlight>

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

SetAccountData

2008-01-06T16:30:22Z

Stevvo:

{{Server function}}
__NOTOC__
{{Note_box|It is strongly recommended that you use the standard ''module.key'' naming for your keys, as shown in the example below. This prevents collisions between different scripts.}}
This function sets a string to be stored in an account. This can then be retrieved using [[getAccountData]]. Data stored as account data is persistent across user's sessions and maps, unless they are logged into a guest account.

NOTE: Editing account data while the server is running currently deletes the account.

==Syntax==
<syntaxhighlight lang="lua">
bool setAccountData ( account theAccount, string key, string value )
</syntaxhighlight>

===Required Arguments===
*'''theAccount:''' The account you wish to retrieve the data from.
*'''key:''' The key under which you wish to store the data
*'''value:''' The value you wish to store

===Returns===
Returns a ''true'' if the account data was set, ''false'' if an invalid argument was specified.

==Example==
For a pirate roleplaying gametype, the amount of money a player has is made persistent by storing it in his account. Note the code uses "piraterpg.money" as key instead of just "money", as the player may be participating in other gametypes that also save his money amount to his account. If both gametypes would use "money" as the account key, they'd overwrite each other's data.
<syntaxhighlight lang="lua">
function onPlayerQuit ( )
-- when a player leaves, store his current money amount in his account data
local playeraccount = getClientAccount ( source )
if ( playeraccount ) then
local playermoney = getPlayerMoney ( source )
setAccountData ( playeraccount, "piraterpg.money", playermoney )
end
end

function onPlayerJoin ( )
-- when a player joins, retrieve his money amount from his account data and set it
local playeraccount = getClientAccount ( source )
if ( playeraccount ) then
local playermoney = getAccountData ( playeraccount, "piraterpg.money" )
-- make sure there was actually a value saved under this key (check if playermoney is not false).
-- this will for example not be the case when a player plays the gametype for the first time
if ( playermoney ) then
setPlayerMoney ( source, playermoney )
end
end
end

addEventHandler ( "onPlayerQuit", getRootElement ( ), onPlayerQuit )
addEventHandler ( "onPlayerJoin", getRootElement ( ), onPlayerJoin )
</syntaxhighlight>

==See Also==
{{Account_functions}}
[[Category:Incomplete]]