The parent class of Vehicle and Building; The name Container originates from Battle Isle, where everything that could load units was a container. More...

#include <containerbase.h>

Inheritance diagram for ContainerBase:

[legend]

Classes
class	Work

class	WorkClassFactory

Public Types
typedef vector< const VehicleType * >	Production

Public Member Functions
virtual bool	isBuilding () const =0

virtual Surface	getImage () const =0
	returns an image for the Container. More...

const Production &	getProduction () const

Resources	getProductionCost (const VehicleType *unit) const

void	deleteProductionLine (const VehicleType *type)

void	deleteAllProductionLines ()

void	addProductionLine (const VehicleType *type)

bool	hasProductionLine (const VehicleType *type)

void	setProductionLines (const Production &production)

virtual int	getArmor () const =0

int	getOwner () const
	returns the number of the player this vehicle/building belongs to More...

Player &	getOwningPlayer () const
	returns the player this vehicle/building belongs to More...

virtual void	registerForNewOwner (int player)=0
	this is a low level functions that changes the registration in the map. It's called by convert(int,bool) More...

virtual void	write (tnstream &stream, bool includeLoadedUnits=true) const =0

virtual void	read (tnstream &stream)=0

virtual void	addview (void)=0
	registers the containers view (=radar) on the map More...

virtual void	removeview (void)=0
	removes the containers view (=radar) on the map More...

GameMap *	getMap () const

virtual int	getIdentification () const =0

virtual int	getHeight () const =0
	returns the bitmapped level of height. Only one bit will be set, of course More...

virtual ASCString	getName () const =0

ASCString	getPrivateName () const

virtual void	setName (const ASCString &name)

virtual int	getAmmo (int type, int num, bool queryOnly)=0

virtual int	getAmmo (int type, int num) const =0

virtual int	putAmmo (int type, int num, bool queryOnly)=0

virtual int	maxAmmo (int type) const =0

virtual void	endOwnTurn (void)
	hook that is called when a player ends his turn More...

virtual void	endAnyTurn (void)
	hook that is called when any player (including owner) ends turn More...

virtual void	endRound (void)
	hook that is called the next round begins ( active player switching from player8 to player1 ) More...

Work *	spawnWorkClasses (bool justQuery)

virtual MapCoordinate3D	getPosition () const =0

virtual	~ContainerBase ()

virtual vector< MapCoordinate >	getCoveredFields ()=0

Repairing related functions
virtual const ResourceMatrix &	getRepairEfficiency () const =0
	when a ContainerBase is repair by this ContainerBase, the default cost can be customized with this matrix. More...

virtual void	postRepair (int oldDamage, bool autoRepair)=0
	is called after a repair is performed. Vehicles use this to reduce their experience. More...

virtual bool	canRepair (const ContainerBase *item) const =0
	checks whether the item can be repaired provided that it is in range More...

int	getMaxRepair (const ContainerBase *item) const
	returns the maximum amount of damage that the given item can be repaired More...

int	getMaxRepair (const ContainerBase *item, int newDamage, Resources &cost, bool ignoreCost=false) const

int	repairItem (ContainerBase *item, int newDamage=0, bool autoRepair=false)

virtual int	repairableDamage () const =0
	returns the amount of damage that can still be repaired this turn More...

Static Public Member Functions
static int	calcShadowDist (int binaryHeight)

static bool	registerWorkClassFactory (WorkClassFactory *wcf, bool ASCmode=true)

Public Attributes
const ContainerBaseType *	baseType
	the type descriping all non-instance specific properties of the container More...

int	damage
	Damage. 0 is no damage, when damage reaches 100 the container is destroyed. More...

int	color
	The owner of the container. More...

sigc::signal< void >	conquered

sigc::signal< void >	destroyed

int	researchpoints
	the current amount of research that the building conducts every turn More...

int	maxresearchpoints

int	view

Static Public Attributes
static sigc::signal< void, ContainerBase * >	anyContainerDestroyed

static sigc::signal< void, ContainerBase * >	anyContainerConquered

Protected Member Functions
void	paintField (const Surface &src, Surface &dest, SPoint pos, int dir, bool shaded, int shadowDist=-1) const
	displays an image of this container on the surface. More...

	ContainerBase (const ContainerBaseType bt, GameMap map, int player)

Protected Attributes
int	repairedThisTurn
	the percantage that this container has already been repaired this turn. More...

