PL/outputChatBox: Difference between revisions
m (GabWas moved page PL/OutputChatBox to PL/outputChatBox over redirect) |
mNo edit summary |
||
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
{{ | {{PL/Shared function}} | ||
{{PL/Note_box|Unikaj wyświetlania na czacie informacji takich jak poziom zdrowia, zbroi, tlenu, pieniędzy, itp, ponieważ może to po prostu zirytować graczy + odpowiada za to HUD.}} | |||
__NOTOC__ | __NOTOC__ | ||
Funkcja ta umożliwia wyświetlenie na czacie dowolnego ciągu znaków, mniejszego niż 128. Istnieje również możliwość zdefiniowania, dla kogo ta wiadomość ma być widoczna. | |||
== Składnia == | Przy korzystaniu z funkcji możemy dodatkowo ustalić, czy ma ona odczytywać zapis heksadecymedalny ('#RRGGBB'), dzięki któremu jesteśmy w stanie dowolnie pokolorować nasz tekst. Przykładowo: | ||
<section name=" | <syntaxhighlight lang="lua"> | ||
outputChatBox ( "#FF0000Hello #00FF00World", getRootElement(), 255, 255, 255, true ) | |||
</syntaxhighlight> | |||
zostanie wyświetlone jako: '''<span style='color:red;'>Hello</span> <span style='color:green'>World</span> ''' | |||
==Składnia (syntax)== | |||
<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> | <syntaxhighlight lang="lua">bool outputChatBox ( string text [, element visibleTo=getRootElement(), int r=231, int g=217, int b=176, bool colorCoded=false ] )</syntaxhighlight> | ||
{{OOP||[[player]]:outputChat}} | |||
==Wymagane argumenty== | ==Wymagane argumenty== | ||
*'''text:''' Ciąg znaków | *'''text:''' Ciąg znaków, który zostanie wyświetlony na czacie. Jeżeli jednak jego długość przekroczy 128 znaków, wiadomość nie zostanie wysłana. | ||
==Opcjonalne argumenty== | ==Opcjonalne argumenty== | ||
*'''visibleTo:''' | {{PL/OptionalArg}} | ||
*'''r:''' Wartość czerwonego | *'''visibleTo:''' Dzięki temu argumentowi, możesz zdecydować komu wyświetli się dana wiadomość (więcej informacji [[visibility|tutaj]]). Domyślnie ''false''. | ||
*'''g:''' Wartość zielonego | *'''r:''' Wartość koloru czerwonego w tekście. Domyślnie ''231''. | ||
*'''b:''' Wartość niebieskiego | *'''g:''' Wartość koloru zielonego w tekście. Domyślnie ''217''. | ||
*'''colorCoded:''' | *'''b:''' Wartość koloru niebieskiego w tekście. Domyślnie ''176''. | ||
*'''colorCoded:''' Boolean decydujący o tym, czy tagi '#RRGGBB' mają być używane. Domyślnie ''false''. | |||
ⓘ Pamiętaj, że tagi '#RRGGBB' mogą składać się tylko z wielkich liter, więc małe litery nie będą akceptowane. Domyślna wartość RGB w tym przypadku to '#E7D9B0'. | |||
</section> | </section> | ||
<section name=" | <section name="Client" class="client" show="true"> | ||
<syntaxhighlight lang="lua">bool outputChatBox ( string text [ | <syntaxhighlight lang="lua">bool outputChatBox ( string text [, int r=231, int g=217, int b=176, bool colorCoded=false ] )</syntaxhighlight> | ||
==Wymagane argumenty== | ==Wymagane argumenty== | ||
*'''text:''' Ciąg znaków | *'''text:''' Ciąg znaków, który zostanie wyświetlony na czacie. Jeżeli jednak jego długość przekroczy 128 znaków, wiadomość nie zostanie wysłana. | ||
==Opcjonalne argumenty== | ==Opcjonalne argumenty== | ||
{{PL/OptionalArg}} | |||
*'''r:''' Wartość czerwonego | *'''r:''' Wartość koloru czerwonego w tekście. Domyślnie ''231''. | ||
*'''g:''' Wartość zielonego | *'''g:''' Wartość koloru zielonego w tekście. Domyślnie ''217''. | ||
*'''b:''' Wartość niebieskiego | *'''b:''' Wartość koloru niebieskiego w tekście. Domyślnie ''176''. | ||
*'''colorCoded:''' | *'''colorCoded:''' Boolean decydujący o tym, czy tagi '#RRGGBB' mają być używane. Domyślnie ''false''. | ||
ⓘ Pamiętaj, że tagi '#RRGGBB' mogą składać się tylko z wielkich liter, więc małe litery nie będą akceptowane. Domyślna wartość RGB w tym przypadku to '#E7D9B0'. | |||
</section> | </section> | ||
== | ==Wynik== | ||
Zwraca ''true'' jeśli wiadomość została | Zwraca ''true'' jeśli wiadomość została pomyślnie wyświetlona. Zwraca ''false'', jeżeli któryś z argumentów został nieprawidłowo wypełniony. | ||
== Przykłady == | ==Przykłady== | ||
<section name=" | <section name="Server" class="server" show="true"> | ||
'''Przykład 1 :''' Ten przykład | '''Przykład nr 1:''' Ten przykład wyświetla wiadomość wszystkim graczom na serwerze, przy czym nazwy kolorów mają swoje barwy. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
outputChatBox ( "Czerwony #00FF00Zielony #0000FFNiebieski", getRootElement(), 255, 0, 0, true ) | |||
outputChatBox(" | |||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Przykład 2 :''' Ten przykład | |||
'''Przykład nr 2:''' Ten przykład wyświetla wiadomość graczowi o nicku "ktostam". | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
gracz = getPlayerFromName ( "ktostam" ) -- szukamy gracza o nicku "ktostam" | |||
if gracz then -- jeżeli go znaleźliśmy, kontynuujemy... | |||
outputChatBox ( "Cześć ktosiu!", gracz ) -- ...i wyświetlamy mu wiadomość | |||
end | |||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Przykład 3 :''' Ten przykład | |||
'''Przykład nr 3:''' Ten przykład wyświetla wiadomość powitalną graczowi wchodzącemu na serwer. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function | function graczWchodziNaSerwer() | ||
outputChatBox ( "Witaj na serwerze!", source, 255, 0, 0 ) | |||
end | end | ||
addEventHandler(" | addEventHandler ( "onPlayerJoin", root, graczWchodziNaSerwer ) | ||
</syntaxhighlight> | |||
</section> | </section> | ||
<br/> | |||
''Autor: [[User:GabWas|GabWas]], utworzono: 23:32 19 Lip 2016 (CEST)'' | |||
<br/>''Author: [[User:GabWas|GabWas]], created: 21:32 19 Jul 2016 (UTC)'' | |||
==Zobacz także== | |||
{{Server functions}} | |||
[[cs:outputChatBox]] | |||
[[ru:outputChatBox]] |
Latest revision as of 21:34, 19 July 2016
Funkcja ta umożliwia wyświetlenie na czacie dowolnego ciągu znaków, mniejszego niż 128. Istnieje również możliwość zdefiniowania, dla kogo ta wiadomość ma być widoczna.
Przy korzystaniu z funkcji możemy dodatkowo ustalić, czy ma ona odczytywać zapis heksadecymedalny ('#RRGGBB'), dzięki któremu jesteśmy w stanie dowolnie pokolorować nasz tekst. Przykładowo:
outputChatBox ( "#FF0000Hello #00FF00World", getRootElement(), 255, 255, 255, true )
zostanie wyświetlone jako: Hello World
Składnia (syntax)
bool outputChatBox ( string text [, element visibleTo=getRootElement(), int r=231, int g=217, int b=176, bool colorCoded=false ] )
OOP Syntax Help! I don't understand this!
- Method: player:outputChat(...)
Wymagane argumenty
- text: Ciąg znaków, który zostanie wyświetlony na czacie. Jeżeli jednak jego długość przekroczy 128 znaków, wiadomość nie zostanie wysłana.
Opcjonalne argumenty
UWAGA: Kiedy korzystasz z opcjonalnych argumentów, musisz uzupełnić wszystkie argumenty przed tym, którego chcesz użyć. Aby uzyskać więcej informacji na ten temat, zajrzyj tutaj.
- visibleTo: Dzięki temu argumentowi, możesz zdecydować komu wyświetli się dana wiadomość (więcej informacji tutaj). Domyślnie false.
- r: Wartość koloru czerwonego w tekście. Domyślnie 231.
- g: Wartość koloru zielonego w tekście. Domyślnie 217.
- b: Wartość koloru niebieskiego w tekście. Domyślnie 176.
- colorCoded: Boolean decydujący o tym, czy tagi '#RRGGBB' mają być używane. Domyślnie false.
ⓘ Pamiętaj, że tagi '#RRGGBB' mogą składać się tylko z wielkich liter, więc małe litery nie będą akceptowane. Domyślna wartość RGB w tym przypadku to '#E7D9B0'.
bool outputChatBox ( string text [, int r=231, int g=217, int b=176, bool colorCoded=false ] )
Wymagane argumenty
- text: Ciąg znaków, który zostanie wyświetlony na czacie. Jeżeli jednak jego długość przekroczy 128 znaków, wiadomość nie zostanie wysłana.
Opcjonalne argumenty
UWAGA: Kiedy korzystasz z opcjonalnych argumentów, musisz uzupełnić wszystkie argumenty przed tym, którego chcesz użyć. Aby uzyskać więcej informacji na ten temat, zajrzyj tutaj.
- r: Wartość koloru czerwonego w tekście. Domyślnie 231.
- g: Wartość koloru zielonego w tekście. Domyślnie 217.
- b: Wartość koloru niebieskiego w tekście. Domyślnie 176.
- colorCoded: Boolean decydujący o tym, czy tagi '#RRGGBB' mają być używane. Domyślnie false.
ⓘ Pamiętaj, że tagi '#RRGGBB' mogą składać się tylko z wielkich liter, więc małe litery nie będą akceptowane. Domyślna wartość RGB w tym przypadku to '#E7D9B0'.
Wynik
Zwraca true jeśli wiadomość została pomyślnie wyświetlona. Zwraca false, jeżeli któryś z argumentów został nieprawidłowo wypełniony.
Przykłady
Przykład nr 1: Ten przykład wyświetla wiadomość wszystkim graczom na serwerze, przy czym nazwy kolorów mają swoje barwy.
outputChatBox ( "Czerwony #00FF00Zielony #0000FFNiebieski", getRootElement(), 255, 0, 0, true )
Przykład nr 2: Ten przykład wyświetla wiadomość graczowi o nicku "ktostam".
gracz = getPlayerFromName ( "ktostam" ) -- szukamy gracza o nicku "ktostam" if gracz then -- jeżeli go znaleźliśmy, kontynuujemy... outputChatBox ( "Cześć ktosiu!", gracz ) -- ...i wyświetlamy mu wiadomość end
Przykład nr 3: Ten przykład wyświetla wiadomość powitalną graczowi wchodzącemu na serwer.
function graczWchodziNaSerwer() outputChatBox ( "Witaj na serwerze!", source, 255, 0, 0 ) end addEventHandler ( "onPlayerJoin", root, graczWchodziNaSerwer )
Autor: GabWas, utworzono: 23:32 19 Lip 2016 (CEST)
Author: GabWas, created: 21:32 19 Jul 2016 (UTC)