OpenXcom Namespace Reference

COPYING: More...

Namespaces
	CrossPlatform
	Generic purpose functions that need different implementations for different platforms.
	Options
	Container for all the various global game options and customizable settings.
	RNG
	Random Number Generator used throughout the game for all your randomness needs.

Classes
class	BaseInfoState
	Base Info screen that shows all the stats of a base from the Basescape. More...
class	BasescapeState
	Basescape screen that shows a base's layout and lets the player manage their bases. More...
class	BaseView
	Interactive view of a base. More...
class	BuildFacilitiesState
	Window shown with all the facilities available to build. More...
class	CraftArmorState
	Select Armor screen that lets the player pick armor for the soldiers on the craft. More...
class	CraftEquipmentState
	Equipment screen that lets the player pick the equipment to carry on a craft. More...
class	CraftInfoState
	Craft Info screen that shows all the info of a specific craft. More...
class	CraftSoldiersState
	Select Squad screen that lets the player pick the soldiers to assign to a craft. More...
class	CraftsState
	Equip Craft screen that lets the player manage all the crafts in a base. More...
class	CraftWeaponsState
	Select Armament window for changing the weapon equipped on a craft. More...
class	DismantleFacilityState
	Window shown when the player tries to dismantle a facility. More...
class	ManageAlienContainmentState
	ManageAlienContainment screen that lets the player manage alien numbers in a particular base. More...
class	ManufactureInfoState
	Screen that allows changing of Production settings (assigned engineer, units to build). More...
class	ManufactureStartState
	Screen which displays needed elements to start productions (items/required workshop state/cost to build a unit, ...). More...
class	ManufactureState
	Manufacture screen that lets the player manage all the manufacturing operations of a base. More...
class	MiniBaseView
	Mini view of a base. More...
class	MonthlyCostsState
	Monthly Costs screen that displays all the maintenance costs of a particular base. More...
class	NewManufactureListState
	Screen which list possible productions. More...
class	NewResearchListState
	Window which displays possible research projects. More...
class	PlaceFacilityState
	Window shown when the player tries to build a facility. More...
class	PlaceLiftState
	Screen shown when the player has to place the access lift of a base. More...
class	PlaceStartFacilityState
	Window shown when the player tries to build a facility. More...
class	PurchaseState
	Purchase/Hire screen that lets the player buy new items for a base. More...
class	ResearchInfoState
	Window which allows changing of the number of assigned scientist to a project. More...
class	ResearchState
	Research screen that lets the player manage all the researching operations of a base. More...
class	SackSoldierState
	Window shown when the player tries to sack a soldier. More...
class	SelectStartFacilityState
	Window shown with all the facilities available to build. More...
class	SellState
	Sell/Sack screen that lets the player sell any items in a particular base. More...
class	SoldierArmorState
	Select Armor window that allows changing of the armor equipped on a soldier. More...
class	SoldierInfoState
	Soldier Info screen that shows all the info of a specific soldier. More...
class	SoldierMemorialState
	Screen that shows all the soldiers that have died throughout the game. More...
class	SoldiersState
	Soldiers screen that lets the player manage all the soldiers in a base. More...
class	StoresState
	Stores window that displays all the items currently stored in a base. More...
class	TransferBaseState
	Window that lets the player pick the base to transfer items to. More...
class	TransferConfirmState
	Window to confirm a transfer between bases. More...
class	TransferItemsState
	Transfer screen that lets the player pick what items to transfer between bases. More...
class	TransfersState
	Transfers window that displays all the items currently in-transit to a base. More...
class	AbortMissionState
	Screen which asks for confirmation to abort mission. More...
class	ActionMenuItem
	A class that represents a single box in the action popup menu on the battlescape. More...
class	ActionMenuState
	Window that allows the player to select a battlescape action. More...
class	AlienBAIState
	This class is used by the BattleUnit AI. More...
class	AliensCrashState
	Screen shown when all aliens died during a crash site. More...
class	BattleAIState
	This class is used by the BattleUnit AI. More...
struct	BattleAction
class	BattlescapeGame
	Battlescape game - the core game engine of the battlescape game. More...
class	BattlescapeGenerator
	A utility class that generates the initial battlescape data. More...