GameMap *	gamemap
	the map that this container is placed on More...

ContainerBase *	cargoParent
	if this container is transported inside a carrier, this is carrier More...

Production	internalUnitProduction

Friends
class	ConvertContainer

class	ChangeContainerProperty

Cargo related functions
typedef vector< Vehicle * >	Cargo

Cargo	cargo

sigc::signal< void >	cargoChanged

ASCString	name
	a name given by the user or the map creator More...

ASCString	privateName
	a name given by the user which is only visible to him and his allies. More...

const Cargo &	getCargo () const

int	getCargoCount () const

Vehicle *	getCargo (int i)
	returns the cargo slot with index i Warning: the cargo may contain NULL items. More...

void	clearCargo ()
	removes ALL units from cargo More...

void	addToCargo (Vehicle *veh, int position=-1)
	adds the unit to the cargo More...

void	moveToCargo (Vehicle *veh)
	adds the unit to the cargo, and removes its from its current position More...

bool	removeUnitFromCargo (Vehicle *veh, bool recursive=false)
	removes the given unit from the container. More...

bool	removeUnitFromCargo (int nwid, bool recursive=false)

int	vehiclesLoaded (void) const
	returns the number of loaded units More...

ContainerBase *	getCarrier () const
	if this is a unit and it is inside a building or transport, returns the transport. NULL otherwise. More...

Vehicle *	findUnit (int nwid, bool recursive=true) const
	searches for a the unit in carrier and optionally all inner carriers More...

bool	vehicleLoadable (const Vehicle vehicle, int uheight=-1, const bool attacked=NULL) const
	can the vehicle be loaded. More...

int	vehicleUnloadable (const VehicleType *vehicleType, int carrierHeight=-1) const
	checks the unloading of a unit type More...

const ContainerBaseType::TransportationIO *	vehicleUnloadSystem (const VehicleType *vehicle, int height)
	returns the unloading system More...

int	vehicleDocking (const Vehicle *vehicle, bool out) const
	returns the levels of height on which this unit can be transfered by docking; or 0 if no unloading is possible More...

bool	doesVehicleFit (const Vehicle *vehicle) const
	Does the vehicle fit into the container? This does not include checking if it can reach the entry. More...

int	cargoWeight () const
	weight of all loaded units More...

int	cargoNestingDepth ()
	returns the nesting depth of the cargo. The unit standing on the field is 0, its cargo is 1, the cargo's cargo 2 ... More...

Resource related functions
Resources	plus
	the Resources that are produced each turn More...

Resources	maxplus
	the maximum amount of Resources that the building can produce each turn in the ASC resource mode ; see also bi_resourceplus More...

Resources	bi_resourceplus
	the maximum amount of Resources that the building can produce each turn in the BI resource mode ; see also maxplus More...

virtual int	putResource (int amount, int resourcetype, bool queryonly, int scope=1, int player=-1)=0
	scope: 0 = local 1 = resource network 2 = global in all buildings 3 = map wide pool( used only internally! ) More...

virtual int	getResource (int amount, int resourcetype, bool queryonly, int scope=1, int player=-1)=0

virtual int	getAvailableResource (int amount, int resourcetype, int scope=1) const =0

Resources	putResource (const Resources &res, bool queryonly, int scope=1, int player=-1)

Resources	getResource (const Resources &res, bool queryonly, int scope=1, int player=-1)

Resources	getResource (const Resources &res) const

Resources	getResourceUsage ()
	returns the resource that the building consumes for its operation. More...

Resources	getResourcePlus ()

Resources	getStorageCapacity () const
	returns the local storage capacity for the given resource, which depends on the resource mode of the map. More...

Resources	netResourcePlus () const
	returns the amount of resources that the net which the building is connected to produces each turn More...

void	setInternalResourcePlus (const Resources &res)
	The ResourcePlus is used for different purposes by different building or vehicle functions, or not at all. More...

void	setInternalResourceMaxPlus (const Resources &res)
	The ResourceMaxPlus is used for different purposes by different building or vehicle functions, or not at all. More...

Resources	getInternalResourcePlus () const
	The ResourcePlus is used for different purposes by different building or vehicle functions, or not at all. More...

Resources	getInternalResourceMaxPlus () const
	The ResourceMaxPlus is used for different purposes by different building or vehicle functions, or not at all. More...

