Package net.mtrop.doom.text

Class ZDoomMapInfo

java.lang.Object

net.mtrop.doom.text.ZDoomMapInfo

All Implemented Interfaces:

Iterable<MapInfoData>, TextObject

public class ZDoomMapInfo
extends Object
implements TextObject, Iterable<MapInfoData>

An abstraction of the ZDoom Map Info entry (ZMAPINFO/MAPINFO). All of the data sets in this info are stored in order, as the ordering matters when read. "Include" directives are not followed - they are instead stored as objects.

Since:

2.19.0

Author:

Matthew Tropiano

Nested Class Summary

Nested classes/interfaces inherited from interface net.mtrop.doom.object.TextObject

TextObject.ParseException, TextObject.Reflect, TextObject.Transformer<TO extends TextObject>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SETTYPE_ADDDEFAULTMAP
static final String	SETTYPE_AUTOMAP
static final String	SETTYPE_CLEAREPISODES
static final String	SETTYPE_CLEARSKILLS
static final String	SETTYPE_CLUSTERDEF
static final String	SETTYPE_CONVERSATIONID
static final String	SETTYPE_DAMAGETYPE
static final String	SETTYPE_DEFAULTMAP
static final String	SETTYPE_DOOMEDNUMS
static final String	SETTYPE_EPISODE
static final String	SETTYPE_GAMEDEFAULTS
static final String	SETTYPE_GAMEINFO
static final String	SETTYPE_INCLUDE
static final String	SETTYPE_INTERMISSON
static final String	SETTYPE_MAP
static final String	SETTYPE_SKILL
static final String	SETTYPE_SPAWNNUMS

Constructor Summary

Constructors

Constructor	Description
ZDoomMapInfo()	Creates a new, blank ZDoom-style MapInfo.

Method Summary

Modifier and Type	Method	Description
MapInfoData	addChild(String type, MapInfoData.Value... typeValues)	Creates a new, empty child set at the end of the list of sets.
MapInfoData	addChildAt(int index, String type, MapInfoData.Value... typeValues)	Creates a new, empty child set to add to at a specific index in the list of sets.
MapInfoData	getChildAt(int index)	Gets a specific typed child set from this MapInfo by its index.
int	getChildCount()
Iterator<MapInfoData>	iterator()
void	readText(Reader reader)	Reads from an Reader and sets this object's fields.
MapInfoData	removeChildAt(int index)	Removes a child set at a specific index.
void	writeText(Writer writer)	Writes this object to a Writer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface net.mtrop.doom.object.TextObject

fromText, readFile, readFile, toText, writeFile, writeFile, writeFile, writeFile

Field Details

SETTYPE_INCLUDE

public static final String SETTYPE_INCLUDE

See Also:

• Constant Field Values

SETTYPE_CLEAREPISODES

public static final String SETTYPE_CLEAREPISODES

See Also:

• Constant Field Values

SETTYPE_EPISODE

public static final String SETTYPE_EPISODE

See Also:

• Constant Field Values

SETTYPE_MAP

public static final String SETTYPE_MAP

See Also:

• Constant Field Values

SETTYPE_DEFAULTMAP

public static final String SETTYPE_DEFAULTMAP

See Also:

• Constant Field Values

SETTYPE_ADDDEFAULTMAP

public static final String SETTYPE_ADDDEFAULTMAP

See Also:

• Constant Field Values

SETTYPE_GAMEDEFAULTS

public static final String SETTYPE_GAMEDEFAULTS

See Also:

• Constant Field Values

SETTYPE_CLUSTERDEF

public static final String SETTYPE_CLUSTERDEF

See Also:

• Constant Field Values

SETTYPE_CLEARSKILLS

public static final String SETTYPE_CLEARSKILLS

See Also:

• Constant Field Values

SETTYPE_SKILL

public static final String SETTYPE_SKILL

See Also:

• Constant Field Values

SETTYPE_GAMEINFO

public static final String SETTYPE_GAMEINFO

See Also:

• Constant Field Values

SETTYPE_INTERMISSON

public static final String SETTYPE_INTERMISSON

See Also:

• Constant Field Values

SETTYPE_AUTOMAP

public static final String SETTYPE_AUTOMAP

See Also:

• Constant Field Values

SETTYPE_DOOMEDNUMS

public static final String SETTYPE_DOOMEDNUMS

See Also:

• Constant Field Values

SETTYPE_SPAWNNUMS

public static final String SETTYPE_SPAWNNUMS

See Also:

• Constant Field Values

SETTYPE_CONVERSATIONID

public static final String SETTYPE_CONVERSATIONID

See Also:

• Constant Field Values

SETTYPE_DAMAGETYPE

public static final String SETTYPE_DAMAGETYPE

See Also:

• Constant Field Values

Constructor Details

ZDoomMapInfo

public ZDoomMapInfo()

Creates a new, blank ZDoom-style MapInfo.

Method Details

addChild

public MapInfoData addChild(String type,
 MapInfoData.Value... typeValues)

Creates a new, empty child set at the end of the list of sets.

Parameters:

type - the set type.

typeValues - the set type's values (if any).

Returns:

the created empty set.

Throws:

IndexOutOfBoundsException - if the index is less than 0 or greater than or equal to the amount of sets in this MapInfo.

addChildAt

public MapInfoData addChildAt(int index,
 String type,
 MapInfoData.Value... typeValues)

Creates a new, empty child set to add to at a specific index in the list of sets.

Parameters:

index - the index to add to.

type - the set type.

typeValues - the set type's values (if any).

Returns:

the created empty set.

Throws:

IndexOutOfBoundsException - if the index is less than 0 or greater than or equal to the amount of sets in this MapInfo.

getChildAt

public MapInfoData getChildAt(int index)

Gets a specific typed child set from this MapInfo by its index.

Parameters:

index - the index of the child set.

Returns:

the child set at the index.

Throws:

IndexOutOfBoundsException - if the index is less than 0 or greater than or equal to the amount of sets in this MapInfo.

removeChildAt

public MapInfoData removeChildAt(int index)

Removes a child set at a specific index.

Parameters:

index - the index.

Returns:

the removed set.

Throws:

IndexOutOfBoundsException - if the index is less than 0 or greater than or equal to the amount of sets in this MapInfo.

getChildCount

public int getChildCount()

Returns:

the amount of child sets in this MapInfo.

iterator

public Iterator<MapInfoData> iterator()

Specified by:

iterator in interface Iterable<MapInfoData>

readText

public void readText(Reader reader)
              throws IOException

Description copied from interface: TextObject

Reads from an Reader and sets this object's fields.

Specified by:

readText in interface TextObject

Parameters:

reader - the Reader to read from.

Throws:

IOException - if a read error occurs.

writeText

public void writeText(Writer writer)
               throws IOException

Description copied from interface: TextObject

Writes this object to a Writer.

Specified by:

writeText in interface TextObject

Parameters:

writer - the Writer to write to.

Throws:

IOException - if a write error occurs.