class	BattlescapeMessage
	Generic window used to display messages over the Battlescape map. More...
class	BattlescapeState
	Battlescape screen which shows the tactical battle. More...
class	BattleState
	This class sets the battlescape in a certain sub-state. More...
class	BriefingState
	Briefing screen which displays info about a Crash Site mission. More...
class	Camera
	Class handling camera movement, either by mouse or by events on the battlescape. More...
class	CannotReequipState
	Screen shown when there's not enough equipment to re-equip a craft after a mission. More...
class	CivilianBAIState
	This is the intial AI state of units, walking around and looking for intruders. More...
class	ClearAlienBase
	Clears the alien base from supply missions that use it. More...
struct	DebriefingStat
struct	ReequipStat
class	DebriefingState
	Debriefing screen shown after a Battlescape mission that displays the results. More...
class	DelayedSaveState
class	Explosion
	A class that represents an explosion animation. More...
class	ExplosionBState
	Explosion state not only handles explosions, but also bullet impacts! Refactoring tip : ImpactBState. More...
class	InfoboxOKState
	Notifies the player about things like soldiers going unconscious or dying from wounds. More...
class	InfoboxState
	Frame that briefly shows some info like : Yasuaki Okamoto Has Panicked. More...
class	Inventory
	Interactive view of an inventory. More...
class	InventoryState
	Screen which displays soldier's inventory. More...
class	Map
	Interactive map of the battlescape. More...
class	MedikitTitle
	Helper class for the medikit title. More...
class	MedikitTxt
	Helper class for the medikit value. More...
class	MedikitButton
	Helper class for the medikit button. More...
class	MedikitState
	The Medikit User Interface. More...
class	MedikitView
	Display a view of unit wounds. More...
class	MiniMapState
	The MiniMap is a representation of a Battlescape map that allows you to see more of the map. More...
class	MiniMapView
	MiniMapView is the class used to display the map in the MiniMapState. More...
class	NextTurnState
	Screen which announces the next turn. More...
class	NoContainmentState
	Screen shown when there's not enough containment to capture a live alien after a mission. More...
class	Pathfinding
	A utility class that calculates the shortest path between two points on the battlescape map. More...
class	PathfindingNode
	A class that holds pathfinding info for a certain node on the map. More...
class	MinNodeCosts
	Compares PathfindingNode pointers based on TU cost. More...
struct	OpenSetEntry
class	EntryCompare
	Helper class to compare entries through pointers. More...
class	PathfindingOpenSet
	A class that holds references to the nodes to be examined in pathfinding. More...
class	Position
	Easy handling of X-Y-Z coordinates. More...
class	PrimeGrenadeState
	Window that allows the player to set the timer of an explosive. More...
class	Projectile
	A class that represents a projectile. More...
class	ProjectileFlyBState
	A projectile state. More...
class	PromotionsState
	Promotions screen that displays new soldier ranks. More...
class	ScannerState
	The Scanner User Interface. More...
class	ScannerView
	Displays a view of units movement. More...
class	TileEngine
	A utility class that modifies tile properties on a battlescape map. More...
class	UnitDieBState
	State for dying units. More...
class	UnitFallBState
	State for falling units. More...
class	UnitInfoState
	Unit Info screen that shows all the info of a specific unit. More...
class	UnitPanicBState
	State for panicking units. More...
class	UnitSprite
	A class that renders a specific unit, given its render rules combining the right frames from the surfaceset. More...
class	UnitTurnBState
	State for turning units. More...
class	UnitWalkBState
	State for walking units. More...
class	WarningMessage
	Coloured box with text inside that fades out after it is displayed. More...
class	Action
	Container for all the information associated with a given user action, like mouse clicks, key presses, etc. More...
class	AdlibMusic
	Container for Adlib music tracks. More...
class	CatFile
	Subclass of std::ifstream to handle CAT files. More...
class	Exception
	Basic exception class to distinguish OpenXcom exceptions from the rest. More...
class	FastLineClip
	Fast line clip. More...
class	Font
	Takes care of loading and storing each character in a sprite font. More...
class	Game
	The core of the game engine, manages the game's entire contents and structure. More...
struct	seq
	MIDI sequence. More...
struct	track
	MIDI track. More...
struct	gmstream
	MIDI stream. More...