Detailed Description

The parent class of Vehicle and Building; The name Container originates from Battle Isle, where everything that could load units was a container.

Definition at line 40 of file containerbase.h.

Member Typedef Documentation

typedef vector<Vehicle*> ContainerBase::Cargo

Definition at line 106 of file containerbase.h.

typedef vector<const VehicleType*> ContainerBase::Production

Definition at line 87 of file containerbase.h.

Constructor & Destructor Documentation

ContainerBase::ContainerBase	(	const ContainerBaseType *	bt,
		GameMap *	map,
		int	player
	)

protected

ContainerBase::~ContainerBase ( )

virtual

Definition at line 610 of file containerbase.cpp.

References anyContainerDestroyed, cargo, destroyed, GameMap::Destruction, gamemap, and GameMap::state.

Member Function Documentation

void ContainerBase::addProductionLine ( const VehicleType * type )

Definition at line 581 of file containerbase.cpp.

References internalUnitProduction.

Referenced by copyBuildingData(), copyVehicleData(), AddProductionCapability::execute(), BuildProductionLineCommand::go(), and RemoveProductionLineCommand::undoAction().

void ContainerBase::addToCargo	(	Vehicle *	veh,
		int	position = `-1`
	)

adds the unit to the cargo

Parameters

veh	the unit to add
position	specifies a specific cargo slot. -1 assigns slot automatically. The automatic mode should be used in almost all cases

Definition at line 363 of file containerbase.cpp.

References cargo, cargoChanged, cargoParent, fatalError(), getPosition(), and Vehicle::setnewposition().

Referenced by copyBuildingData(), copyVehicleData(), trunreplay::execnextreplaymove(), CargoItemFactory::itemSelected(), moveToCargo(), UnitFieldRegistration::runAction(), UnitFieldRegistration::undoAction(), and DestructContainer::undoAction().

virtual void ContainerBase::addview ( void )

pure virtual

registers the containers view (=radar) on the map

Implemented in Vehicle, and Building.

Referenced by ViewRegistration::runAction(), and ViewRegistration::undoAction().

int ContainerBase::calcShadowDist ( int binaryHeight )

static

Definition at line 268 of file containerbase.cpp.

References chfahrend, and getFirstBit().

Referenced by MapDisplayPG::displayAddons(), MapDisplayPG::displayUnitMovement(), and paintField().

virtual bool ContainerBase::canRepair ( const ContainerBase * item ) const

pure virtual

checks whether the item can be repaired provided that it is in range

Implemented in Vehicle, and Building.

Referenced by getMaxRepair(), and repairItem().

int ContainerBase::cargoNestingDepth ( )

returns the nesting depth of the cargo. The unit standing on the field is 0, its cargo is 1, the cargo's cargo 2 ...

Definition at line 188 of file containerbase.cpp.

References cargoNestingDepth(), and getCarrier().

Referenced by cargoNestingDepth(), and Vehicle::setMovement().

int ContainerBase::cargoWeight ( ) const

weight of all loaded units

Definition at line 177 of file containerbase.cpp.

References cargo.

Referenced by StoringPosition::eventDraw(), executeUserAction(), CargoDialog::setUnitInfoWidgets(), CargoDialog::updateVariables(), and Vehicle::weight().

void ContainerBase::clearCargo ( )

removes ALL units from cargo

Definition at line 351 of file containerbase.cpp.

References cargo, and cargoChanged.

Referenced by TemporaryContainerStorage::restore().

void ContainerBase::deleteAllProductionLines ( )

Definition at line 575 of file containerbase.cpp.

References internalUnitProduction.

Referenced by copyBuildingData(), and copyVehicleData().

void ContainerBase::deleteProductionLine ( const VehicleType * type )

Definition at line 569 of file containerbase.cpp.

References internalUnitProduction.

Referenced by RemoveProductionLineCommand::go(), and BuildProductionLineCommand::undoAction().

bool ContainerBase::doesVehicleFit ( const Vehicle * vehicle ) const

Does the vehicle fit into the container? This does not include checking if it can reach the entry.

Definition at line 446 of file containerbase.cpp.

References baseType, color, Player::diplomacy, findUnit(), getMap(), GameMap::getPlayer(), isBuilding(), DiplomaticStateVector::isHostile(), ContainerBaseType::maxLoadableUnits, Vehicle::networkid, Vehicle::typ, ContainerBaseType::vehicleFit(), vehiclesLoaded(), and Vehicle::weight().

