Server Messages – DayZ
Jump to navigation
Jump to search
(Created page with "A server message is a message that is sent to the clients from the server at a given point in time. ==Flags== ===On connect=== * Indicates that the server message will be s...") |
|||
(4 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
A server message is a message that is sent to the clients from the server at a given point in time. | A server message is a message that is sent to the clients from the server at a given point in time. | ||
==Flags== | == Flags == | ||
===On connect=== | === On connect === | ||
* Indicates that the server message will be sent once after a player connects to the server. | * Indicates that the server message will be sent once after a player connects to the server. | ||
===Repeat=== | === Repeat === | ||
* Indicates that the server message will be sending to all players repeatedly. | * Indicates that the server message will be sending to all players repeatedly. | ||
===Countdown=== | === Countdown === | ||
* Indicates that the server message will be sent to all players in a countdown manner. | * Indicates that the server message will be sent to all players in a countdown manner. | ||
* The message will be sent 90 minutes before the deadline is met, then 60 minutes, 45, 30, 20, 15, 10, 5, 2 and finally 1 minute before the deadline is met. | * The message will be sent 90 minutes before the deadline is met, then 60 minutes, 45, 30, 20, 15, 10, 5, 2 and finally 1 minute before the deadline is met. | ||
===Shutdown=== | === Shutdown === | ||
* Indicates that the server will shutdown after countdown reaches zero. | * Indicates that the server will shutdown after countdown reaches zero. | ||
* If the Countdown flag is not set, this flag is ignored. | * If the Countdown flag is not set, this flag is ignored. | ||
==Properties== | {{Feature|important|Is is highly recommended to use this graceful shutdown method to avoid negative side effects on player characters and the server storage saving.}} | ||
== Properties == | |||
The maximum length of the message is 160 characters. | The maximum length of the message is 160 characters. | ||
User can place 3 different placeholders into the message's text: | User can place 3 different placeholders into the message's text: | ||
Line 31: | Line 33: | ||
Every property related to time in the server message is in minutes. | Every property related to time in the server message is in minutes. | ||
===Delay=== | === Delay === | ||
* Applied when the server message has On connect flag set. | * Applied when the server message has On connect flag set. | ||
Line 37: | Line 39: | ||
* Value of zero means that the message will be sent immediately after the player connects to server. | * Value of zero means that the message will be sent immediately after the player connects to server. | ||
===Repeat=== | === Repeat === | ||
* Applied when the server message has the Repeat flag set. | * Applied when the server message has the Repeat flag set. | ||
* This value controls the frequency of the message repetition. | * This value controls the frequency of the message repetition. | ||
===Deadline=== | === Deadline === | ||
* Applied when the server message has the Countdown flag set. | * Applied when the server message has the Countdown flag set. | ||
* Indicates how long it takes the countdown before it reaches zero. | * Indicates how long it takes the countdown before it reaches zero. | ||
==Example== | == Example == | ||
Server messages can be added, updated or deleted in the messages.xml file (located in .\mpmissions\dayzOffline.chernarusplus\db\messages.xml, you may need to create it) | Server messages can be added, updated or deleted in the messages.xml file (located in .\mpmissions\dayzOffline.chernarusplus\db\messages.xml, you may need to create it) | ||
Line 80: | Line 82: | ||
<!-- source: https://forums.dayz.com/topic/239635-dayz-server-files-documentation/?do=findComment&comment=2414445 --> | <!-- source: https://forums.dayz.com/topic/239635-dayz-server-files-documentation/?do=findComment&comment=2414445 --> | ||
{{GameCategory|dayz|Server}} |
Latest revision as of 08:33, 10 June 2024
A server message is a message that is sent to the clients from the server at a given point in time.
Flags
On connect
- Indicates that the server message will be sent once after a player connects to the server.
Repeat
- Indicates that the server message will be sending to all players repeatedly.
Countdown
- Indicates that the server message will be sent to all players in a countdown manner.
- The message will be sent 90 minutes before the deadline is met, then 60 minutes, 45, 30, 20, 15, 10, 5, 2 and finally 1 minute before the deadline is met.
Shutdown
- Indicates that the server will shutdown after countdown reaches zero.
- If the Countdown flag is not set, this flag is ignored.
Properties
The maximum length of the message is 160 characters. User can place 3 different placeholders into the message's text:
- #name is replaced with the server's name
- #port is replaced with server's port
- #tmin is replaced with the number of minutes remaining in the countdown.
- only working when used with a Countdown flag.
Every property related to time in the server message is in minutes.
Delay
- Applied when the server message has On connect flag set.
- This value indicates how many minutes it will take before the message is sent to player.
- Value of zero means that the message will be sent immediately after the player connects to server.
Repeat
- Applied when the server message has the Repeat flag set.
- This value controls the frequency of the message repetition.
Deadline
- Applied when the server message has the Countdown flag set.
- Indicates how long it takes the countdown before it reaches zero.
Example
Server messages can be added, updated or deleted in the messages.xml file (located in .\mpmissions\dayzOffline.chernarusplus\db\messages.xml, you may need to create it)
For automatic server termination set "deadline" and "shutdown" to enabled.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<messages>
<!-- This is example message for automatic server termination -->
<message>
<!-- no delay -->
<delay>0</delay>
<!-- if the value is larger than 0, then flag Repeat is enabled -->
<repeat>0</repeat>
<!-- if the value is larger than 0, then flag Countdown is enabled,
countdown reaches zero in 10 hours -->
<deadline>600</deadline>
<!-- disable On connect flag -->
<onConnect>0</onConnect>
<!-- enable Shutdown flag -->
<shutdown>1</shutdown>
<!-- message itself with placeholders -->
<text>Hello, #name will shutdown in #tmin minutes.</text>
</message>
</messages>