In-Game Chat (ANETZ Extension)

anetz_ext_in_game_chat.md

In-Game Chat (ANETZ Extension)

This extension plugin requires Alpha NET Z to work.

⚠️ Information valid for version 0.9 and above

Overview

The In-Game Chat extension adds a chat window to your RPG Maker MV/MZ multiplayer game using the Alpha NET Z plugin. Players can send messages to each other in real-time while playing the game.

Getting Started

Activating In-Game Chat

To enable the chat feature, check the Plugin Parameter In-Game Chat?

Customizing Chat Appearance

You can change chat and message visual settings in the Plugin Parameters:

---

Using the Chat System

Opening and Closing the Chat

To open/close the chat or write a message, use the keys configured in Plugin Parameters: Chat Key and Say Key.

When you press the Say Key, a new scene will open with a text input field:

Click-to-Chat Feature

Since version 0.7, you can click (or touch) on the chat window to open the text input field scene.

You can disable this option by editing the plugin parameter Click to Say:

Message Channels

You can select a channel before sending a message:

• All - message will be sent to all players
• Map - message will be sent only to players on the same map

Message Formatting

You can use message control characters (\V, \C, {, ...) in chat messages:

Moving the Chat Window

The chat window can be dragged with the mouse.

Click on the window header and hold until the window becomes transparent, then you can drag the window.

⚠️ Note: The chat does not have scrolling functionality.

---

Script Control

Available Script Calls

You can control the chat system programmatically using the following script calls:

• nAPI.isChatWindowOpened(); - returns true or false, use in conditional statements
• nAPI.moveChatWindow(X,Y); - move chat window to X, Y screen coordinates (in pixels)
• nAPI.openChatWindow(); - opens the chat window
• nAPI.closeChatWindow(); - closes the chat window
• nAPI.writeInChat("message", isGlobal:true|false); - sends a message to chat

Script Examples

nAPI.writeInChat("Hello for me", false);   // message to current player (client)
nAPI.writeInChat("Hello for all", true);   // message to all players in game

In the Demo Project, on map ID 12 nAPI (script calls), you can find Event (ID 5) with script call examples.

---

Emotions System

Enabling Emotions

Activate Emotions in the Plugin Parameter Messages Settings:

Using Emotions

To play emotion animations, use special code symbols in chat messages:

Available Emotions

Code	Emotion
:!	Exclamation
:?	Question
:song	Music note
:love	Heart
:angry	Anger
:drop	Sweat drop
:conf	Confusion
:...	Dots
:idea	Light bulb
:zzz	Sleep