Referenced by CargoItemFactory::isFiltered(), CargoItemFactory::itemSelected(), CargoMoveCommand::moveInAvail(), CargoMoveCommand::moveOutAvail(), vehicleDocking(), and vehicleLoadable().

void ContainerBase::endAnyTurn ( void )

virtual

hook that is called when any player (including owner) ends turn

Reimplemented in Vehicle.

Definition at line 655 of file containerbase.cpp.

Referenced by Vehicle::endAnyTurn().

void ContainerBase::endOwnTurn ( void )

virtual

hook that is called when a player ends his turn

Reimplemented in Vehicle.

Definition at line 651 of file containerbase.cpp.

Referenced by Vehicle::endOwnTurn().

void ContainerBase::endRound ( void )

virtual

hook that is called the next round begins ( active player switching from player8 to player1 )

Reimplemented in Vehicle, and Building.

Definition at line 659 of file containerbase.cpp.

References baseType, ContainerBaseType::view, and view.

Referenced by Building::endRound(), and Vehicle::endRound().

Vehicle * ContainerBase::findUnit	(	int	nwid,
		bool	recursive = `true`
	)		const

searches for a the unit in carrier and optionally all inner carriers

Definition at line 224 of file containerbase.cpp.

References cargo, and findUnit().

Referenced by RecycleUnitCommand::avail(), TrainUnitCommand::avail(), doesVehicleFit(), findUnit(), and GameMap::getUnit().

virtual int ContainerBase::getAmmo	(	int	type,
		int	num,
		bool	queryOnly
	)

pure virtual

Implemented in Vehicle, and Building.

Referenced by ammoCounter(), AmmoTransferrable::AmmoTransferrable(), ConsumeAmmo::runAction(), CargoDialog::showAmmo(), and ConsumeAmmo::undoAction().

virtual int ContainerBase::getAmmo	(	int	type,
		int	num
	)		const

pure virtual

Implemented in Vehicle, and Building.

virtual int ContainerBase::getArmor ( ) const

pure virtual

Implemented in Vehicle, and Building.

Referenced by CargoDialog::updateVariables().

virtual int ContainerBase::getAvailableResource	(	int	amount,
		int	resourcetype,
		int	scope = `1`
	)		const

pure virtual

Implemented in Vehicle, and Building.

Referenced by ammoCounter(), getResource(), StatisticsCalculator::resource(), and ContainerConstControls::unitProductionPrerequisites().

const Cargo& ContainerBase::getCargo ( ) const

inline

Definition at line 115 of file containerbase.h.

References cargo.

Referenced by ammoCounter(), autoTrainer(), CalculateThreat_Vehicle::calc_threat_vehicle(), VehicleCounterFactory::calcCargoSummary(), Vehicle::canMove(), copyBuildingData(), copyVehicleData(), countPlayersBinary(), StoringPosition::eventDraw(), AnyUnitEntersPolygon::fieldOperator(), Vehicle::freeWeight(), getFirstCargo(), CargoWidget::getMarkedUnit(), RecycleUnitCommand::getOutput(), CargoMoveCommand::getTargetCarriers(), getUnitResourceCargo(), StatisticsCalculator::resource(), UnitTypeTransformation::run(), UnitFieldRegistration::runAction(), DestructContainer::runAction(), CargoDialog::setUnitInfoWidgets(), StoringPosition::setup(), ServiceTargetSearcher::startSearch(), StatisticsCalculator::strength(), testCargoMovement(), testCargoMovementMax(), SearchReconquerBuilding::testfield(), testManualRepair(), StatisticsCalculator::unitCost(), StatisticsCalculator::unitCount(), and CargoDialog::userHandler().

Vehicle * ContainerBase::getCargo ( int i )

returns the cargo slot with index i Warning: the cargo may contain NULL items.

This was done deliberately, to allow easier navigation when the user moves items successivly out of a carrier

Definition at line 208 of file containerbase.cpp.

References cargo.

int ContainerBase::getCargoCount ( ) const

inline

Definition at line 117 of file containerbase.h.

References cargo.

ContainerBase * ContainerBase::getCarrier ( ) const

if this is a unit and it is inside a building or transport, returns the transport. NULL otherwise.

