Multi Theft Auto: Wiki - User contributions [en]

OnPlayerJoin

2008-08-25T20:14:47Z

Syytuvanaema: /* Example */

__NOTOC__
{{Server event}}
This event is triggered when a player joins the server.

==Parameters==
No parameters.

==Source==
The source of this event is the [[player]] who joined.

==Example==
This example gets the joined client's name and sends him a welcome message including his name.

<syntaxhighlight lang="lua">
-- we register greetPlayer as a handler for the event
function greetPlayer ( )
-- we store the player's name
local joinedPlayerName = getClientName ( source )
local serverName = getServerName( )
-- and send him a greeting
outputChatBox ( "Welcome " .. joinedPlayerName .. " to ".. serverName .."!" , source, 255, 255, 255 )
end
addEventHandler ( "onPlayerJoin", getRootElement(), greetPlayer )
</syntaxhighlight>
This example sets random color to every player who joins.
<syntaxhighlight lang="lua">
-- sets colors when player join
function onJoin ()
g_Red, g_Green, g_Blue = randInt (50, 255), randInt (50, 255), randInt (50, 255)
end
-- checks if player has sent a message
function onChat ( message, messageType )
if messageType == 0 then
local root = getRootElement()
outputChatBox ( getClientName ( source ) .. ": #E0D0B0" .. message, getRootElement(), g_Red, g_Green, g_Blue, true )
cancelEvent()
end
end
addEventHandler ( "onPlayerJoin", getRootElement(), onJoin)
addEventHandler ( "onPlayerChat", getRootElement(), onChat )
</syntaxhighlight>

{{See also/Server event|Player events}}

OnPlayerChat

2008-08-25T20:14:13Z

Syytuvanaema: /* Example */

__NOTOC__
{{Server event}}
This event is triggered when a player chats inside the chat box.

==Parameters==
<syntaxhighlight lang="lua">
string message, int messageType
</syntaxhighlight>

*'''message''': A string representing the message typed into the chat.
*'''messageType''': An integer value representing the message type:
**'''0''': normal message
**'''1''': action message (/me)
**'''2''': team message

