Skip to content

Commit 2c4aeb5

Browse files
committed
EvtPlayerChat - update docs
1 parent fc3c5e9 commit 2c4aeb5

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

src/main/java/com/github/skriptdev/skript/plugin/elements/events/player/EvtPlayerChat.java

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,17 @@ public static void register(SkriptRegistration reg) {
2222
reg.newEvent(EvtPlayerChat.class, "[player] chat")
2323
.setHandledContexts(PlayerChatContext.class)
2424
.name("Player Chat")
25-
.description("Event triggered when a player sends a message in chat.")
25+
.description("Event triggered when a player sends a message in chat.",
26+
"The message can be changed by setting `context-message`.",
27+
"The message format can be changed by setting `context-message-format` (to a Message) or `context-format` (to a String).")
2628
.examples("on player chat:",
2729
"\tif name of context-sender = \"bob\":",
2830
"\t\tcancel event",
29-
"\t\tsend \"You said: %message% and we cancelled that!!!\" to context-sender")
31+
"\t\tsend \"You said: %message% and we cancelled that!!!\" to context-sender",
32+
"",
33+
"on player chat:",
34+
"\tset {_message} to formatted message from \"[<blue>MyServer<reset>] <red>%name of context-playerref%<reset>: %context-message%\"",
35+
"\tset context-message-format to {_message}")
3036
.since("1.0.0")
3137
.register();
3238

@@ -106,7 +112,10 @@ public void setFormat(String format) {
106112
this.event.setFormatter(new PlayerChatEvent.Formatter() {
107113
@Override
108114
public @NotNull Message format(@NotNull PlayerRef playerRef, @NotNull String s) {
109-
return Message.raw(format).param("message", s).param("player", Message.raw(playerRef.getUsername()));
115+
return Message.raw(format)
116+
.param("message", s)
117+
.param("player", playerRef.getUsername())
118+
.param("username", playerRef.getUsername());
110119
}
111120
});
112121
}
@@ -115,8 +124,10 @@ public void setMessageFormat(Message format) {
115124
this.event.setFormatter(new PlayerChatEvent.Formatter() {
116125
@Override
117126
public @NotNull Message format(@NotNull PlayerRef playerRef, @NotNull String s) {
118-
Message insert = Message.empty().insert(format); // Clone what is passed thru
119-
return insert.param("message", s).param("player", Message.raw(playerRef.getUsername()));
127+
return format
128+
.param("message", s)
129+
.param("player", playerRef.getUsername())
130+
.param("username", playerRef.getUsername());
120131
}
121132
});
122133
}

0 commit comments

Comments
 (0)