Definition at line 218 of file containerbase.cpp.

References cargoParent.

Referenced by TrainUnitCommand::avail(), TransferControlCommand::avail(), ServiceCommand::avail(), Vehicle::beginTurn(), cargoNestingDepth(), UnitHooveringLogic::getEndurance(), getMaxRepair(), CargoMoveCommand::getTargetCarriers(), CargoMoveCommand::go(), CargoMoveCommand::moveOutAvail(), DestructContainer::runAction(), Vehicle::unregisterPosition(), and Vehicle::~Vehicle().

virtual vector<MapCoordinate> ContainerBase::getCoveredFields ( )

pure virtual

Implemented in Vehicle, and Building.

Referenced by SolarPowerplant::getPlus().

virtual int ContainerBase::getHeight ( ) const

pure virtual

returns the bitmapped level of height. Only one bit will be set, of course

Implemented in Vehicle, and Building.

Referenced by ServiceChecker::check(), getheightdelta(), and paintField().

virtual int ContainerBase::getIdentification ( ) const

pure virtual

Implemented in Vehicle, and Building.

Referenced by ContainerAction::ContainerAction(), ContainerCommand::ContainerCommand(), DestructContainer::runAction(), ServiceCommand::setDestination(), and UnitFieldRegistration::UnitFieldRegistration().

virtual Surface ContainerBase::getImage ( ) const

pure virtual

returns an image for the Container.

Note: Buildings have a size of several fields. The image returned here is therefore not suited to be painted on the map, as map-painting is done on a per-field basis

Implemented in Vehicle, and Building.

Referenced by AmmoTransferWindow::AmmoTransferWindow().

Resources ContainerBase::getInternalResourceMaxPlus ( ) const

The ResourceMaxPlus is used for different purposes by different building or vehicle functions, or not at all.

Definition at line 700 of file containerbase.cpp.

References maxplus.

Resources ContainerBase::getInternalResourcePlus ( ) const

The ResourcePlus is used for different purposes by different building or vehicle functions, or not at all.

Definition at line 695 of file containerbase.cpp.

References plus.

GameMap* ContainerBase::getMap ( void ) const

inline

Definition at line 302 of file containerbase.h.

References gamemap.

int ContainerBase::getMaxRepair ( const ContainerBase * item ) const

returns the maximum amount of damage that the given item can be repaired

Returns: a value in the range 0 .. item->damage

Definition at line 118 of file containerbase.cpp.

Referenced by RepairBuildingCommand::getCost(), CargoGuiFunctions::RepairUnit::getName(), GuiFunctions::RepairUnit::getName(), RepairUnitCommand::go(), and repairItem().

int ContainerBase::getMaxRepair	(	const ContainerBase *	item,
		int	newDamage,
		Resources &	cost,
		bool	ignoreCost = `false`
	)		const

Definition at line 124 of file containerbase.cpp.

References baseType, canRepair(), damage, getCarrier(), getRepairEfficiency(), getResource(), ContainerBaseType::minFieldRepairDamage, ContainerBaseType::productionCost, repairableDamage(), Resources::resource(), and resourceTypeNum.

virtual ASCString ContainerBase::getName ( ) const

pure virtual

int ContainerBase::getOwner ( ) const

inline

returns the number of the player this vehicle/building belongs to

Definition at line 206 of file containerbase.h.

References color.

Player & ContainerBase::getOwningPlayer ( ) const

returns the player this vehicle/building belongs to

Definition at line 678 of file containerbase.cpp.

References getMap(), and GameMap::getPlayer().

Referenced by GuiFunctions::ConstructBuilding::execute(), Building::getImage(), DashboardPanel::painter(), and GetTargetImage::visit().

virtual MapCoordinate3D ContainerBase::getPosition ( ) const

pure virtual

ASCString ContainerBase::getPrivateName ( ) const

Definition at line 58 of file containerbase.cpp.

References getName(), and privateName.

const ContainerBase::Production & ContainerBase::getProduction ( ) const

Definition at line 549 of file containerbase.cpp.

References baseType, ContainerBaseType::hasFunction(), ContainerBaseType::height, internalUnitProduction, ContainerBaseType::ProduceNonLeavableUnits, and vehicleUnloadable().