==Source==
The [[event system#Event source|source]] of this event is the [[player]] who sent the chatbox message.

==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the game's chat system won't deliver the posts. You may use [[outputChatBox]] to send the messages then.

==Example==
This example limits receiving of chat messages to a spherical area around the player who sent the message, also blocking action and team text.
<syntaxhighlight lang="lua">
-- define our chat radius
local chatRadius = 20 --units

-- define a handler that will distribute the message to all nearby players
function sendMessageToNearbyPlayers( message, messageType )
-- we will only send normal chat messages, action and team types will be ignored
if messageType == 0 then
-- get the chatting player's position
local posX, posY, posZ = getElementPosition( source )

-- create a sphere of the specified radius in that position
local chatSphere = createColSphere( posX, posY, posZ, chatRadius )
-- get a table all player elements inside it
local nearbyPlayers = getElementsWithinColShape( chatSphere, "player" )
-- and destroy the sphere, since we're done with it
destroyElement( chatSphere )

-- deliver the message to each player in that table
for index, nearbyPlayer in ipairs( nearbyPlayers ) do
outputChatBox( message, nearbyPlayer )
end
end
end
-- attach our new chat handler to onPlayerChat
addEventHandler( "onPlayerChat", getRootElement(), sendMessageToNearbyPlayers )

-- define another handler function that cancels the event so that the message won't be delivered through the
function blockChatMessage()
cancelEvent()
end
-- attach it as a handler to onPlayerChat
addEventHandler( "onPlayerChat", getRootElement(), blockChatMessage )
</syntaxhighlight>
This example sets random color to every player who joins.
<syntaxhighlight lang="lua">
-- sets colors when player join
function onJoin ()
g_Red, g_Green, g_Blue = randInt (50, 255), randInt (50, 255), randInt (50, 255)
end
-- checks if player has sent a message
function onChat ( message, messageType )
if messageType == 0 then
local root = getRootElement()
outputChatBox ( getClientName ( source ) .. ": #E0D0B0" .. message, getRootElement(), g_Red, g_Green, g_Blue, true )
cancelEvent()
end
end
addEventHandler ( "onPlayerJoin", getRootElement(), onJoin)
addEventHandler ( "onPlayerChat", getRootElement(), onChat )
</syntaxhighlight>

{{See also/Server event|Player events}}

OnPlayerChat

2008-08-25T20:13:44Z

Syytuvanaema: /* Example */

__NOTOC__
{{Server event}}
This event is triggered when a player chats inside the chat box.

==Parameters==
<syntaxhighlight lang="lua">
string message, int messageType
</syntaxhighlight>

*'''message''': A string representing the message typed into the chat.
*'''messageType''': An integer value representing the message type:
**'''0''': normal message
**'''1''': action message (/me)
**'''2''': team message

==Source==
The [[event system#Event source|source]] of this event is the [[player]] who sent the chatbox message.

==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the game's chat system won't deliver the posts. You may use [[outputChatBox]] to send the messages then.

==Example==
This example limits receiving of chat messages to a spherical area around the player who sent the message, also blocking action and team text.
<syntaxhighlight lang="lua">
-- define our chat radius
local chatRadius = 20 --units

-- define a handler that will distribute the message to all nearby players
function sendMessageToNearbyPlayers( message, messageType )
-- we will only send normal chat messages, action and team types will be ignored
if messageType == 0 then
-- get the chatting player's position
local posX, posY, posZ = getElementPosition( source )

-- create a sphere of the specified radius in that position
local chatSphere = createColSphere( posX, posY, posZ, chatRadius )
-- get a table all player elements inside it
local nearbyPlayers = getElementsWithinColShape( chatSphere, "player" )
-- and destroy the sphere, since we're done with it
destroyElement( chatSphere )

-- deliver the message to each player in that table
for index, nearbyPlayer in ipairs( nearbyPlayers ) do
outputChatBox( message, nearbyPlayer )
end
end
end
-- attach our new chat handler to onPlayerChat
addEventHandler( "onPlayerChat", getRootElement(), sendMessageToNearbyPlayers )

-- define another handler function that cancels the event so that the message won't be delivered through the
function blockChatMessage()
cancelEvent()
end
-- attach it as a handler to onPlayerChat
addEventHandler( "onPlayerChat", getRootElement(), blockChatMessage )
</syntaxhighlight>
This example sets random color to every player who join.
<syntaxhighlight lang="lua">
-- sets colors when player join
function onJoin ()
g_Red, g_Green, g_Blue = randInt (50, 255), randInt (50, 255), randInt (50, 255)
end
-- checks if player has sent a message
function onChat ( message, messageType )
if messageType == 0 then
local root = getRootElement()
outputChatBox ( getClientName ( source ) .. ": #E0D0B0" .. message, getRootElement(), g_Red, g_Green, g_Blue, true )
cancelEvent()
end
end
addEventHandler ( "onPlayerJoin", getRootElement(), onJoin)
addEventHandler ( "onPlayerChat", getRootElement(), onChat )
</syntaxhighlight>

{{See also/Server event|Player events}}

SpawnVehicle

2008-08-24T19:34:40Z

Syytuvanaema: /* Example */

SpawnVehicle

2008-08-24T19:08:58Z

Syytuvanaema:

{{Server function}}
__NOTOC__
Spawns a vehicle at any given position and rotation

==Syntax==
<syntaxhighlight lang="lua">
bool spawnVehicle ( vehicle theVehicle, float x, float y, float z, float rx, float ry, float rz )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle you wish to spawn
*'''x:''' The x position you wish to spawn the vehicle at
*'''y:''' The x position you wish to spawn the vehicle at
*'''z:''' The x position you wish to spawn the vehicle at
*'''rx:''' The x rotation you wish to spawn the vehicle at
*'''ry:''' The y rotation you wish to spawn the vehicle at
*'''rz:''' The z rotation you wish to spawn the vehicle at

===Returns===
Returns ''true'' if the vehicle spawned successfully, ''false'' if the passed argument does not exist or is not a vehicle.

==Example==
NEEDS CHECKING
<section name="Example: Server" class="server" show="true">
This script spawns a car 5 units to the right of player.
<syntaxhighlight lang="lua">
function spawncar( source, commandName, carid )
if ( isPlayerInVehicle ( source ) == false ) then
local x, y, z = getElementPosition ( source )
local rotZ = getPlayerRotation ( source )
x = x + ( ( math.cos ( math.rad ( rotZ ) ) ) * 5 )
y = y + ( ( math.sin ( math.rad ( rotZ ) ) ) * 5 )
if ( spawnVehicle ( carid, x, y, z, 0, 0, rotZ ) ) then
outputChatBox ( "You spawned a car!", source, 0, 255, 0, true )
else
outputChatBox ( "Failed to spawn a car!", source, 0, 255, 0, true )
end
end
end
addCommandHandler ( "car", spawncar )
</syntaxhighlight>
</section>

==Related scripting functions==
{{Vehicle functions}}
[[Category:Element Types]]

SpawnVehicle

2008-08-24T19:02:26Z

Syytuvanaema: /* Example */

SpawnVehicle

2008-08-24T19:00:59Z

Syytuvanaema: /* Example */

{{Server function}}
__NOTOC__
Spawns a vehicle at any given position and rotation

==Syntax==
<syntaxhighlight lang="lua">
bool spawnVehicle ( vehicle theVehicle, float x, float y, float z, float rx, float ry, float rz )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle you wish to spawn
*'''x:''' The x position you wish to spawn the vehicle at
*'''y:''' The x position you wish to spawn the vehicle at
*'''z:''' The x position you wish to spawn the vehicle at
*'''rx:''' The x rotation you wish to spawn the vehicle at
*'''ry:''' The y rotation you wish to spawn the vehicle at
*'''rz:''' The z rotation you wish to spawn the vehicle at

===Returns===
Returns ''true'' if the vehicle spawned successfully, ''false'' if the passed argument does not exist or is not a vehicle.

==Example==
There is currently no example - Do you have one? if so submit it!
<section name="Example: Server" class="server" show="true">
This script spawns a car 5 units to the right of player (NEEDS CHECKING).
<syntaxhighlight lang="lua">
function spawncar( source, commandName, carid )
if ( isPlayerInVehicle ( source ) == false ) then
local x, y, z = getElementPosition ( source )
local rotZ = getPlayerRotation ( source )
x = x + ( ( math.cos ( math.rad ( rotZ ) ) ) * 5 )
y = y + ( ( math.sin ( math.rad ( rotZ ) ) ) * 5 )
if ( spawnVehicle ( carid, x, y, z, 0, 0, rotZ ) ) then
outputChatBox ( "You spawned a car!", source, 0, 255, 0, true )
else
outputChatBox ( "Failed to spawn a car!", source, 0, 255, 0, true )
end
end
end
addCommandHandler ( "car", spawncar )
</syntaxhighlight>
</section>

SpawnVehicle

2008-08-24T19:00:13Z

Syytuvanaema: /* Example */

{{Server function}}
__NOTOC__
Spawns a vehicle at any given position and rotation

==Syntax==
<syntaxhighlight lang="lua">
bool spawnVehicle ( vehicle theVehicle, float x, float y, float z, float rx, float ry, float rz )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle you wish to spawn
*'''x:''' The x position you wish to spawn the vehicle at
*'''y:''' The x position you wish to spawn the vehicle at
*'''z:''' The x position you wish to spawn the vehicle at
*'''rx:''' The x rotation you wish to spawn the vehicle at
*'''ry:''' The y rotation you wish to spawn the vehicle at
*'''rz:''' The z rotation you wish to spawn the vehicle at

===Returns===
Returns ''true'' if the vehicle spawned successfully, ''false'' if the passed argument does not exist or is not a vehicle.

==Example==
There is currently no example - Do you have one? if so submit it!
<section name="Example: Server" class="server" show="true">
This script spawns a car 5 units to the right of player (NEEDS CHECKING).
<syntaxhighlight lang="lua">
function spawncar( source, commandName, carid )
if ( isPlayerInVehicle ( source ) == false ) then
local x, y, z = getElementPosition ( source )
local rotZ = getPlayerRotation ( source )
x = x + ( ( math.cos ( math.rad ( rotZ ) ) ) * 5 )
y = y + ( ( math.sin ( math.rad ( rotZ ) ) ) * 5 )
if ( spawnVehicle ( carid, x, y, z, 0, 0, rotZ ) ) then
outputChatBox ( "You spawned a car!", source, 0, 255, 0, true )
else
outputChatBox ( "Failed to spawn a car!", source, 0, 255, 0, true )
end
end
end
addCommandHandler ( "car", spawncar )
</syntaxhighlight>

==See Also==

{{Vehicle functions}}
[[Category:Incomplete]]