Multi Theft Auto: Wiki - User contributions [en]

SetMaxPlayers

2011-09-04T13:05:39Z

OpenIDUser28:

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

'''Note''': the maximum this function can set is what is defined in mtaserver.conf

==Syntax==
<syntaxhighlight lang="lua">bool setMaxPlayers ( int slots )</syntaxhighlight>

===Required Arguments===

*'''slots:''' Maximum number of player slots on the server.

===Returns===

Returns ''true'' if number of player slots was successfully changed, ''false'' or ''nil'' otherwise.

==Example==
This example set server slots count to half value from current value.
<syntaxhighlight lang="lua">
local curMaxPlayers = getMaxPlayers()
local newMaxPlayers = math.ceil( curMaxPlayers / 2 )

setMaxPlayers( newMaxPlayers )
</syntaxhighlight>

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

ResetRainLevel

2011-09-04T12:58:21Z

OpenIDUser28: Extended the info.

__NOTOC__
{{Server client function}}
This function resets the rain level of the current weather to its default.

==Syntax==
<syntaxhighlight lang="lua">
bool resetRainLevel ( )
</syntaxhighlight>

==Returns==
Returns true if the rain level was reseted.

ResetWaterColor

2011-09-04T12:38:06Z

OpenIDUser28:

__NOTOC__
{{Server client function}}
This function reset the water color of the GTA world to default.

{{New_feature|3.0110|1.1|
Available server-side. Only available client-side for 1.0.x
}}

==Syntax==
<syntaxhighlight lang="lua">
bool resetWaterColor ( )
</syntaxhighlight>

===Returns===
Returns ''true'' if water color was reset correctly, ''false'' otherwise.

==Example==
This example adds a command ''resetwatercolor'' with which a player can reset the water colour.
<syntaxhighlight lang="lua">
function changeWaterBackToNormal ()
resetWaterColor ()
end
addCommandHandler ( "resetwatercolor", changeWaterBackToNormal )
</syntaxhighlight>

==See Also==
{{Client water functions}}

GetRainLevel

2011-09-04T12:34:34Z

OpenIDUser28: Extended the info.

__NOTOC__
{{Server client function}}
This function is used to get the current rain level.

'''Note:''' The server can only return the rain level if it has actually been set by script, otherwise it will return ''false''.

==Syntax==
<syntaxhighlight lang="lua">
float getRainLevel( )
</syntaxhighlight>

===Returns===
Returns the rain level as a number.

SetRainLevel

2011-09-04T12:22:04Z

OpenIDUser28:

__NOTOC__
{{Server client function}}
This function sets the rain level to any weather available in GTA. Use [[resetRainLevel]] to undo the changes.

==Syntax==
<syntaxhighlight lang="lua">
bool setRainLevel ( float level )
</syntaxhighlight>

===Required Arguments===
*'''level:''' A floating point number representing the rain level.

===Returns===
Returns ''true'' if the rain level was set, ''false'' otherwise.

SetRainLevel

2011-09-04T12:20:51Z

OpenIDUser28:

__NOTOC__
{{Server client function}}
This function sets the rain level to any weather available in GTA. Use [[resetRainLevel]] to undo the changes.

==Syntax==
<syntaxhighlight lang="lua">
bool setRainLevel ( float level )
</syntaxhighlight>

===Required Arguments===
*'''level:''' A floating point number representing the rain level.

===Returns===
Returns true if the rain level was set, ''false'' otherwise.

SetRainLevel

2011-09-04T12:14:47Z

OpenIDUser28: Extended the info.

__NOTOC__
{{Server client function}}
This function sets the rain level to any weather available in GTA. Use [[resetRainLevel]] to undo the changes.

==Syntax==
<syntaxhighlight lang="lua">
bool setRainLevel ( float Level )
</syntaxhighlight>

===Required Arguments===
*'''Level:''' A floating point number representing the rain level.

===Returns===
Returns true if the rain level was set, ''false'' otherwise.

CreatePed

2011-09-04T01:23:52Z

OpenIDUser28: Server and Client Side Syntax

__NOTOC__
{{Server client function}}
{{Needs_Checking|Please check if I'm right with the bSynced argument. I've been testing two different peds and discovered the effect written below --[[User:OpenIDUser28|Sniper]] 03:12, 4 September 2011 (CEST)}}
Creates a Ped in the GTA world.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">ped createPed ( int modelid, float x, float y, float z [, float rot = 0.0, bool bSynced = true ] )</syntaxhighlight>

