DoomWare API

Scripts and Functions

The following contains a list of scripts and functions which you can use to assist you during the development of new minigames for DoomWare

Minigame Functions

The following functions are to be used to handle basic Minigame logic.

Name	Type	Arguments	Return	Description
DoomWare_Server_GameWait	Script	int time	-	Sets the minigame timer to `time`.
DoomWare_Server_TeleportPlayers	Script	int tid bool telesector bool fog	-	Teleports all the players to `tid`. If `telesector` is enabled, the TeleportInSector method will be used. Otherwise, players will be teleported to individual TID's. Enabling `fog` will enable the teleport effect+sound
DoomWare_Server_TeleportSingle	Script	int plynum int destination	-	Teleports a player with PlayerNumber `plynum` to the destination with ThingID `destination`
DoomWare_Server_ReturnPlayers	Script	bool fog	-	Returns all teleported players back to the main lobby. If `fog` is enabled, then a teleport effect+sound will be emitted.

Player Manipulation

Name	Type	Arguments	Return	Description
Player_Win	Function
Player_Lose	Function
Player_SavePosition	Function
Player_InvalidatePosition	Function
Player_Morph	Function
Player_FreezeTotally	Function
Player_UnFreezeTotally	Function
Give_Achievement	Function

Information

Name	Type	Arguments	Return	Description
Check_LMS	Function
Check_LMS_MVMTie	Function
Check_Player_Won	Function
Check_Player_Lost	Function
Check_WonRoundItem	Function
Check_FailRoundItem	Function

Observer System

Name	Type	Arguments	Return	Description
Add_Observer	Function
Force_Observe	Function

Miscellaneous

Name	Type	Arguments	Return	Description
Calc_Speed	Function
Distance	Function
Max	Function
AToI	Function

DECORATE

Name	Type	Arguments	Return	Description
DoomWare_Entity_MarkCleanup	Script
DoomWare_Entity_CheckCleanup	Script

Global Variables

The following contains a list of global variables which you can modify during the execution of your minigame.

TODO

Internal Functions and Scripts

This section contains a list of internal functions and scripts used by DoomWare. You should have very little reason to use them, but they're here for documentation's sake.

Server Logic

Name	Type	Arguments	Return	Description
DoomWare_Server_Boot	Script
DoomWare_Server_Initialize	Script
DoomWare_Server_InitMap	Script
DoomWare_Server_InitHints	Script
SoloBanList	Function
DoomWare_Server_InitRounds	Script
DoomWare_Server_InitHighscores	Script
DoomWare_Server_InitGlobals	Script
DoomWare_Server_GameLogic	Script
DoomWare_Server_UpdateDB	Script
DoomWare_Server_SyncGlobals	Script

Client Logic

Name	Type	Arguments	Return	Description
DoomWare_Client_Join	Script
DoomWare_Client_Initialize	Script
DoomWare_Client_Death	Script
DoomWare_Client_Disconnect	Script
DoomWare_Client_Respawn	Script
DoomWare_Client_GameLogic	Script
DoomWare_Client_DrawHUD	Script

Checking Functions

Name	Type	Arguments	Return	Description
Should_Speedup	Function
ShouldTieBreak	Function
Is_1v1_TieBreaker	Function
No_MidRound_Array	Function

Wackymods

Name	Type	Arguments	Return	Description
DoomWare_Server_Wackymod	Script
Player_SetWackymod	Function
DoomWare_WackyMod_DoubleJump	Script

Data Networking

Name	Type	Arguments	Return	Description
Player_SetCVar	Function
Player_SetCVarString	Function
Player_SetCVarStringPacked	Function
Pack_Global_Array	Function
Unpack_CVar_Array	Function
Unpack_CVar_Array_String	Function

Database Handling

Name	Type	Arguments	Return	Description
DB_NetworkStats	Function
Load_PlayerDB	Function

Highscore Table

Name	Type	Arguments	Return	Description
257	Script
DoomWare_Server_CalcHighscore	Script
DoomWare_Client_DrawHighscore	Script

Observer System

Name	Type	Arguments	Return	Description
988	Script
DoomWare_Server_ClearObservers	Script

DoomWare Menu

Name	Type	Arguments	Return	Description
999	Script
DoomWare_Client_DrawMenu	Script
Handle_Menu_Option	Function
Handle_Menu_Achievement	Function

Player Hats

Name	Type	Arguments	Return	Description
IsBetaTester	Function
DoomWare_Server_Hats	Script

Miscellaneous

Name	Type	Arguments	Return	Description
DoomWare_Entity_Cleanup	Script
DoomWare_Entity_SetPlayerTranslation	Script
DoomWare_DoLightning	Script
DoomWare_AchievementLog	Script

Internal Global Variables

This section contains a list of internal global variables used by DoomWare. Modifying these variables during gameplay can cause problems with the gamemode, therefore they should be treated as READ ONLY.

TODO