struct	output_status
	Output status. More...
class	GMCatFile
	Subclass of CatFile to handle gm.cat files that contain MIDI music streams. More...
struct	GraphSubset
class	InteractiveSurface
	Surface that the user can interact with. More...
class	Language
	Contains strings used throughout the game for localization. More...
class	OneSingular
	Default plurality rules. More...
class	ZeroOneSingular
	Plurality rules where 0 is also singular. More...
class	NoSingular
	Plurality rules where there is no singular. More...
class	CyrillicPlurality
	Plurality rules for Cyrillic languages (Russian, Ukranian, etc.) More...
class	CzechPlurality
	Plurality rules for Czech and Slovak languages. More...
class	PolishPlurality
	Plurality rules for the Polish language. More...
class	RomanianPlurality
	Plurality rules for Romanian and Moldavian languages. More...
class	LanguagePlurality
	This class is the interface used to find plural forms for the different languages. More...
class	LocalizedText
	A string that is already translated. More...
class	Logger
	A basic logging and debugging class, prints output to stdout/files and can capture stack traces of fatal errors too. More...
class	Music
	Container for music tracks. More...
union	UnsafePointerContainer
class	OpenGL
class	OptionInfo
	Helper class that ties metadata to particular options to help in serializing and stuff. More...
class	Palette
	Container for palettes (sets of 8bpp colors). More...
class	Screen
	A display screen, handles rendering onto the game window. More...
class	ShaderMove
class	ShaderRepeat
class	Sound
	Container for sound effects. More...
class	SoundSet
	Container of a set of sounds. More...
class	State
	A game state that receives user input and reacts accordingly. More...
struct	ColorReplace
	help class used for Surface::blitNShade More...
struct	StandartShade
	help class used for Surface::blitNShade More...
class	Surface
	Element that is blit (rendered) onto the screen. More...
class	SurfaceSet
	Container of a set of surfaces. More...
class	Timer
	Timer used to run code in fixed intervals. More...
class	Zoom
class	AlienBaseState
	Displays info on an alien base. More...
class	AlienTerrorState
	Displays info on a terror site. More...
class	AllocatePsiTrainingState
	Screen shown monthly to allow changing soldiers currently in psi training. More...
class	BaseDefenseState
	Base Defense Screen for when ufos try to attack. More...
class	BaseDestroyedState
	Screen that allows the player to pick a target for a craft on the globe. More...
class	BaseNameState
	Window used to input a name for a new base. More...
class	BuildNewBaseState
	Screen that allows the player to place a new base on the globe. More...
class	ConfirmCydoniaState
	Screen that allows the player to pick a target for a craft on the globe. More...
class	ConfirmDestinationState
	Window that allows the player to confirm a craft's new destination. More...
class	ConfirmLandingState
	Window that allows the player to confirm a craft landing at its destination. More...
class	ConfirmNewBaseState
	Screen that allows the player to confirm a new base on the globe. More...
struct	CordPolar
struct	Cord
class	CraftErrorState
	Window used to notify the player when an error occurs with a craft procedure. More...
class	CraftPatrolState
	Window displayed when a craft starts patrolling a waypoint. More...
class	DefeatState
	Game Over Screens. More...
class	DogfightState
	Shows a dogfight (interception) between a player craft and an UFO. More...
class	FundingState
	Funding screen accessible from the Geoscape that shows all the countries' funding. More...
class	GeoscapeCraftState
	Craft window that displays info about a specific craft out on the Geoscape. More...
class	DetectXCOMBase
	Functor that attempt to detect an XCOM base. More...
struct	SetRetaliationTarget
	Functor that marks an XCOM base for retaliation. More...
class	callThink
	Call AlienMission::think() with proper parameters. More...
struct	expireCrashedUfo
	Advance time for crashed UFOs. More...
class	GenerateSupplyMission
	This class will attempt to generate a supply mission for a base. More...
class	GeoscapeState
	Geoscape screen which shows an overview of the world and lets the player manage the game. More...
class	Globe
	Interactive globe view of the world. More...
struct	GraphButInfo
class	GraphsState
	Graphs screen for displaying graphs of various monthly game data like activity and funding. More...
class	InterceptState
	Intercept window that lets the player launch crafts into missions from the Geoscape. More...