===Required Arguments===
*'''modelid:''' A whole integer specifying the [[Character_Skins|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.

==Optional Arguments==
{{OptionalArg}}
*'''rot:''' A floating point number representing the rotation in degrees.
*'''bSynced:''' A boolean value representing whether or not the ped will be fully synchronized even for players that are not within the syncing range. If disabled a player that is more than 100 units away from the ped won't receive any new information about its state and position. This will cause a desync of the ped (useful for frozen/static peds to increase the server perfomance).
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">ped createPed ( int modelid, float x, float y, float z [, float rot = 0.0 ] )</syntaxhighlight>

===Required Arguments===
*'''modelid:''' A whole integer specifying the [[Character_Skins|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.

==Optional Arguments==
{{OptionalArg}}
*'''rot:''' A floating point number representing the rotation in degrees.
</section>

===Returns===
Returns a ped element if it was successfully created.

==Example==

<section name="Server" class="server" show="true">
This example creates an ped when the resource starts:
<syntaxhighlight lang="lua">
function pedLoad ( name )
createPed ( 120, 5540.6654, 1020.55122, 1240.545 )
end
addEventHandler ( "onResourceStart", getRootElement(), pedLoad )
</syntaxhighlight>
</section>

==See Also==
{{Ped functions}}
[[ru:createPed]]

CreatePed

2011-09-04T01:13:10Z

OpenIDUser28: /* Required Arguments */

__NOTOC__
{{Server client function}}
{{Needs_Checking|Please check if I'm right with the bSynced argument. I've been testing two different peds and discovered the effect written below --[[User:OpenIDUser28|Sniper]] 03:12, 4 September 2011 (CEST)}}
Creates a Ped in the GTA world.

==Syntax==
<syntaxhighlight lang="lua">ped createPed ( int modelid, float x, float y, float z [, float rot = 0.0, bool bSynced = true ] )</syntaxhighlight>

===Required Arguments===
*'''modelid:''' A whole integer specifying the [[Character_Skins|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.
*'''rot:''' A floating point number representing the rotation in degrees.
*'''bSynced:''' A boolean value representing whether or not the ped will be fully synchronized even for players that are not within the syncing range. If disabled a player that is more than 100 units away from the ped won't receive any new information about its state and position. This will cause a desync of the ped (useful for frozen/static peds to increase the server perfomance).

===Returns===
Returns a ped element if it was successfully created, ''nil'' if an invalid element is passed.

==Example==

<section name="Server" class="server" show="true">
This example creates an ped when the resource starts:
<syntaxhighlight lang="lua">
function pedLoad ( name )
createPed ( 120, 5540.6654, 1020.55122, 1240.545 )
end
addEventHandler ( "onResourceStart", getRootElement(), pedLoad )
</syntaxhighlight>
</section>

==See Also==
{{Ped functions}}
[[ru:createPed]]

CreatePed

2011-09-04T01:12:14Z

OpenIDUser28: Added the bSynced argument

__NOTOC__
{{Server client function}}
{{Needs_Checking|Please check if I'm right with the bSynced argument. I've been testing two different peds and discovered the effect written below --[[User:OpenIDUser28|Sniper]] 03:12, 4 September 2011 (CEST)}}
Creates a Ped in the GTA world.

==Syntax==
<syntaxhighlight lang="lua">ped createPed ( int modelid, float x, float y, float z [, float rot = 0.0, bool bSynced = true ] )</syntaxhighlight>

===Required Arguments===
*'''modelid:''' A whole integer specifying the [[Character_Skins|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.
*'''rot:''' A floating point number representing the rotation in degrees.
*'''bSynced:''' A boolean value representing whether or not the ped will be fully synchronized even for players that are not within the syncing range. If disabled a player that is more than 100 units away from the ped won't receive new information about its state and position. This will cause a desync of the ped (useful for frozen/static peds to increase the server perfomance).

===Returns===
Returns a ped element if it was successfully created, ''nil'' if an invalid element is passed.

==Example==

<section name="Server" class="server" show="true">
This example creates an ped when the resource starts:
<syntaxhighlight lang="lua">
function pedLoad ( name )
createPed ( 120, 5540.6654, 1020.55122, 1240.545 )
end
addEventHandler ( "onResourceStart", getRootElement(), pedLoad )
</syntaxhighlight>
</section>

==See Also==
{{Ped functions}}
[[ru:createPed]]

Talk:Test

2011-09-03T22:54:28Z

OpenIDUser28: Blanked the page

Talk:Test

2011-09-03T22:38:14Z

OpenIDUser28: Created page with "{{Needs Checking|Please remove this --~~~~}}"

{{Needs Checking|Please remove this --[[User:OpenIDUser28|Sniper]] 00:38, 4 September 2011 (CEST)}}

Switching From Race

2011-09-03T22:32:41Z

OpenIDUser28: Redirection added

#REDIRECT [[Switching from Race]]

OnMapLoad

2011-09-03T22:14:22Z

OpenIDUser28: A small edit to mine before

__NOTOC__
{{Needs Checking|This event does not exist anymore. Remove? --[[User:OpenIDUser28|Sniper]] 00:13, 4 September 2011 (CEST)}}
This event is triggered when a map is loaded.

==Syntax==
<syntaxhighlight lang="lua">
void onMapLoad ( string name )
</syntaxhighlight>

==Variables==
* The source of this event refers to the loaded map.
*'''name''': A string representing the name of the map

==Example==
This example displays a message in the textbox when you load a map containing this lua
<syntaxhighlight lang="lua">
addEventHandler ( "onMapLoad", getRootElement(), "mapLoadChatBoxOutput" )
function mapLoadChatBoxOutput ( name )
outputChatBox ( "Map "..name.." Loaded", root, 255, 255, 255 )
end
</syntaxhighlight>

==See Also==
{{Event_functions}}

OnMapLoad

2011-09-03T22:13:23Z

OpenIDUser28: Needs Checking: Event does not exist

__NOTOC__
This event is triggered when a map is loaded.
{{Needs Checking|This event does not exist anymore. Remove? --[[User:OpenIDUser28|Sniper]] 00:13, 4 September 2011 (CEST)}}
==Syntax==
<syntaxhighlight lang="lua">
void onMapLoad ( string name )
</syntaxhighlight>

==Variables==
* The source of this event refers to the loaded map.
*'''name''': A string representing the name of the map

==Example==
This example displays a message in the textbox when you load a map containing this lua
<syntaxhighlight lang="lua">
addEventHandler ( "onMapLoad", getRootElement(), "mapLoadChatBoxOutput" )
function mapLoadChatBoxOutput ( name )
outputChatBox ( "Map "..name.." Loaded", root, 255, 255, 255 )
end
</syntaxhighlight>

==See Also==
{{Event_functions}}

OnMapUnload

2011-09-03T22:11:07Z

OpenIDUser28: A small edit to mine before

[[Category:Incomplete Event]]
{{Needs Checking|This event does not exist anymore. Remove? --[[User:OpenIDUser28|Sniper]] 00:11, 4 September 2011 (CEST)}}
This event is triggered when the map is changed or unloaded.

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

<syntaxhighlight lang="lua">

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

</syntaxhighlight>

OnMapUnload

2011-09-03T22:04:27Z

OpenIDUser28: Needs Checking: Event does not exist

[[Category:Incomplete Event]]
{{Needs Checking|This event does not exist. It's an internal event taken from the tdma gamemode. The example is useless also. Remove or can somebody finish it? --[[User:OpenIDUser28|Sniper]] 00:04, 4 September 2011 (CEST)}}
This event is triggered when the map is changed or unloaded.

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

<syntaxhighlight lang="lua">

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

</syntaxhighlight>

Spawnpoint

2011-09-03T21:53:02Z

OpenIDUser28: Updated the link.

#REDIRECT [[Resource:Spawnmanager]]

SetMaxPlayers

2011-09-03T21:48:41Z

OpenIDUser28: Needs Checking: Example Wrong

__NOTOC__
{{Needs Checking|Example wrong. Can't increase slots since the maximum you can set is what is defined in the mtaserver.conf. --[[User:OpenIDUser28|Sniper]] 23:48, 3 September 2011 (CEST)}}
{{Server function}}
This function set the maximum number of player slots on the server. Note: the maximum this function can set is what is defined in mtaserver.conf

==Syntax==
<syntaxhighlight lang="lua">bool setMaxPlayers ( int slots )</syntaxhighlight>

===Required Arguments===

*'''slots:''' Maximum number of player slots on the server.

===Returns===

Returns ''true'' if number of player slots was successfully changed, ''false'' or ''nil'' otherwise.

==Example==
This example increases server slots count if server is full.
<syntaxhighlight lang="lua">
addEventHandler( "onPlayerJoin", root,
function()
local nowPlayers = getPlayerCount()
local maxPlayers = getMaxPlayers()

if nowPlayers and maxPlayers and nowPlayers >= maxPlayers then
setMaxPlayers( maxPlayers + 1 )
end
end
)</syntaxhighlight>

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

User:OpenIDUser28

2011-09-03T21:32:33Z

OpenIDUser28: Created page with "This is SHC//Sniper from the SHC DD/DM server helping to provide fixes to the MTA wiki!"

This is SHC//Sniper from the SHC DD/DM server helping to provide fixes to the MTA wiki!