Hooks
Hooks provided by the War Table module for managing strategic war table functionality.
Overview
The War Table module provides an interactive 3D strategic planning system that allows players to visualize and coordinate operations on detailed maps. It includes marker placement for tactical positioning, support for multiple map layouts, and comprehensive hook integration for customizing gameplay mechanics. The module enables real-time strategic coordination with visual markers, map management, and event-driven interactions that can be extended through custom hooks for specialized gameplay modes, team coordination, and dynamic mission planning.
PostWarTableClear
đ Purpose
Called after a war table is cleared.
â° When Called
After all markers are removed from the table.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player who cleared the table |
tableEnt |
Entity | The war table entity |
âŠī¸ Returns
nil
đ Realm
Server
PostWarTableMapChange
đ Purpose
Called after a war table map image is changed.
â° When Called
After the map image is updated and broadcast.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player who changed the map |
tableEnt |
Entity | The war table entity |
text |
string | The new map image URL |
âŠī¸ Returns
nil
đ Realm
Server
PostWarTableMarkerPlace
đ Purpose
Called after a marker is placed on a war table.
â° When Called
After the marker entity is created and parented.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player who placed the marker |
marker |
Entity | The marker entity that was created |
tableEnt |
Entity | The war table entity |
âŠī¸ Returns
nil
đ Realm
Server
PostWarTableMarkerRemove
đ Purpose
Called after a marker is removed from a war table.
â° When Called
After the marker entity is removed.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player who removed the marker |
ent |
Entity | The marker entity that was removed |
tableEnt |
Entity | The war table entity |
âŠī¸ Returns
nil
đ Realm
Server
PostWarTableUsed
đ Purpose
Called after a war table is used.
â° When Called
After a war table interaction completes.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player who used the table |
tableEnt |
Entity | The war table entity |
âŠī¸ Returns
nil
đ Realm
Server
PreWarTableClear
đ Purpose
Called before a war table is cleared.
â° When Called
Before markers are removed from the table.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player clearing the table |
tableEnt |
Entity | The war table entity |
âŠī¸ Returns
nil
đ Realm
Server
PreWarTableMapChange
đ Purpose
Called before a war table map image is changed.
â° When Called
Before the map image is updated.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player changing the map |
tableEnt |
Entity | The war table entity |
text |
string | The new map image URL to be set |
âŠī¸ Returns
nil
đ Realm
Server
PreWarTableMarkerPlace
đ Purpose
Called before a marker is placed on a war table.
â° When Called
Before the marker entity is created.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player placing the marker |
pos |
Vector | The position where the marker will be placed |
bodygroups |
table | The bodygroup table for the marker |
tableEnt |
Entity | The war table entity |
âŠī¸ Returns
nil
đ Realm
Server
PreWarTableMarkerRemove
đ Purpose
Called before a marker is removed from a war table.
â° When Called
Before the marker entity is removed.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player removing the marker |
ent |
Entity | The marker entity to be removed |
tableEnt |
Entity | The war table entity |
âŠī¸ Returns
nil
đ Realm
Server
PreWarTableUsed
đ Purpose
Called before a war table is used.
â° When Called
When a war table interaction begins.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player using the table |
tableEnt |
Entity | The war table entity |
âŠī¸ Returns
nil
đ Realm
Server
WarTableCleared
đ Purpose
Called when a war table is cleared.
â° When Called
After the clear operation completes.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player who cleared the table |
tableEnt |
Entity | The war table entity |
âŠī¸ Returns
nil
đ Realm
Server
WarTableMapChanged
đ Purpose
Called when a war table map image is changed.
â° When Called
After the map change is processed.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player who changed the map |
tableEnt |
Entity | The war table entity |
text |
string | The new map image URL |
âŠī¸ Returns
nil
đ Realm
Server
WarTableMarkerPlaced
đ Purpose
Called when a marker is placed on a war table.
â° When Called
After the marker is created and positioned.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player who placed the marker |
marker |
Entity | The marker entity that was created |
tableEnt |
Entity | The war table entity |
âŠī¸ Returns
nil
đ Realm
Server
WarTableMarkerRemoved
đ Purpose
Called when a marker is removed from a war table.
â° When Called
After the marker is removed.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player who removed the marker |
ent |
Entity | The marker entity that was removed |
tableEnt |
Entity | The war table entity |
âŠī¸ Returns
nil
đ Realm
Server
WarTableUsed
đ Purpose
Called when a war table is used.
â° When Called
When a war table interaction occurs.
âī¸ Parameters
| Parameter | Type | Description |
|---|---|---|
client |
Player | The player using the table |
tableEnt |
Entity | The war table entity |
âŠī¸ Returns
nil
đ Realm
Server