Referenced by compareMapResources(), copyBuildingData(), copyVehicleData(), ConstructUnitCommand::getProduceableVehicles(), RemoveProductionLineCommand::go(), ProductionEditorWindow::ProductionEditorWindow(), BuildProductionLineCommand::productionLinesBuyable(), and UnitTypeTransformation::run().

Resources ContainerBase::getProductionCost ( const VehicleType * unit ) const

Definition at line 563 of file containerbase.cpp.

References baseType, ContainerBaseType::productionCost, and ContainerBaseType::productionEfficiency.

Referenced by trunreplay::execnextreplaymove(), ContainerConstControls::unitProductionPrerequisites(), and ConstructUnitCommand::unitProductionPrerequisites().

virtual const ResourceMatrix& ContainerBase::getRepairEfficiency ( ) const

pure virtual

when a ContainerBase is repair by this ContainerBase, the default cost can be customized with this matrix.

Note: This effects both reparing another ContainerBase as well as self-repsir

Implemented in Vehicle, and Building.

Referenced by getMaxRepair().

virtual int ContainerBase::getResource	(	int	amount,
		int	resourcetype,
		bool	queryonly,
		int	scope = `1`,
		int	player = `-1`
	)

pure virtual

Resources ContainerBase::getResource	(	const Resources &	res,
		bool	queryonly,
		int	scope = `1`,
		int	player = `-1`
	)

Definition at line 80 of file containerbase.cpp.

References getResource(), Resources::resource(), and resourceNum.

Resources ContainerBase::getResource ( const Resources & res ) const

Definition at line 88 of file containerbase.cpp.

References getAvailableResource(), Resources::resource(), and resourceNum.

Resources ContainerBase::getResourcePlus ( )

Definition at line 706 of file containerbase.cpp.

References ContainerBase::Work::getPlus(), and spawnWorkClasses().

Referenced by GetResourcePlus::checkbuilding().

Resources ContainerBase::getResourceUsage ( )

returns the resource that the building consumes for its operation.

Definition at line 719 of file containerbase.cpp.

References baseType, ContainerBase::Work::getUsage(), ContainerBaseType::hasFunction(), ContainerBaseType::Research, researchpoints, returnResourcenUseForResearch(), and spawnWorkClasses().

Referenced by GetResourceUsage::checkbuilding().

Resources ContainerBase::getStorageCapacity ( ) const

returns the local storage capacity for the given resource, which depends on the resource mode of the map.

See Also: GameMap::_resourcemode

Definition at line 734 of file containerbase.cpp.

References GameMap::_resourcemode, baseType, gamemap, ContainerBaseType::getStorageCapacity(), and isBuilding().

Referenced by ServiceChecker::check(), PutResource::checkbuilding(), PutTribute::checkbuilding(), GetResourceCapacity::checkbuilding(), Vehicle::endRound(), Building::execnetcontrol(), Vehicle::fillMagically(), BuildingValues::init(), CargoItemFactory::itemSelected(), UnitInfoLayer::paintSingleField(), Vehicle::putResource(), DashboardPanel::showUnitData(), Vehicle::transform(), and VehiclePropertyEditor::VehiclePropertyEditor().

bool ContainerBase::hasProductionLine ( const VehicleType * type )

Definition at line 588 of file containerbase.cpp.

References internalUnitProduction.

virtual bool ContainerBase::isBuilding ( ) const

pure virtual

Implemented in Building, and Vehicle.

Referenced by RecycleUnitCommand::avail(), ServiceChecker::check(), DestructContainer::DestructContainer(), doesVehicleFit(), getStorageCapacity(), and vehicleLoadable().

virtual int ContainerBase::maxAmmo ( int type ) const

pure virtual

Implemented in Vehicle, and Building.

Referenced by ServiceChecker::check(), AmmoTransferrable::getMax(), and AmmoTransferrable::getMin().

void ContainerBase::moveToCargo ( Vehicle * veh )

adds the unit to the cargo, and removes its from its current position

Definition at line 384 of file containerbase.cpp.

References addToCargo(), and Vehicle::unregisterPosition().

Resources ContainerBase::netResourcePlus ( ) const

returns the amount of resources that the net which the building is connected to produces each turn

Definition at line 666 of file containerbase.cpp.

References color, getMap(), getPosition(), ResourceChangeNet::getresource(), Resources::resource(), and resourceTypeNum.

