Multi Theft Auto: Wiki - User contributions [en]

GetPlayerFromSerial

2014-07-25T06:27:59Z

Teteomar:

{{Useful Function}}
__NOTOC__
This function gets an '''online''' player from their [[serial]].
==Syntax==
<syntaxhighlight lang="lua">player getPlayerFromSerial ( string serial )</syntaxhighlight>

===Required Arguments===
* '''serial''': A string determining the serial of player you want to get.

===Returns===
Returns a [[player]] element if the specified [[serial]] is owned by an existent player on the server, ''false'' otherwise.

==Code==
<section name="Function source" class="both" show="true"><syntaxhighlight lang="lua">
function getPlayerFromSerial ( serial )
assert ( type ( serial ) == "string" and #serial == 32, "getPlayerFromSerial - invalid serial" )
for index, player in ipairs ( getElementsByType ( "player" ) ) do
if ( getPlayerSerial ( player ) == serial ) then
return player
end
end
return false
end
</syntaxhighlight></section>

==Example==
This example gets a player name from random serial and outputs it in chatbox.
<syntaxhighlight lang="lua">
outputChatBox( getPlayerName ( getPlayerFromSerial( "AE9EP68QXKHW55LQIAL9C77Q9VJHA00M" ) ) )
</syntaxhighlight>

Author: Tete

Hint: This function can be useful for building up a serial-based system.

==See Also==
{{Useful_Functions}}

GetPlayerFromSerial

2014-07-25T06:27:17Z

Teteomar:

{{Useful Function}}
__NOTOC__
This function gets an '''online''' player from their [[serial]].
==Syntax==
<syntaxhighlight lang="lua">player getPlayerFromSerial ( string serial )</syntaxhighlight>

===Required Arguments===
* '''serial''': A string determining the serial of player you want to get.

===Returns===
Returns a [[player]] element if the specified [[serial]] is owned by an existent player on the server, ''false'' otherwise.

==Code==
<section name="Function source" class="both" show="true"><syntaxhighlight lang="lua">
function getPlayerFromSerial( serial )
assert ( type ( serial ) == "string" and #serial == 32, "getPlayerFromSerial - invalid serial" )
for index, player in ipairs ( getElementsByType ( "player" ) ) do
if ( getPlayerSerial ( player ) == serial ) then
return player
end
end
return false
end
</syntaxhighlight></section>

==Example==
This example gets a player name from random serial and outputs it in chatbox.
<syntaxhighlight lang="lua">
outputChatBox( getPlayerName ( getPlayerFromSerial( "AE9EP68QXKHW55LQIAL9C77Q9VJHA00M" ) ) )
</syntaxhighlight>

Author: Tete

Hint: This function can be useful for building up a serial-based system.

==See Also==
{{Useful_Functions}}

GetPlayerFromSerial

2014-07-25T06:18:48Z

Teteomar:

{{Useful Function}}
__NOTOC__
This function gets an '''online''' player from their [[serial]].
==Syntax==
<syntaxhighlight lang="lua">player getPlayerFromSerial ( string serial )</syntaxhighlight>

===Required Arguments===
* '''serial''': A string determining the serial of player you want to get.

===Returns===
Returns a [[player]] element if the specified [[serial]] is owned by an existent player on the server, ''false'' otherwise.

==Code==
<section name="Function source" class="both" show="true"><syntaxhighlight lang="lua">
function getPlayerFromSerial( serial )
assert ( type ( serial ) == "string" and #serial == 32, "getPlayerFromSerial - invalid serial" )
for index, player in ipairs ( getElementsByType ( "player" ) ) do
if ( getPlayerSerial ( player ) == serial ) then
return player
end
end
return false
end
</syntaxhighlight></section>

==Example==
This example gets a player name from random serial and outputs it in chatbox.
<syntaxhighlight lang="lua">
outputChatBox( getPlayerName ( getPlayerFromSerial( "AE9EP68QXKHW55LQIAL9C77Q9VJHA00M ) ) )
</syntaxhighlight>

Author: Tete

==See Also==
{{Useful_Functions}}

GetPlayerFromSerial

2014-07-25T06:15:09Z

Teteomar:

{{Useful Function}}
__NOTOC__
This function gets an '''online''' player from their serial.
==Syntax==
<syntaxhighlight lang="lua">player getPlayerFromSerial ( string serial )</syntaxhighlight>

===Required Arguments===
* '''serial''': A string determining the serial of player you want to get.

===Returns===
Returns a [[player]] element if the specified serial is owned by an existent player on the server, ''false'' otherwise.

==Code==
<section name="Function source" class="both" show="true"><syntaxhighlight lang="lua">
function getPlayerFromSerial( serial )
assert ( type ( serial ) == "string" and #serial == 32, "getPlayerFromSerial - invalid serial" )
for index, player in ipairs ( getElementsByType ( "player" ) ) do
if ( getPlayerSerial ( player ) == serial ) then
return player
end
end
return false
end
</syntaxhighlight></section>

==Example==
This example gets a player name from random serial and outputs it in chatbox.
<syntaxhighlight lang="lua">
outputChatBox( getPlayerName ( getPlayerFromSerial( "AE9EP68QXKHW55LQIAL9C77Q9VJHA00M ) ) )
</syntaxhighlight>

Author: Tete

==See Also==
{{Useful_Functions}}

GetPlayerFromSerial

2014-07-25T06:14:12Z

Teteomar:

{{Useful Function}}
__NOTOC__
This function gets an '''online''' player from their serial.
==Syntax==
<syntaxhighlight lang="lua">player getPlayerFromSerial ( string serial )</syntaxhighlight>

===Required Arguments===
* '''serial''': A string determining the serial of player you want to get.

===Returns===
Returns a [[player]] element if the specified serial is owned by an existent player on the server, ''false'' otherwise.

==Code==
<section name="Function source" class="both" show="true"><syntaxhighlight lang="lua">
function getPlayerFromSerial( serial )
assert ( assert ( type ( serial ) == "string" and #serial == 32, "getPlayerFromSerial - invalid serial" )
for index, player in ipairs ( getElementsByType ( "player" ) ) do
if ( getPlayerSerial ( player ) == serial ) then
return player
end
end
return false
end
</syntaxhighlight></section>

==Example==
This example gets a player name from random serial and outputs it in chatbox.
<syntaxhighlight lang="lua">
outputChatBox( getPlayerName ( getPlayerFromSerial( "AE9EP68QXKHW55LQIAL9C77Q9VJHA00M ) ) )
</syntaxhighlight>

Author: Tete

==See Also==
{{Useful_Functions}}

GetPlayerFromSerial

2014-07-25T06:05:01Z

Teteomar:

{{Useful Function}}
__NOTOC__
This function gets an '''online''' player from their serial.
==Syntax==
<syntaxhighlight lang="lua">player getPlayerFromSerial ( string serial )</syntaxhighlight>

===Required Arguments===
* '''serial''': A string determining the serial of player you want to get.

===Returns===
Returns a [[player]] element if the player who has the serial and this player must be online, ''false'' otherwise.

==Code==
<section name="Function source" class="both" show="true"><syntaxhighlight lang="lua">
function getPlayerFromSerial( serial )
assert ( type ( serial ) == "string", "getPlayerFromSerial - serial is not a string" )
assert ( #serial == 32, "getPlayerFromSerial - invalid serial" )
for index, player in ipairs ( getElementsByType ( "player" ) ) do
if ( getPlayerSerial ( player ) == serial ) then
return player
end
end
return false
end
</syntaxhighlight></section>

==Example==
This example gets a player name from random serial and outputs it in chatbox.
<syntaxhighlight lang="lua">
outputChatBox(getPlayerName(getPlayerFromSerial("05DWR04DQEFGBGN81DDMS12RF4S5QN")))
</syntaxhighlight>

Author: Tete

==See Also==
{{Useful_Functions}}

IsWorldSoundEnabled

2014-06-27T11:41:58Z

Teteomar: Added an example.

__NOTOC__
{{New items|3.0140|1.3.1|
{{Client function}}
This function allows you to check if certain world sound effects have not been disabled by [[setWorldSoundEnabled]]
}}
==Syntax==
<syntaxhighlight lang="lua">
bool isWorldSoundEnabled( int group, [ int index = -1 ] )
</syntaxhighlight>

===Required Arguments===
*'''group :''' An integer representing the world sound group

===OptionalArguments===
*'''index :''' An integer representing an individual sound within the group

===Returns===
Returns ''true'' if the world sounds are enabled, ''false'' if they are disabled or invalid values were passed.

==Example==
This is a simplified example that lets the client toggle their weapon sounds.
<syntaxhighlight lang="lua">
function toggleWeaponSounds_f ( )
local enabled = isWorldSoundEnabled ( 5 ) -- We place this variable here for checking.
enabled = not enabled -- And here we invert (toggle) the variable, so if it's false, it becomes true, if it's true, it becomes false.
-- Used for the chat declaration:
local state = "enabled"

if ( not enabled ) then
state = "disabled"
end
--

setWorldSoundEnabled ( 5, enabled ) -- And here the toggling happens.
outputChatBox ( "Weapon sounds " .. state )
end
addCommandHandler ( "toggleweaponsounds", toggleWeaponSounds_f )
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3.0-9.04134|}}

==See Also==
{{Client world functions}}

SetWorldSoundEnabled

2014-06-27T11:33:05Z

Teteomar: Added a more accurate example.

__NOTOC__
{{Client function}}
{{New items|3.0131|1.3.1|
This function allows you to disable world sounds. A world sound is a sound effect which has '''''not''''' been caused by [[playSound]] or [[playSound3D]].

Note: The values for ''group'' and ''index'' can be determined by using the client command [[Client_Commands#showsound|showsound]] in conjunction with [[setDevelopmentMode]]
}}

{{Note box|See Also: [[setAmbientSoundEnabled]]}}
==Syntax==
<syntaxhighlight lang="lua">
bool setWorldSoundEnabled( int group, [ int index = -1, ] bool enable )
</syntaxhighlight>

===Required Arguments===
*'''group :''' An integer representing the world sound group
*'''enable :''' Set ''false'' to disable, ''true'' to enable

===OptionalArguments===
*'''index :''' An integer representing an individual sound within the group

===Returns===
Returns ''true'' if the world sound was correctly enabled/disabled, ''false'' if invalid values were passed.

==Example==
This is a simplified example that lets the client toggle their weapon sounds.
<syntaxhighlight lang="lua">
function toggleWeaponSounds_f ( )
local enabled = isWorldSoundEnabled ( 5 ) -- We place this variable here for checking.
enabled = not enabled -- And here we invert (toggle) the variable, so if it's false, it becomes true, if it's true, it becomes false.
-- Used for the chat declaration:
local state = "enabled"

if ( not enabled ) then
state = "disabled"
end
--

setWorldSoundEnabled ( 5, enabled ) -- And here the toggling happens.
outputChatBox ( "Weapon sounds " .. state )
end
addCommandHandler ( "toggleweaponsounds", toggleWeaponSounds_f )
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3.0-9.04134|}}

==See Also==
{{Client world functions}}