class	ItemsArrivingState
	Items Arriving window that displays all the items that have arrived at bases. More...
class	LowFuelState
	Window displayed when a craft starts running out of fuel (only has exactly enough to make it back to base). More...
class	MonthlyReportState
	Report screen shown monthly to display changes in the player's performance and funding. More...
class	MultipleTargetsState
	Displays a list of possible targets. More...
class	NewPossibleManufactureState
	Window which inform the player of new possible manufacture projects. More...
class	NewPossibleResearchState
	Window which inform the player of new possible research projects. More...
class	Polygon
	Represents a polygon in the world map. More...
class	Polyline
	Represents a polyline in the world map. More...
class	ProductionCompleteState
	Window used to notify the player when a production is completed. More...
class	PsiTrainingState
	Screen shown monthly when the player has psi labs available. More...
class	ResearchCompleteState
	Window which inform the player that a research project is finished. More...
class	ResearchRequiredState
	Window shown when the player researches a weapon before the respective clip. More...
class	SelectDestinationState
	Screen that allows the player to pick a target for a craft on the globe. More...
class	TargetInfoState
	Generic window used to display all the crafts targeting a certain point on the map. More...
class	UfoDetectedState
	Displays info on a detected UFO. More...
class	UfoLostState
	Notifies the player when a targeted UFO goes outside radar range. More...
class	VictoryState
	Game Over Screens. More...
class	ArrowButton
	Button with an arrow on it. More...
class	Bar
	Bar graphic that represents a certain value. More...
class	ComboBox
	Text button with a list dropdown when pressed. More...
class	Cursor
	Mouse cursor that replaces the system cursor. More...
class	FpsCounter
	Counts the amount of frames each second and displays them in a NumberText surface. More...
class	Frame
	Fancy frame border thing used for windows and other elements. More...
class	ImageButton
	Regular image that works like a button. More...
class	NumberText
	Number digits displayed on the screen. More...
class	ScrollBar
	Horizontal scrollbar control to select from a range of values. More...
class	Slider
	Horizontal slider control to select from a range of values. More...
class	Text
	Text string displayed on screen. More...
class	TextButton
	Coloured button with a text label. More...
class	TextEdit
	Editable version of Text. More...
class	TextList
	List of Text's split into columns. More...
class	ToggleTextButton
class	Window
	Box with a coloured border and custom background. More...
class	AbandonGameState
	Abandon Game window shown before quitting the game from the Geoscape. More...
class	ConfirmLoadState
	Confirms loading a save with missing content. More...
class	DeleteGameState
	window used to confirm save game deletion. More...
class	ErrorMessageState
	Generic window used to display error messages. More...
struct	soundInFile
struct	introSoundEffect
struct	AudioSequence
class	IntroState
	Shows the intro cinematic. More...
struct	compareSaveName
struct	compareSaveTimestamp
class	ListGamesState
	Base class for saved game screens which provides the common layout and listing. More...
class	ListLoadState
	Load Game screen for listing info on available saved games and loading them. More...
class	ListSaveState
	Save Game screen for listing info on available saved games and saving them. More...
class	LoadGameState
	Loads a saved game, with an optional message. More...
class	MainMenuState
	Main Menu window displayed when first starting the game. More...
class	NewBattleState
	New Battle that displays a list of options to configure a new standalone mission. More...
class	NewGameState
	New Game window that displays a list of possible difficulties for creating a saved game. More...
class	OptionsAdvancedState
	Options window that displays the advanced game settings. More...
class	OptionsAudioState
	Screen that lets the user configure various Audio options. More...
class	OptionsBaseState
	Options base state for common stuff across Options windows. More...
class	OptionsBattlescapeState
	Screen that lets the user configure various Battlescape options. More...
class	OptionsConfirmState
	Confirmation window when Display Options are changed. More...
class	OptionsControlsState
	Controls screen which allows the user to customize the various key shortcuts in the game. More...
class	OptionsDefaultsState
	Confirmation window when restoring the default game options. More...
class	OptionsGeoscapeState
	Screen that lets the user configure various Geoscape options. More...
class	OptionsModsState
	Options window that displays the available mods. More...
class	OptionsNoAudioState
	Screen that indicates there is no audio available. More...
