Doomwad::Switches Class Reference

Inheritance diagram for Doomwad::Switches:

List of all members.

---

Detailed Description

Switches resource.

Switches is a Boom extension that specifies new switch textures beyond the built-in switches in Doom. This resource is compiled into a simple binary format. Each record is 20 bytes:

SWITCHES Attributes:
9 bytes Null-terminated string with name of off texture.
9 bytes Null-terminated string with name of on texture.
2 bytes Switch for Wads in which this lump will work. Leave at default for maximum compatibility.

See also:

Switch WadEntry

Definition at line 110 of file switches.hpp.

Public Member Functions
virtual bool	setFromLump (const Lump &lump) throw ()
	Convert a Lump to this entry.
	Switches (const Lump &) throw ()
	Construct from a Lump.
	Switches (void) throw ()
	Default constructor.
virtual Lump	toLump (void) const throw ()
	Convert this entry to a Lump.
virtual std::string	toString (void) const throw ()
	Convert this entry to a std::string.
virtual	~Switches (void) throw ()
	Destructor.
Static Public Attributes
static const std::string	NAME = "SWITCHES"
	Name of an entry.

---

Constructor & Destructor Documentation

Switches::Switches (  const Lump &  lump  )  throw ()

Construct from a Lump. Constructs a Animated object given raw Lump data. Parameters: lump  Source Lump from which to pull Animated data. Definition at line 139 of file switches.cpp. References setFromLump().

Switches::~Switches (  void   )  throw () [virtual]

Destructor. Does nothing, but is necessary for inheritance. Definition at line 150 of file switches.cpp.

---

Member Function Documentation

bool Switches::setFromLump (  const Lump &  lump  )  throw () [virtual]

Convert a Lump to this entry. Lumps should not know about specific data structures. Those structures know about Lumps, including how to convert from them. Setting from a Lump involves parsing that Lump's contents to see if they are valid. If they are, then this object will contain what you expect it to. If not, it will return false and the atomic operation will not succeed. Parameters: lump  Reference to a source Lump object. Returns: True if successful, false if not. Implements Doomwad::WadEntry. Definition at line 155 of file switches.cpp. References Doomwad::Switch::read(). Referenced by Switches().

Lump Switches::toLump (  void   )  const throw () [virtual]

Convert this entry to a Lump. Each subclass must be able to convert itself to a Lump for storage in a Wad. Returns: Lump containing the raw file representation of this entry. Implements Doomwad::WadEntry. Definition at line 171 of file switches.cpp. References NAME.

std::string Switches::toString (  void   )  const throw () [virtual]

Convert this entry to a std::string. The exact implementation varies by the exact concrete class, but the idea is to convert the entry into a summary to be displayed to the user. Please note that converting to a string may lose information. This is not serialization in the purest sense of the word, this is merely a quick and dirty user-readable summary of the entry. True serialization is achieved by converting a Lump object and using its stream I/O functions to read and write. Returns: std::string containing a summary of this entry. Implements Doomwad::WadEntry. Definition at line 185 of file switches.cpp.

---