DEV Community

HALO
HALO

Posted on

Expanding Gameplay with GOKI2 [Introduction to ModMessage] Message Display Surpassing KAG3 and Data Management Without "cm Tag"

Download

Avalanches & GOKI2 can download the latest environment from the Assets link of Avalanches-GOKI2-Release2.x.y.y.zip based on the release tag on the following site (written as Avalanches (GOKI2) release version 2.x.y.y).

https://github.com/halo1234/Avalanches/releases

ModMessage

ModMessage implements tags for processing scenario text.
First, load the module.

; Message layer related functions
@load_module name=ModMessage
Enter fullscreen mode Exit fullscreen mode

Initial Settings for Message Layers

First, specify how many message layers you want to use.
Use the message_layers tag as shown below.

; Number of message layers
@message_layers count=2
Enter fullscreen mode Exit fullscreen mode

Next, specify the size and position of the message layers.

; Message layer settings
@message_option layer=message0 left=10 top=400 width=780 height=190 margin_left=10 margin_top=10 margin_right=10 margin_bottom=10 opacity=128 color=0xFF0000 caption_color=0xFFFFFF shadow_color=0xFF0000 current
@message_option layer=message1 left=10 top=200 width=780 height=190 margin_left=10 margin_top=10 margin_right=10 margin_bottom=10 opacity=128 color=0xFF0000 caption_color=0xFFFFFF shadow_color=0xFF0000
Enter fullscreen mode Exit fullscreen mode

Since the message layer settings are long, let's look at them step by step.

Specify the target layer to operate on with layer=message0.
You can specify the same number of layers as the message layers indicated by the message_layers tag.
Since we are using two layers this time, the layer attribute can be set to either message0 or message1.

left=10 top=400 width=780 height=190 specifies the position and size of the message layer.

margin_left=10 margin_top=10 margin_right=10 margin_bottom=10 specifies the margins (padding) of the message display area.
Messages will not be displayed in positions smaller than the values specified here.

opacity=128 color=0xFF0000 specifies the color and opacity of the message layer itself.

caption_color=0xFFFFFF shadow_color=0xFF000 sets the color of the message text and the shadow color.

Specifying the current attribute makes that layer the current message layer.
The current message layer is considered the default if no layer attribute is specified in each tag.

By preparing multiple message layers in this way and placing message0 at the bottom and message1 at the top, it is possible to create advanced effects such as separating narration and dialogue.

Displaying Messages

To display messages, you first need to redirect the processing of scenario text from default tags such as ch to ch_mod_message.
A using_mod_message tag is provided to redirect each text processing tag to ModMessage.

; Set the scenario text output destination to ModMessage
@using_mod_message
Enter fullscreen mode Exit fullscreen mode

This tag conflicts with ModADV's using_mod_adv, so please choose one as the output destination. That concludes changing the output destination.

Next, the message layer will be displayed. If the message layer is not displayed, messages will not appear.

; Syntax extension (remember?)
@!show_message type=vista

; Display message layer 0 (using vista effect)
@show_message layer=message0 vista
; Wait for the message layer display to complete
@wait_show_message
Enter fullscreen mode Exit fullscreen mode

With this, text can now be processed with ModMessage. After that, you just write text as follows.

*label|
This is scenario text.[p][cm]

*label|
ModMessage is processing this.[p]

*label|
Clearing the message layer.[p]

; Clear the message layer
@hide_message layer=message0
; Wait for the message layer to finish clearing
@wait_hide_message layer=message0
Enter fullscreen mode Exit fullscreen mode

Looking at the script, those familiar with KAG3 will notice that there is no cm tag immediately after a saveable label. Unlike KAG3, GOKI2 saves the contents of the message layer, so there is no need to write the cm tag.

History Layer

ModMessage also manages the so-called history layer.

; Message history settings
@history_option width=800 height=600 slider_storage=sample_slider/sample_slider_button margin_left=50 margin_top=18 margin_right=18 margin_bottom=18 color=0x000000 caption_color=0xFFFFFF shadow_color=0x808080
Enter fullscreen mode Exit fullscreen mode

Let's look at each setting in order.

width=800 height=600 specifies the size of the message layer. The left/top attributes can also be specified, but here they are omitted, so the history layer area ranges from (0, 0) to (800, 600).

slider_storage=sample_slider/sample_slider_button specifies the images for the scrollbar (and knob) used for scrolling the history. If no images are specified, the default scrollbar is used.

margin_left=50 margin_top=18 margin_right=18 margin_bottom=18 specifies the margins (padding) of the history layer, just like with the message layer.

color=0x000000 specifies the color of the history layer.

caption_color=0xFFFFFF shadow_color=0x808080 specifies the color of the text displayed in the history and the color of its shadow.

Finally

By specifying images for all UI elements, you can use custom UI. For more details, please refer to the manual. (/doc/goki2/index.html)

The ModMessage module implements a large number of tags, so it is recommended to read the manual thoroughly.

Top comments (0)