class	OptionsVideoState
	Screen that lets the user configure various Video options. More...
class	PauseState
	Options window shown for loading/saving/quitting the game. More...
class	SaveGameState
	Saves the current game, with an optional message. More...
class	StartState
	Initializes the game and loads all required content. More...
class	TestState
	A state purely for testing game functionality. More...
class	ResourcePack
	Packs of external game media. More...
class	XcomResourcePack
	Resource pack for the X-Com: UFO Defense game. More...
struct	ItemSet
struct	DeploymentData
class	AlienDeployment
	Represents a specific type of Alien Deployment. More...
class	AlienRace
	Represents a specific race "family", or a "main race" if you wish. More...
class	Armor
	Represents a specific type of armor. More...
class	ArticleDefinition
	ArticleDefinition is the base class for all article types. More...
class	ArticleDefinitionRect
class	ArticleDefinitionCraft
	ArticleDefinitionCraft defines articles for craft, e.g. More...
class	ArticleDefinitionCraftWeapon
	ArticleDefinitionCraftWeapon defines articles for craft weapons, e.g. More...
class	ArticleDefinitionText
	ArticleDefinitionText defines articles with only text, e.g. More...
class	ArticleDefinitionTextImage
	ArticleDefinitionTextImage defines articles with text on the left and an image on the right side of the screen, e.g. More...
class	ArticleDefinitionBaseFacility
	ArticleDefinitionBaseFacility defines articles for base facilities, e.g. More...
class	ArticleDefinitionItem
	ArticleDefinitionItem defines articles for all Items, e.g. More...
class	ArticleDefinitionUfo
	ArticleDefinitionUfo defines articles for UFOs, e.g. More...
class	ArticleDefinitionArmor
	ArticleDefinitionArmor defines articles for Armor, e.g. More...
class	ArticleDefinitionVehicle
	ArticleDefinitionVehicle defines articles for Vehicles, e.g. More...
class	City
	Represents a city of the world. More...
class	ExtraSounds
	For adding a set of extra sound data to the game. More...
class	ExtraSprites
	For adding a set of extra sprite data to the game. More...
class	ExtraStrings
	For adding a set of extra strings to the game. More...
class	MapBlock
	Represents a Terrain Map Block. More...
class	MapData
	MapData is the smallest piece of a Battlescape terrain, holding info about a certain object, wall, floor, ... More...
class	MapDataSet
	Represents a Terrain Map Datafile. More...
class	MCDPatch
	An MCD data Patch. More...
struct	MissionWave
	Information about a mission wave. More...
class	RuleAlienMission
	Stores fixed information about a mission type. More...
class	RuleBaseFacility
	Represents a specific type of base facility. More...
class	RuleCountry
	Represents a specific funding country. More...
class	RuleCraft
	Represents a specific type of craft. More...
class	RuleCraftWeapon
	Represents a specific type of craft weapon. More...
struct	RuleSlot
class	RuleInventory
	Represents a specific section of the inventory, containing information like available slots and screen position. More...
class	RuleItem
	Represents a specific type of item. More...
class	RuleManufacture
	Represents the information needed to manufacture an object. More...
struct	MissionArea
	Defines a rectangle in polar coordinates. More...
struct	MissionZone
	A zone (set of areas) on the globe. More...
class	RuleRegion
	Represents a specific region of the world. More...
class	RuleResearch
	Represents one research project. More...
class	EqualCoordinates
	Match a city based on coordinates. More...
struct	compareRule
	Compares rules based on their list orders. More...
struct	compareRule< RuleCraftWeapon >
	Craft weapons use the list order of their launcher item. More...
struct	compareRule< Armor >
	Armor uses the list order of their store item. More...
struct	compareRule< ArticleDefinition >
	Ufopaedia articles use section and list order. More...
class	Ruleset
	Set of rules and stats for a game. More...
class	RuleSoldier
	Represents the creation data for a specific type of unit. More...
class	RuleTerrain
	Represents a specific type of Battlescape Terrain. More...
class	RuleUfo
	Represents a specific type of UFO. More...
class	SoldierNamePool
	Pool of soldier names to generate random names. More...
class	StatString
	For adding statStrings to the game. More...
class	StatStringCondition
struct	TrajectoryWaypoint
	Information for points on a UFO trajectory. More...
