Represents a specific type of UFO. More...

#include <RuleUfo.h>

Public Member Functions
	RuleUfo (const std::string &type)
	Creates a blank UFO ruleset. More...

	~RuleUfo ()
	Cleans up the UFO ruleset.

void	load (const YAML::Node &node, Mod *mod)
	Loads UFO data from YAML. More...

std::string	getType () const
	Gets the UFO's type. More...

std::string	getSize () const
	Gets the UFO's size. More...

int	getRadius () const
	Gets the UFO's radius. More...

int	getSprite () const
	Gets the UFO's sprite. More...

int	getMarker () const
	Gets the UFO's globe marker when flying. More...

int	getLandMarker () const
	Gets the UFO's globe marker when landed. More...

int	getCrashMarker () const
	Gets the UFO's globe marker when crashed. More...

int	getMaxDamage () const
	Gets the UFO's maximum damage. More...

int	getMaxSpeed () const
	Gets the UFO's maximum speed. More...

int	getWeaponPower () const
	Gets the UFO's weapon power. More...

int	getWeaponRange () const
	Gets the UFO's weapon range. More...

int	getScore () const
	Gets the UFO's score. More...

RuleTerrain *	getBattlescapeTerrainData () const
	Sets the battlescape terrain data ruleset for this UFO. More...

int	getWeaponReload () const
	Gets the reload time of the UFO's weapon. More...

int	getBreakOffTime () const
	Gets the UFO's escape time. More...

std::string	getModSprite () const
	Gets the name of the surface that represents this UFO. More...

int	getSightRange () const
	Gets the UFO's radar range. More...

int	getMissionScore () const
	Gets the UFO's mission score. More...

Detailed Description

Represents a specific type of UFO.

Contains constant info about a UFO like speed, weapons, scores, etc.

See also: Ufo

Constructor & Destructor Documentation

◆ RuleUfo()

OpenXcom::RuleUfo::RuleUfo ( const std::string & type )

Creates a blank UFO ruleset.

Creates a blank ruleset for a certain type of UFO.

Parameters

type	String defining the type.

Member Function Documentation

◆ getBattlescapeTerrainData()

RuleTerrain * OpenXcom::RuleUfo::getBattlescapeTerrainData ( ) const

Sets the battlescape terrain data ruleset for this UFO.

Gets the terrain data needed to draw the UFO in the battlescape.

Returns: The RuleTerrain.

◆ getBreakOffTime()

int OpenXcom::RuleUfo::getBreakOffTime ( ) const

Gets the UFO's escape time.

Gets the UFO's break off time.

Returns: The UFO's break off time in game seconds.

◆ getCrashMarker()

int OpenXcom::RuleUfo::getCrashMarker ( ) const

Gets the UFO's globe marker when crashed.

Returns the globe marker for the UFO when crashed.

Returns: Marker sprite, -1 if none.

◆ getLandMarker()

int OpenXcom::RuleUfo::getLandMarker ( ) const

Gets the UFO's globe marker when landed.

Returns the globe marker for the UFO while landed.

Returns: Marker sprite, -1 if none.

◆ getMarker()

int OpenXcom::RuleUfo::getMarker ( ) const

Gets the UFO's globe marker when flying.

Returns the globe marker for the UFO while in flight.

Returns: Marker sprite, -1 if none.

◆ getMaxDamage()

int OpenXcom::RuleUfo::getMaxDamage ( ) const

Gets the UFO's maximum damage.

Gets the maximum damage (damage the UFO can take) of the UFO.

Returns: The maximum damage.

◆ getMaxSpeed()

int OpenXcom::RuleUfo::getMaxSpeed ( ) const

Gets the UFO's maximum speed.

Gets the maximum speed of the UFO flying around the Geoscape.

Returns: The maximum speed.

◆ getMissionScore()

int OpenXcom::RuleUfo::getMissionScore ( ) const

Gets the UFO's mission score.

Gets the amount of points awarded every 30 minutes while the UFO is on a mission (doubled when landed).

Returns: Score.

◆ getModSprite()

std::string OpenXcom::RuleUfo::getModSprite ( ) const

Gets the name of the surface that represents this UFO.

For user-defined UFOs, use a surface for the "preview" image.

Returns: The name of the surface that represents this UFO.

◆ getRadius()

int OpenXcom::RuleUfo::getRadius ( ) const

Gets the UFO's radius.

Gets the radius of this type of UFO on the dogfighting window.

Returns: The radius in pixels.

◆ getScore()

int OpenXcom::RuleUfo::getScore ( ) const

Gets the UFO's score.

Gets the amount of points the player gets for shooting down the UFO.

Returns: The score.

◆ getSightRange()

int OpenXcom::RuleUfo::getSightRange ( ) const

Gets the UFO's radar range.

Gets the UFO's radar range for detecting bases.

Returns: The range in nautical miles.

◆ getSize()

std::string OpenXcom::RuleUfo::getSize ( ) const

Gets the UFO's size.

Gets the size of this type of UFO.

Returns: The Ufo's size.

◆ getSprite()

int OpenXcom::RuleUfo::getSprite ( ) const

Gets the UFO's sprite.

Gets the ID of the sprite used to draw the UFO in the Dogfight window.

Returns: The sprite ID.

◆ getType()

std::string OpenXcom::RuleUfo::getType ( ) const

Gets the UFO's type.

Gets the language string that names this UFO.

Each UFO type has a unique name.

Returns: The Ufo's name.

◆ getWeaponPower()

int OpenXcom::RuleUfo::getWeaponPower ( ) const

Gets the UFO's weapon power.

Gets the maximum damage done by the UFO's weapons per shot.

Returns: The weapon power.

◆ getWeaponRange()

int OpenXcom::RuleUfo::getWeaponRange ( ) const

Gets the UFO's weapon range.

Gets the maximum range for the UFO's weapons.

Returns: The weapon range.

◆ getWeaponReload()

int OpenXcom::RuleUfo::getWeaponReload ( ) const

Gets the reload time of the UFO's weapon.

Gets the weapon reload for UFO ships.

Returns: The UFO weapon reload time.

◆ load()

void OpenXcom::RuleUfo::load	(	const YAML::Node &	node,
		Mod *	mod
	)

Loads UFO data from YAML.

Loads the UFO from a YAML file.