Add guide for AsyncChatEvent #264
Conversation
There was a problem hiding this comment.
This should also mention the use of ChatRenderer.viewerUnaware as something that should be used if the message will not be different depending on who is getting it. This is more performant because the message will only be rendered once per player it's being sent to.
| - The `render` method is called when a chat message is sent to the player. | ||
| - The `source` parameter is the player that sent the message. | ||
| - The `sourceDisplayName` parameter is the display name of the player that sent the message. | ||
| - The `message` parameter is the message that was sent. | ||
| - The `viewer` parameter is the player that is receiving the message. | ||
|
|
||
| Now that we understand how the renderer works, we can start using it. |
There was a problem hiding this comment.
I think before this happens, it needs to be made clear that the render method is something that plugins implement, they generally do not call it themselves. And they don't supply each of those arguments, its given to them when the render method is called.
There was a problem hiding this comment.
I do that in the next section.
Leguan16
force-pushed
the
async-chat-event
branch
from
0c7b068
to
a79b8c0
Compare
Leguan16
force-pushed
the
async-chat-event
branch
from
a79b8c0
to
571d0b9
Compare
Leguan16
force-pushed
the
async-chat-event
branch
from
571d0b9
to
7dbc5c8
Compare
|
I addressed the requested changes. |
Leguan16
force-pushed
the
async-chat-event
branch
from
7dbc5c8
to
9581396
Compare
|
I added a note regarding the event being async, added a tip about the usage of I did not yet change the last section. |
Leguan16
force-pushed
the
async-chat-event
branch
from
9581396
to
1a1802e
Compare
Leguan16
changed the title
This PR adds a guide for the
AsyncChatEventas people seem to strugle with it. Especially with the renderer.