class	UfoTrajectory
	Holds information about a specific trajectory. More...
struct	UnitStats
	This struct holds some plain unit attribute data together. More...
class	Unit
	Represents the static data for a unit that is generated on the battlescape, this includes: HWPs, aliens and civilians. More...
class	AlienBase
	Represents an alien base on the world. More...
class	matchById
class	FindMarkedXCOMBase
	Find an XCOM base in this region that is marked for retaliation. More...
class	MatchBaseCoordinates
	Match a base from it's coordinates. More...
class	AlienMission
	Represents an ongoing alien mission. More...
class	AlienStrategy
	Stores the information about alien strategy. More...
struct	isMindShield
	Functor to check for mind shield capability. More...
struct	isCompleted
	Functor to check for completed facilities. More...
class	Base
	Represents a player base on the globe. More...
class	BaseFacility
	Represents a base facility placed in a base. More...
class	BattleItem
	Represents a single item in the battlescape. More...
class	BattleUnit
	Represents a moving unit in the battlescape, player controlled or AI controlled it holds info about it's position, items carrying, stats, etc. More...
class	Country
	Represents a country that funds the player. More...
class	Craft
	Represents a craft stored in a base. More...
class	CraftWeapon
	Represents a craft weapon equipped by a craft. More...
class	CraftWeaponProjectile
class	EquipmentLayoutItem
	Represents a soldier-equipment layout item which is used on the beginning of the Battlescape. More...
class	GameTime
	Stores the current ingame time/date according to GMT. More...
class	ItemContainer
	Represents the items contained by a certain entity, like base stores, craft equipment, etc. More...
class	MovingTarget
	Base class for moving targets on the globe with a certain speed and destination. More...
class	Node
	Represents a node/spawnpoint in the battlescape, loaded from RMP files. More...
class	Production
class	Region
	Represents a region of the world. More...
class	ResearchProject
	Represent a ResearchProject Contain information about assigned scientist, time already spent and cost of the project. More...
class	SavedBattleGame
	The battlescape data that gets written to disk when the game is saved. More...
struct	findRuleResearch
struct	equalProduction
class	matchRegionAndType
	Match a mission based on region and type. More...
class	ContainsPoint
	Check if a point is contained in a region. More...
struct	SaveInfo
	Container for savegame info displayed on listings. More...
class	SavedGame
	The game data that gets written to disk when the game is saved. More...
class	Soldier
	Represents a soldier hired by the player. More...
class	SoldierDeath
	Stores info about a soldier's death. More...
class	Target
	Base class for targets on the globe with a set of radian coordinates. More...
class	TerrorSite
	Represents an alien terror site on the world. More...
class	Tile
	Basic element of which a battle map is build. More...
class	Transfer
	Represents an item transfer. More...
class	matchMissionID
	Match AlienMission based on the unique ID. More...
class	Ufo
	Represents an alien UFO on the map. More...
class	Vehicle
	Represents a vehicle (tanks etc.) kept in a craft. More...
class	Waypoint
	Represents a fixed waypoint on the world. More...
class	WeightedOptions
	Holds pairs of relative weights and IDs. More...
class	ArticleState
	UfopaediaArticle is the base class for all articles of various types. More...
class	ArticleStateArmor
	ArticleStateArmor has a caption, preview image and a stats block. More...
class	ArticleStateBaseFacility
	ArticleStateBaseFacility has a caption, text, preview image and a stats block. More...
class	ArticleStateCraft
	ArticleStateCraft has a caption, text, background image and a stats block. More...
class	ArticleStateCraftWeapon
	ArticleStateCraftWeapon has a caption, background image and a stats block. More...
class	ArticleStateItem
	ArticleStateItem has a caption, text, preview image and a stats block. More...
class	ArticleStateText
	ArticleStateText has only a caption and a text. More...
class	ArticleStateTextImage
	ArticleStateTextImage has a title, text block and a background image. More...
class	ArticleStateUfo
	ArticleStateUfo has a caption, text, preview image and a stats block. More...
class	ArticleStateVehicle
	ArticleStateVehicle hasa caption, text and a stats block. More...
class	Ufopaedia
	This static class encapsulates all functions related to Ufopaedia for the game. More...