void ContainerBase::paintField	(	const Surface &	src,
		Surface &	dest,
		SPoint	pos,
		int	dir,
		bool	shaded,
		int	shadowDist = `-1`
	)		const

protected

displays an image of this container on the surface.

The different shaders (like semi-transparency for submerged stuff) is processed here

Parameters

src	The source surface, which is an image of the ContainerBase
dest	The destination surface, onto which the src image is painted
pos	The position within dest at which src is painted
dir	Rotation of the image. Valid range is 0..5, resuling in 0�, 60� 120�, etc
shaded	If true then the image will not be displayed in color, but in greyscale
shadowDist	The offset of the shadow of the unit in pixels. Shadowdist will be added to the x and y coordinates if the position, resulting in the shadow being in the lower right of the image 0 = no shadow will be drawn If -1, the shadowDist will be calculated depending on the container's current height

blitter.setPlayer( getOwner() );

Definition at line 280 of file containerbase.cpp.

References MegaBlitter< BytesPerSourcePixel, BytesPerTargetPixel, SourceColorTransform, ColorMerger, SourcePixelSelector, TargetPixelSelector, MyColorConverter >::blit(), calcShadowDist(), chfahrend, chgetaucht, directionangle, gamemap, getFirstBit(), getHeight(), getOwner(), megaBlitter(), nullParam, and GameMap::player.

Referenced by Vehicle::paint(), and Building::paintSingleField().

virtual void ContainerBase::postRepair	(	int	oldDamage,
		bool	autoRepair
	)

pure virtual

is called after a repair is performed. Vehicles use this to reduce their experience.

Implemented in Vehicle, and Building.

Referenced by repairItem().

virtual int ContainerBase::putAmmo	(	int	type,
		int	num,
		bool	queryOnly
	)

pure virtual

Implemented in Vehicle, and Building.

Referenced by ConsumeAmmo::runAction(), and ConsumeAmmo::undoAction().

virtual int ContainerBase::putResource	(	int	amount,
		int	resourcetype,
		bool	queryonly,
		int	scope = `1`,
		int	player = `-1`
	)

pure virtual

scope: 0 = local 1 = resource network 2 = global in all buildings 3 = map wide pool( used only internally! )

Implemented in Vehicle, and Building.

Referenced by RecycleUnitCommand::go(), Building::putResource(), Vehicle::putResource(), putResource(), putResources(), ResourceWatch::ResourceWatch(), MatterConverter::run(), RegenerativePowerPlant::run(), MiningStation::run(), and ConsumeResource::undoAction().

Resources ContainerBase::putResource	(	const Resources &	res,
		bool	queryonly,
		int	scope = `1`,
		int	player = `-1`
	)

Definition at line 71 of file containerbase.cpp.

References putResource(), Resources::resource(), and resourceNum.

virtual void ContainerBase::read ( tnstream & stream )

pure virtual

Implemented in Vehicle, and Building.

Referenced by TemporaryContainerStorage::restore().

virtual void ContainerBase::registerForNewOwner ( int player )

pure virtual

this is a low level functions that changes the registration in the map. It's called by convert(int,bool)

Implemented in Vehicle, and Building.

Referenced by ConvertContainer::runAction(), and ConvertContainer::undoAction().

bool ContainerBase::registerWorkClassFactory	(	WorkClassFactory *	wcf,
		bool	ASCmode = `true`
	)

static

Definition at line 745 of file containerbase.cpp.

bool ContainerBase::removeUnitFromCargo	(	Vehicle *	veh,
		bool	recursive = `false`
	)

removes the given unit from the container.

Returns: true if the unit was found, false otherwise

Definition at line 391 of file containerbase.cpp.

References cargoChanged, and Vehicle::networkid.

Referenced by trunreplay::execnextreplaymove(), UnitFieldRegistration::runAction(), UnitFieldRegistration::undoAction(), Vehicle::unregisterPosition(), and Vehicle::~Vehicle().

bool ContainerBase::removeUnitFromCargo	(	int	nwid,
		bool	recursive = `false`
	)

Definition at line 404 of file containerbase.cpp.

References baseType, cargo, cargoChanged, and ContainerBaseType::maxLoadableUnits.

virtual void ContainerBase::removeview ( void )

pure virtual

removes the containers view (=radar) on the map

Implemented in Vehicle, and Building.

Referenced by ViewRegistration::runAction(), and ViewRegistration::undoAction().

