Wiki source code of Communication System
Last modified by Utku Dagli on 2026/02/07 22:24
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | = 0 - Introduction = | ||
| 2 | |||
| 3 | This documentation outlines the basics of the communication system, its rules and components, and how to configure it. | ||
| 4 | |||
| 5 | == 0.1 - Disclaimer == | ||
| 6 | |||
| 7 | This document is a living document, and any specific variables, names, numbers and more are subject to change. The task assignee may modify any structure to adapt or to support existing systems. If you need additional help or further explanation, please contact {{mention reference="XWiki.utkudagli" style="FULL_NAME" anchor="XWiki-utkudagli-2xv2xr"/}}. | ||
| 8 | |||
| 9 | ---- | ||
| 10 | |||
| 11 | = 1 - Overview = | ||
| 12 | |||
| 13 | Text-based system for NPC-to-player interaction and information delivery. NPCs communicate through on-screen text messages triggered by player interactions. | ||
| 14 | |||
| 15 | == 1.1 - Message Types == | ||
| 16 | |||
| 17 | |**Type**|**Purpose**|**Length** | ||
| 18 | |Hint|Guide Player|1-2 Sentences | ||
| 19 | |Information|Lore or Context|2-4 Sentences | ||
| 20 | |Warning|Alert or Danger|1 Sentence | ||
| 21 | |||
| 22 | == 1.2 UI Components == | ||
| 23 | |||
| 24 | **Text Display Box** | ||
| 25 | |||
| 26 | * **Location: **Bottom third of the screen. | ||
| 27 | * **Background: **Semi-transparent dark panel | ||
| 28 | * **Text: **White, the font chosen for the game, 18-24pt. | ||
| 29 | * **Max Width: **60-70 characters per line. | ||
| 30 | |||
| 31 | **Message Navigation** | ||
| 32 | |||
| 33 | * Display one message at a time. | ||
| 34 | * Player controls pacing | ||
| 35 | |||
| 36 | **Display Rules** | ||
| 37 | |||
| 38 | * The text box fades in or out over 0.3 seconds. | ||
| 39 | * The player must close the messages using the interaction buttons. | ||
| 40 | * No auto-advance in messages. | ||
| 41 | |||
| 42 | **Controls** | ||
| 43 | |||
| 44 | |**Action**|**Buttons** | ||
| 45 | |Open or Close|((( | ||
| 46 | Interaction buttons | ||
| 47 | ))) | ||
| 48 | |Next message|"Press any button to continue" | ||
| 49 | |||
| 50 | == 1.3 - Conversation Storage == | ||
| 51 | |||
| 52 | * **Data Table: **DT_NPCMessages | ||
| 53 | * **Data Structures: **DS_NPCMessageData | ||
| 54 | |||
| 55 | |**Variable Name**|**Type**|**Description** | ||
| 56 | |MessageID|String|Unique identifier for each message. | ||
| 57 | |NPCID|String|((( | ||
| 58 | Reference to which NPC owns this message. | ||
| 59 | ))) | ||
| 60 | |MessageType|Enum|Hint ~| Information ~| Warning | ||
| 61 | |MessageText|Text|The displayed dialogue content | ||
| 62 | |Required Conditions|Array of Names|In-game conditions that need to be met to trigger this conversation | ||
| 63 | |||
| 64 |