class	UfopaediaSelectState
	UfopaediaSelectState is the screen that lists articles of a given type. More...
class	UfopaediaStartState
	UfopaediaStartState is the screen that opens when clicking Ufopaedia button in Geoscape. More...

Typedefs
typedef std::vector < ArticleDefinition * >	ArticleDefinitionList
	definition of an article list

Enumerations
enum	SeverityLevel {   LOG_FATAL, LOG_ERROR, LOG_WARNING, LOG_INFO,   LOG_DEBUG }
	Defines the various severity levels of information logged by the game. More...
enum	ScrollType
	Battlescape drag scrolling types.
enum	KeyboardType
	Keyboard input modes.
enum	SaveSort
	Savegame sorting modes.
enum	MusicFormat
	Music format preferences.
enum	SoundFormat
	Sound format preferences.
enum	PathPreview
	Path preview modes (can be OR'd together).
enum	WindowPopup
	Enumeration for the type of animation when a window pops up.
enum	UfopaediaTypeId
	define article types
enum	TimeTrigger
	Enumerator for time periods.
enum	GameDifficulty
	Enumerator containing all the possible game difficulties.
enum	SaveType
	Enumerator for the various save types.

Functions
template<typename type >
std::wstring	toString (type t)
	Helper function that returns a string representation of a type (mainly used for numbers). More...
std::wostream &	operator<< (std::wostream &os, const LocalizedText &txt)
	Allow streaming of LocalizedText objects.
ShaderMove< Uint8 >	ShaderSurface (Surface *s)
	Create warper from Surface. More...
ShaderMove< Uint8 >	ShaderSurface (Surface *s, int x, int y)
	Create warper from Surface and provided offset. More...
ShaderMove< Uint8 >	ShaderCrop (Surface *s, int x, int y)
	Create warper from cropped Surface and provided offset. More...
ShaderMove< Uint8 >	ShaderCrop (Surface *s)
	Create warper from cropped Surface. More...

Variables
const std::string	PARTS_STRING [6]
	User interface string identifier of body parts.

Detailed Description

COPYING:

Don't care ware... ;)

Something like: "you can do with it what you want to do with it. But if your cola vaporises you can't sue me. But if you make changes to the code you can always send to diffs to me"

grt,

• Jasper

  +--— | Beheer Commisaris | Homepage: http://www.il.fontys.nl/~jasper | IGV Interlink | PGP-key: finger jaspe.nosp@m.r@il.nosp@m..font.nosp@m.ys.n.nosp@m.l | | E-mail: jaspe.nosp@m.r@il.nosp@m..font.nosp@m.ys.n.nosp@m.l | -—+

Enumeration Type Documentation

enum OpenXcom::SeverityLevel

Defines the various severity levels of information logged by the game.

Enumerator
LOG_FATAL	Something horrible has happened and the game is going to die!
LOG_ERROR	Something bad happened but we can still move on.
LOG_WARNING	Something weird happened, nothing special but it's good to know.
LOG_INFO	Useful information for users/developers to help debug and figure stuff out.
LOG_DEBUG	Purely test stuff to help developers implement, not really relevant to users.

Function Documentation

ShaderMove<Uint8> OpenXcom::ShaderCrop ( Surface *  s, int  x, int  y  )

inline

Create warper from cropped Surface and provided offset.

Parameters

s	standard 8bit OpenXcom surface
x	offset on x
y	offset on y

Returns

ShaderMove<Uint8> OpenXcom::ShaderCrop ( Surface *  s )

inline

Create warper from cropped Surface.

Parameters

s	standard 8bit OpenXcom surface

Returns

ShaderMove<Uint8> OpenXcom::ShaderSurface ( Surface *  s )

inline

Create warper from Surface.

Parameters

s	standard 8bit OpenXcom surface

Returns

ShaderMove<Uint8> OpenXcom::ShaderSurface ( Surface *  s, int  x, int  y  )

inline

Create warper from Surface and provided offset.

Parameters

s	standard 8bit OpenXcom surface
x	offset on x
y	offset on y

Returns

template<typename type >

std::wstring OpenXcom::toString

(

type

t

)

Helper function that returns a string representation of a type (mainly used for numbers).

Parameters

t	The value to stringify.

Returns

A string representation of the value.