virtual int ContainerBase::repairableDamage ( ) const

pure virtual

returns the amount of damage that can still be repaired this turn

Implemented in Building, and Vehicle.

Referenced by DamageBarWidget::eventBlit(), getMaxRepair(), and repairItem().

int ContainerBase::repairItem	(	ContainerBase *	item,
		int	newDamage = `0`,
		bool	autoRepair = `false`
	)

Definition at line 97 of file containerbase.cpp.

References canRepair(), damage, getMaxRepair(), getResource(), postRepair(), and repairableDamage().

Referenced by Vehicle::endOwnTurn(), and trunreplay::execnextreplaymove().

void ContainerBase::setInternalResourceMaxPlus ( const Resources & res )

The ResourceMaxPlus is used for different purposes by different building or vehicle functions, or not at all.

Definition at line 689 of file containerbase.cpp.

References baseType, Resources::count, ContainerBaseType::maxplus, maxplus, min(), and Resources::resource().

void ContainerBase::setInternalResourcePlus ( const Resources & res )

The ResourcePlus is used for different purposes by different building or vehicle functions, or not at all.

Definition at line 683 of file containerbase.cpp.

References baseType, Resources::count, ContainerBaseType::maxplus, maxplus, min(), plus, and Resources::resource().

void ContainerBase::setName ( const ASCString & name )

virtual

Definition at line 601 of file containerbase.cpp.

References checkModificationConstraints(), and name.

Referenced by setLocalizedContainerName().

void ContainerBase::setProductionLines ( const Production & production )

Definition at line 594 of file containerbase.cpp.

References internalUnitProduction.

Referenced by UnitTypeTransformation::run().

ContainerBase::Work * ContainerBase::spawnWorkClasses ( bool justQuery )

Definition at line 765 of file containerbase.cpp.

References getMap().

Referenced by getResourcePlus(), and getResourceUsage().

int ContainerBase::vehicleDocking	(	const Vehicle *	vehicle,
		bool	out
	)		const

returns the levels of height on which this unit can be transfered by docking; or 0 if no unloading is possible

Definition at line 526 of file containerbase.cpp.

References baseType, ContainerBaseType::TransportationIO::Docking, doesVehicleFit(), ContainerBaseType::entranceSystems, MapCoordinate3D::getNumericalHeight(), getPosition(), VehicleType::movemalustyp, Vehicle::typ, and ContainerBaseType::vehicleFit().

Referenced by Vehicle::canMove(), and AStar3D::findPath().

bool ContainerBase::vehicleLoadable	(	const Vehicle *	vehicle,
		int	uheight = `-1`,
		const bool *	attacked = `NULL`
	)		const

can the vehicle be loaded.

If uheight is passed, it is assumed that vehicle is at the height 'uheight' and not the actual level of height

Definition at line 458 of file containerbase.cpp.

References Vehicle::attacked, baseType, ContainerBaseType::ConquerBuildings, damage, Player::diplomacy, doesVehicleFit(), ContainerBaseType::entranceSystems, gamemap, MapCoordinate3D::getBitmappedHeight(), getFirstBit(), getheightdelta(), getMap(), MapCoordinate3D::getNumericalHeight(), getOwner(), GameMap::getPlayer(), getPosition(), ContainerBaseType::hasAnyFunction(), ContainerBaseType::hasFunction(), Vehicle::height, ContainerBaseType::TransportationIO::In, DiplomaticStateVector::isAllied(), isBuilding(), DiplomaticStateVector::isHostile(), minimumBuildingDamageForConquering, VehicleType::movemalustyp, and Vehicle::typ.

Referenced by fieldAccessible().

int ContainerBase::vehiclesLoaded ( void ) const

returns the number of loaded units

Definition at line 165 of file containerbase.cpp.

References cargo.

Referenced by doesVehicleFit(), ConstructUnitCommand::internalConstructionAvail(), ContainerConstControls::unitProductionAvailable(), and CargoDialog::updateVariables().

int ContainerBase::vehicleUnloadable	(	const VehicleType *	vehicleType,
		int	carrierHeight = `-1`
	)		const

checks the unloading of a unit type

Parameters

vehicleType	the vehicletype for which the unloading is checked
carrierHeight	assume the carrier ( = this) was on this height (numerical: 0 - 7). If -1, use current height