View source

class Engine

package hxdoom

@:directlyUsed

Engine.hx acts as the hub class for accessing data. It contains "cores" that can be utilized for wad data manipulation. Cores can be overriden by the developers to modify behavior. Some of these cores are mandatory to change in order to use.

See also:

Static variables

staticread onlyGAME:GameCore

Handles game behavior, not yet implemented

staticread onlyIO:IOCore

Handles input and output behavior

staticread onlyLEVELS:LevelCore

Handles general map related behaviors

staticread onlyPROFILE:ProfileCore

Sets behavior based on the first IWAD provided

staticread onlyRENDER:RenderCore

Handles render behavior

staticread onlySOUND:SoundCore

Handles sound processing

staticread onlyTEXTURES:TextureCore

Handles texture reading and building

staticread onlyWADDATA:WadCore

Handles wad loading and parsing

staticLOADMAP:String ‑> Bool

Function to call when loading a map. Can be overriden to change behavior.

@:value(logDefault)staticlog:(Array<String>, PosInfos) ‑> Void = logDefault

Placeholder for future engine logging

Parameters:

null

_msg

Static methods

staticlogDefault(_msg:Array<String>, ?_pos:Null<PosInfos>):Void

Constructor

new()

Methods

addWadBytes(_wadBytes:Bytes, _wadName:String):Void

Adds and parses wad into memory.

Parameters:

_wadBytes

Wad as bytes

_wadName

Name of wad

addWadString(_wadString:String, _wadname:String):Void

loadMap(_mapMarker:String):Bool

Default function to load a map that's set to Engine.LOADMAP()

Parameters:

_mapMarker

String denoting map marker directory

setDefaultCVARS():Void

Sets default CVar environment vars.

setcore_IO(?_IO:IOCore):Void

Setter to override IOCore behavior. Changes CVar flag when overriden. Optional.

Parameters:

_cheats

Providing 'null' will reset to default core

setcore_game(?_game:GameCore):Void

Setter to override GameCore behavior. Changes CVar flag when overriden. Optional.

Parameters:

_cheats

Providing 'null' will reset to default core

setcore_levels(?_levels:LevelCore):Void

setcore_profile(?_profile:ProfileCore):Void

Setter to override ProfileCore behavior. Changes CVar flag when overriden. Optional.

Parameters:

_cheats

Providing 'null' will reset to default core

setcore_render(?_render:RenderCore):Void

Setter to override RenderCore behavior. Changes CVar flag when overriden. Mandatory to draw a scene.

Parameters:

_cheats

Providing 'null' will reset to default core

setcore_textures(?_textures:TextureCore):Void

Setter to override TextureCore behavior. Changes CVar flag when overriden. Optional.

Parameters:

_cheats

Providing 'null' will reset to default core

toggleHexenMapFormat():Void