Epok Engine

EPOK RUNTIME

epok::DungeonLibrary

Struct

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Struct

What the editor's Dungeon Generator baked about this map: rooms, how they link, keys, locks, items, free spots, and a random stream tied to the dungeon's seed.

Namespace
epok
Header
gameplay_api.hpp
Include
#include "gameplay_api.hpp"
Module
gameplay-api
Source
runtime/gameplay_api.hpp:570

Basic usage

This generated sketch illustrates syntax for reaching the type; adapt it to the actual API contract. Open a member below for an operation-specific example.

C++ example
#include "gameplay_api.hpp"

epok::DungeonLibrary& value = /* obtain a valid instance from your game */;

Static methods

distanceRooms between two rooms on a shortest way, or -1 when there is no way.Methodexplore_everythingPerforms `explore everything` as part of the gameplay api module.Methodexplore_roomRooms the player has entered show on the minimap, with the corridors they open into.Methodforget_exploredPerforms `forget explored` as part of the gameplay api module.Methodfull_map_shownPerforms `full map shown` as part of the gameplay api module.Methodgoal_roomPerforms `goal room` as part of the gameplay api module.MethoditemA key (lock above 0) or other item the recipe placed.Methoditem_countPerforms `item count` as part of the gameplay api module.MethodlockA locked door: its doorway, the room it guards and the lock its key opens.Methodlock_countPerforms `lock count` as part of the gameplay api module.Methodminimap_shownPerforms `minimap shown` as part of the gameplay api module.MethodneighbourThe `index`-th room linked to `room`, or -1.Methodnext_roomThe room after `from` on a shortest way to `to`; `from` when they are the same room, -1 when there is no way.MethodrandomA number below `below` from the dungeon's own random stream: the same for the same stream, index and seed on every run, so a room can always roll the same enemy.MethodroomPerforms `room` as part of the gameplay api module.Methodroom_atThe room holding a world point (pixels in 2D), or -1 in a corridor or outside.Methodroom_countPerforms `room count` as part of the gameplay api module.Methodroom_exploredPerforms `room explored` as part of the gameplay api module.Methodroom_ofThe room a 3D actor stands in, or -1.MethodseedPerforms `seed` as part of the gameplay api module.Methodshow_full_mapPerforms `show full map` as part of the gameplay api module.Methodshow_minimapfills the screen (for a pause or map screen) over the box.Methodspawn_roomPerforms `spawn room` as part of the gameplay api module.MethodspotA free floor point of a room, away from its doors, keys and items: somewhere to put an enemy or a prop.Method