View source for PT-BR/OutputChatBox

{{BR/Função compartilhada}}
{{BR/Nota|Evite enviar texto para a caixa de bate-papo que não seja realmente um bate-papo, pois isso pode ser irritante para os jogadores. Envie informações e mensagens de status para o HUD. ''OBS: Isto é algo opcional mas de muita utilidade, fica a critério dos desenvolvedores do servidor.''}}
{{BR/Nota|A partir da versão r20391, '''visibleTo''' aceita tabela de jogadores e [[Elemento/Team|elemento-equipe]]}}
__NOTOC__
Esta função envia texto para a caixa de bate-papo. Pode ser interpretado como uma mensagem, aviso, etc. para determinados jogadores ou todos os jogadores.

Opcionalmente, pode incorporar alterações de cores na sequência, definindo o valor booleano ''colorCoded'' como true. Isso permite:
<syntaxhighlight lang="lua">
outputChatBox ( "#FF0000E aí #00FF00Brasil!", getRootElement(), 255, 255, 255, true )
</syntaxhighlight>
Isto mostrará: '''<span style='color:red;'>E aí</span> <span style='color:green'>Brasil!</span> '''

==Sintaxe==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">bool outputChatBox ( string text [, element visibleTo = getRootElement(), int r = 231, int g = 217, int b = 176, bool colorCoded = false ] )</syntaxhighlight>
{{BR/OOP||[[player]]:outputChat}}
==Argumento Obrigatório==
*'''text:''' O texto que será enviado para a janela de chat. Se tiver mais que 256 caracteres o texto não será enviado.

==Argumentos Opcionais==
{{BR/ArgOpcional}}
*'''visibleTo:''' Este argumento define para quem você quer que seja enviado o texto.
{{PT-BR/New feature/item|5.0157|1.5.7|20391|
*'''visibleTo:''' Você pode especificar uma tabela (de índices numéricos) com jogadores (como valores dos índices), um [[Elemento/Player|elemento-jogador]], ou um [[Elemento/Team|elemento-equipe]] (Team). Confira [[Visibility/PT-BR|visibilidade]].}}
*'''r:''' A quantidade de vermelho na cor do texto. O valor padrão é 231.
*'''g:''' A quantidade de verde na cor do texto. O valor padrão é 217.
*'''b:''' A quantidade de azul na cor do texto. O valor padrão é 176.
*'''colorCoded:''' Um valor booleano que determina ou não se as tags '#RRGGBB' devem ser usadas.
Nota: O formato #RRGGBB deve conter letras maiúsculas, a-f não é aceitável, mas A-F é. Os valores padrões RGB usado neste formato é: '#E7D9B0'.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">bool outputChatBox ( string text [, int r = 231, int g = 217, int b = 176, bool colorCoded = false ] )</syntaxhighlight>

==Argumentos Obrigatórios==
*'''text:''' O texto que será enviado para a janela de chat. Se tiver mais que 256 caracteres o texto não será enviado.

==Argumentos Opcionais==
{{BR/ArgOpcional}}
*'''r:''' A quantidade de vermelho na cor do texto. O valor padrão é 231.
*'''g:''' A quantidade de verde na cor do texto. O valor padrão é 217.
*'''b:''' A quantidade de azul na cor do texto. O valor padrão é 176.
*'''colorCoded:''' Um valor booleano que determina ou não se as tags '#RRGGBB' devem ser usadas.
Nota: O formato #RRGGBB deve conter letras maiúsculas, a-f não é aceitável, mas A-F é. Os valores padrões RGB usado neste formato é: '#E7D9B0'.

</section>

==Retorno==
Retorna ''true'' se a mensagem foi enviada com sucesso. Retorna ''false'' se argumentos inválidos foram especificados.

==Exemplo==
<section name="Server" class="server" show="true">
'''Exemplo 1:''' Este exemplo mostra uma mensagem no chat para todos os jogadores.
<syntaxhighlight lang="lua">
x = 5
y = 10  
-- Mostra a mensagem
outputChatBox ( "Eu tenho " .. x .. " abacates e " .. y .. " melancias." )
</syntaxhighlight>

'''Exemplo 2:''' Este evento envia uma simples mensagem com cores, "Vermelho Branco", onde o 'Branco' está na cor branca, e 'Vermelho' na cor vermelha.
<syntaxhighlight lang="lua">
 outputChatBox ( "Vermelho #FFFFFFBranco", getRootElement(), 255, 0, 0, true )
</syntaxhighlight>

'''Exemplo 3:''' Este exemplo permite o chat colorido, de acordo com a cor que o jogador definiu em seu nick.
<syntaxhighlight lang="lua">
function colouredChat ( message, theType )
	if theType == 0 then --Se for uma mensagem normal no chat (sem ser /me ou chat de grupo) então
		cancelEvent() -- cancela o envio da mensagem
		message = string.gsub(message, "#%x%x%x%x%x%x", "") -- remove qualquer cor usada na mensagem pelo jogador com a função nativa de Lua: string.gsub
		local r,g,b = getPlayerNametagColor ( source ) -- pegamos a cor que o jogador usa em seu nick
		local chatterName = getPlayerName ( source ) -- pegamos o nick dele
		-- envia a mensagem com o nick e a cor do nick, e o resto em branco.
		outputChatBox ( chatterName..":#FFFFFF "..message, getRootElement(), r, g, b, true )
	end
end
addEventHandler("onPlayerChat", getRootElement(), colouredChat)
</syntaxhighlight>

'''Exemplo 4:''' Este exemplo mostra uma mensagem no chat para um jogador chamado ''fulano''.
<syntaxhighlight lang="lua">
-- Ache o elemento jogador pelo nick dele: 'fulano'
myPlayer = getPlayerFromName ( "fulano" )
-- Se um jogador foi achado pelo seu nick 'fulano' então...
if ( myPlayer ~= false ) then
    x = 5
    y = 10
    -- Mostre a mensagem
    outputChatBox ( "Eu tenho " .. x .. " celulares e " .. y .. " fones de ouvido.", myPlayer )
end
</syntaxhighlight>

'''Exemplo 5:''' Essas duas funções podem acelerar a digitação, e mostra a mensagem para quando o jogador entrar no servidor.
<syntaxhighlight lang="lua">
local msg_red, msg_green, msg_blue = 255, 255, 0

function servertalkprivate(message, sendto)
        -- Fale com o jogador diretamente
	outputChatBox(tostring(message), sendto, msg_red, msg_green, msg_blue, true)
end

function servertalk(message)
        -- Fala para todos
	servertalkprivate(message, getRootElement())
end

function quandoEntrar()
	servertalkprivate("Bem vindo ao Brasil", source)
end

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

'''Exemplo 6:''' Isto pode ser usado para quando um jogador entrar no servidor e então definir o colete dele para 100.
<syntaxhighlight lang="lua">
function onJoin()
         setPedArmor(source, 100)
         local playerName = getPlayerName(source)
         outputChatBox("Bem vindo ".. playerName .." ao servidor", source, 0, 154, 255)
end
addEventHandler("onPlayerJoin", root, onJoin)
</syntaxhighlight>
</section>

==Veja também==
{{Server functions}}
[[en:outputChatBox]]
[[cs:outputChatBox]]
[[pl:outputChatBox]]
[[ru:outputChatBox]]