Jbeta at 18:45, 13 September 2007

2007-09-13T18:45:30Z

← Older revision		Revision as of 18:45, 13 September 2007
Line 5:		Line 5:
	This event is triggered when a player chats inside the chat box.		This event is triggered when a player chats inside the chat box.

	==~~Syntax~~==		==Parameters==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~void onPlayerChat (~~ string message, int ~~type )~~		string message, int messageType
	</syntaxhighlight>		</syntaxhighlight>

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

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

	===~~Canceling~~===		==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.		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==		==Example==
	This example limits receiving of chat messages to a spherical area around the player who sent the message.		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">		<syntaxhighlight lang="lua">
			-- define a handler function that cancels the event so that the message won't be delivered
	function blockChatMessage()		function blockChatMessage()
	cancelEvent()		cancelEvent()
	end		end
			-- attach it as a handler to onPlayerChat
	addEventHandler( "onPlayerChat", getRootElement(), blockChatMessage )		addEventHandler( "onPlayerChat", getRootElement(), blockChatMessage )

	local chatRadius = 2 --units		-- define our chat radius
			local chatRadius = 20 --units

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

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

			-- deliver the message to each player in that table
	for index, nearbyPlayer in ipairs( nearbyPlayers ) do		for index, nearbyPlayer in ipairs( nearbyPlayers ) do
	outputChatBox( message, nearbyPlayer )		outputChatBox( message, nearbyPlayer )
Line 46:		Line 55:
	end		end
	end		end
			-- attach our new chat handler to onPlayerChat
	addEventHandler( "onPlayerChat", getRootElement(), sendMessageToNearbyPlayers )		addEventHandler( "onPlayerChat", getRootElement(), sendMessageToNearbyPlayers )
	</syntaxhighlight>		</syntaxhighlight>

Jbeta: New page: NOTOC This event is triggered when a player cha...

2007-09-13T17:13:43Z

New page: __NOTOC__  <pageclass class="server" subcaption="Serverside event"></pageclass> <lowercasetitle></lowercasetitle> This event is triggered when a player cha...

New page

__NOTOC__

<pageclass class="server" subcaption="Serverside event"></pageclass>
<lowercasetitle></lowercasetitle>
This event is triggered when a player chats inside the chat box.

==Syntax==
<syntaxhighlight lang="lua">
void onPlayerChat ( string message, int type )
</syntaxhighlight>

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

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

===Canceling===
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.
<syntaxhighlight lang="lua">
function blockChatMessage()
cancelEvent()
end
addEventHandler( "onPlayerChat", getRootElement(), blockChatMessage )

local chatRadius = 2 --units

function sendMessageToNearbyPlayers( message, messageType )
if messageType == 0 then
local posX, posY, posZ = getElementPosition( source )

local chatSphere = createColSphere( posX, posY, posZ, chatRadius )
local nearbyPlayers = getElementsWithinColShape( chatSphere, "player" )
destroyElement( chatSphere )

for index, nearbyPlayer in ipairs( nearbyPlayers ) do
outputChatBox( message, nearbyPlayer )
end
end
end
addEventHandler( "onPlayerChat", getRootElement(), sendMessageToNearbyPlayers )
</syntaxhighlight>

==See Also==
{{Event_functions}}

User:Jbeta/EventPageExample - Revision history

Jbeta at 18:45, 13 September 2007

Jbeta: New page: __NOTOC__ This event is triggered when a player cha...

Jbeta: New page: NOTOC This event is triggered when a player cha...