CrateCollide Class Reference

#include <CrateCollide.h>

Inherits CollideModule.

Inherited by ConvertToCarBombCrateCollide, ConvertToHijackedVehicleCrateCollide, HealCrateCollide, MoneyCrateCollide, SabotageCommandCenterCrateCollide, SabotageFakeBuildingCrateCollide, SabotageInternetCenterCrateCollide, SabotageMilitaryFactoryCrateCollide, SabotagePowerPlantCrateCollide, SabotageSuperweaponCrateCollide, SabotageSupplyCenterCrateCollide, SabotageSupplyDropzoneCrateCollide, SalvageCrateCollide, ShroudCrateCollide, UnitCrateCollide, and VeterancyCrateCollide.

Public Types
enum	SabotageVictimType {   SAB_VICTIM_GENERIC = 0 , SAB_VICTIM_COMMAND_CENTER , SAB_VICTIM_FAKE_BUILDING , SAB_VICTIM_INTERNET_CENTER ,   SAB_VICTIM_MILITARY_FACTORY , SAB_VICTIM_POWER_PLANT , SAB_VICTIM_SUPERWEAPON , SAB_VICTIM_SUPPLY_CENTER ,   SAB_VICTIM_DROP_ZONE }

Public Member Functions
	CrateCollide (Thing *thing, const ModuleData *moduleData)
virtual void	onCollide (Object *other, const Coord3D *loc, const Coord3D *normal)
	This collide method gets called when collision occur.
virtual Bool	wouldLikeToCollideWith (const Object *other) const
	this is used for things like pilots, to determine if they can "enter" something
virtual Bool	isRailroad () const
virtual Bool	isCarBombCrateCollide () const
virtual Bool	isHijackedVehicleCrateCollide () const
virtual Bool	isSabotageBuildingCrateCollide () const
void	doSabotageFeedbackFX (const Object *other, SabotageVictimType type=SAB_VICTIM_GENERIC)
Public Member Functions inherited from CollideModule
	CollideModule (Thing *thing, const ModuleData *moduleData)
virtual CollideModuleInterface *	getCollide ()
virtual Bool	isSalvageCrateCollide () const
Public Member Functions inherited from BehaviorModule
	BehaviorModule (Thing *thing, const ModuleData *moduleData)
virtual BodyModuleInterface *	getBody ()
virtual ContainModuleInterface *	getContain ()
virtual CreateModuleInterface *	getCreate ()
virtual DamageModuleInterface *	getDamage ()
virtual DestroyModuleInterface *	getDestroy ()
virtual DieModuleInterface *	getDie ()
virtual SpecialPowerModuleInterface *	getSpecialPower ()
virtual UpdateModuleInterface *	getUpdate ()
virtual UpgradeModuleInterface *	getUpgrade ()
virtual StealthUpdate *	getStealth ()
virtual SpyVisionUpdate *	getSpyVisionUpdate ()
virtual ParkingPlaceBehaviorInterface *	getParkingPlaceBehaviorInterface ()
virtual RebuildHoleBehaviorInterface *	getRebuildHoleBehaviorInterface ()
virtual BridgeBehaviorInterface *	getBridgeBehaviorInterface ()
virtual BridgeTowerBehaviorInterface *	getBridgeTowerBehaviorInterface ()
virtual BridgeScaffoldBehaviorInterface *	getBridgeScaffoldBehaviorInterface ()
virtual OverchargeBehaviorInterface *	getOverchargeBehaviorInterface ()
virtual TransportPassengerInterface *	getTransportPassengerInterface ()
virtual CaveInterface *	getCaveInterface ()
virtual LandMineInterface *	getLandMineInterface ()
virtual DieModuleInterface *	getEjectPilotDieInterface ()
virtual ProjectileUpdateInterface *	getProjectileUpdateInterface ()
virtual AIUpdateInterface *	getAIUpdateInterface ()
virtual ExitInterface *	getUpdateExitInterface ()
virtual DockUpdateInterface *	getDockUpdateInterface ()
virtual RailedTransportDockUpdateInterface *	getRailedTransportDockUpdateInterface (void)
virtual SlowDeathBehaviorInterface *	getSlowDeathBehaviorInterface ()
virtual SpecialPowerUpdateInterface *	getSpecialPowerUpdateInterface ()
virtual SlavedUpdateInterface *	getSlavedUpdateInterface ()
virtual ProductionUpdateInterface *	getProductionUpdateInterface ()
virtual HordeUpdateInterface *	getHordeUpdateInterface ()
virtual PowerPlantUpdateInterface *	getPowerPlantUpdateInterface ()
virtual SpawnBehaviorInterface *	getSpawnBehaviorInterface ()
virtual CountermeasuresBehaviorInterface *	getCountermeasuresBehaviorInterface ()
virtual const CountermeasuresBehaviorInterface *	getCountermeasuresBehaviorInterface () const
Public Member Functions inherited from ObjectModule
	ObjectModule (Thing *thing, const ModuleData *moduleData)
	< this abstract class needs memory pool hooks
virtual void	onCapture (Player *oldOwner, Player *newOwner)
virtual void	onDisabledEdge (Bool nowDisabled)
Public Member Functions inherited from Module
	Module (const ModuleData *moduleData)
	< this abstract class needs memory pool hooks
virtual NameKeyType	getModuleNameKey () const =0
NameKeyType	getModuleTagNameKey () const
virtual void	onObjectCreated ()
virtual void	onDrawableBoundToObject ()
virtual void	preloadAssets (TimeOfDay timeOfDay)
	preload any assets we might have for this time of day
virtual void	onDelete (void)
Public Member Functions inherited from MemoryPoolObject
void	deleteInstance ()
Public Member Functions inherited from Snapshot
	Snapshot (void)
	~Snapshot (void)

Protected Member Functions
virtual Bool	executeCrateBehavior (Object *other)=0
	This is the game logic execution function that all real CrateCollides will implement.
virtual Bool	isValidToExecute (const Object *other) const
	This allows specific vetoes to certain types of crates and their data.
Protected Member Functions inherited from BehaviorModule
virtual void	crc (Xfer *xfer)
virtual void	xfer (Xfer *xfer)
virtual void	loadPostProcess (void)
Protected Member Functions inherited from ObjectModule
Object *	getObject ()
const Object *	getObject () const
Protected Member Functions inherited from Module
const ModuleData *	getModuleData () const
Protected Member Functions inherited from MemoryPoolObject
virtual	~MemoryPoolObject ()
void *	operator new (size_t s)
void	operator delete (void *p)
virtual MemoryPool *	getObjectMemoryPool ()=0

Additional Inherited Members
Static Public Member Functions inherited from CollideModule
static Int	getInterfaceMask ()
Static Public Member Functions inherited from BehaviorModule
static Int	getInterfaceMask ()
static ModuleType	getModuleType ()
Static Public Member Functions inherited from Module
static ModuleData *	friend_newModuleData (INI *ini)

Detailed Description

Definition at line 66 of file CrateCollide.h.

Member Enumeration Documentation

SabotageVictimType

enum CrateCollide::SabotageVictimType

Enumerator
SAB_VICTIM_GENERIC
SAB_VICTIM_COMMAND_CENTER
SAB_VICTIM_FAKE_BUILDING
SAB_VICTIM_INTERNET_CENTER
SAB_VICTIM_MILITARY_FACTORY
SAB_VICTIM_POWER_PLANT
SAB_VICTIM_SUPERWEAPON
SAB_VICTIM_SUPPLY_CENTER
SAB_VICTIM_DROP_ZONE

Definition at line 75 of file CrateCollide.h.

Constructor & Destructor Documentation

CrateCollide()

CrateCollide::CrateCollide	(	Thing *	thing,
		const ModuleData *	moduleData )

Definition at line 99 of file CrateCollide.cpp.

Member Function Documentation

doSabotageFeedbackFX()

void CrateCollide::doSabotageFeedbackFX	(	const Object *	other,
		SabotageVictimType	type = SAB_VICTIM_GENERIC )

Definition at line 198 of file CrateCollide.cpp.

executeCrateBehavior()

virtual Bool CrateCollide::executeCrateBehavior ( Object * other )

protectedpure virtual

This is the game logic execution function that all real CrateCollides will implement.

Implemented in ConvertToCarBombCrateCollide, ConvertToHijackedVehicleCrateCollide, HealCrateCollide, MoneyCrateCollide, SabotageCommandCenterCrateCollide, SabotageFakeBuildingCrateCollide, SabotageInternetCenterCrateCollide, SabotageMilitaryFactoryCrateCollide, SabotagePowerPlantCrateCollide, SabotageSuperweaponCrateCollide, SabotageSupplyCenterCrateCollide, SabotageSupplyDropzoneCrateCollide, SalvageCrateCollide, ShroudCrateCollide, UnitCrateCollide, and VeterancyCrateCollide.

isCarBombCrateCollide()

virtual Bool CrateCollide::isCarBombCrateCollide ( ) const

inlinevirtual

Reimplemented from CollideModule.

Reimplemented in ConvertToCarBombCrateCollide.

Definition at line 97 of file CrateCollide.h.

isHijackedVehicleCrateCollide()

virtual Bool CrateCollide::isHijackedVehicleCrateCollide ( ) const

inlinevirtual

Reimplemented from CollideModule.

Reimplemented in ConvertToHijackedVehicleCrateCollide.

Definition at line 98 of file CrateCollide.h.

isRailroad()

virtual Bool CrateCollide::isRailroad ( ) const

inlinevirtual

Reimplemented from CollideModule.

Reimplemented in ConvertToCarBombCrateCollide.

Definition at line 96 of file CrateCollide.h.

isSabotageBuildingCrateCollide()

virtual Bool CrateCollide::isSabotageBuildingCrateCollide ( ) const

inlinevirtual

Reimplemented from CollideModule.

Reimplemented in SabotageCommandCenterCrateCollide, SabotageFakeBuildingCrateCollide, SabotageInternetCenterCrateCollide, SabotageMilitaryFactoryCrateCollide, SabotagePowerPlantCrateCollide, SabotageSuperweaponCrateCollide, SabotageSupplyCenterCrateCollide, and SabotageSupplyDropzoneCrateCollide.

Definition at line 99 of file CrateCollide.h.

isValidToExecute()

Bool CrateCollide::isValidToExecute ( const Object * other ) const

protectedvirtual

This allows specific vetoes to certain types of crates and their data.

Reimplemented in ConvertToCarBombCrateCollide, ConvertToHijackedVehicleCrateCollide, SabotageCommandCenterCrateCollide, SabotageFakeBuildingCrateCollide, SabotageInternetCenterCrateCollide, SabotageMilitaryFactoryCrateCollide, SabotagePowerPlantCrateCollide, SabotageSuperweaponCrateCollide, SabotageSupplyCenterCrateCollide, SabotageSupplyDropzoneCrateCollide, SalvageCrateCollide, and VeterancyCrateCollide.

Definition at line 151 of file CrateCollide.cpp.

onCollide()

void CrateCollide::onCollide ( Object * other, const Coord3D * loc, const Coord3D * normal )

virtual

This collide method gets called when collision occur.

The collide event. Note that when other is NULL it means "collide with ground"

Implements CollideModule.

Definition at line 115 of file CrateCollide.cpp.

wouldLikeToCollideWith()

virtual Bool CrateCollide::wouldLikeToCollideWith ( const Object * other ) const

inlinevirtual

this is used for things like pilots, to determine if they can "enter" something

Reimplemented from CollideModule.

Definition at line 94 of file CrateCollide.h.

---

The documentation for this class was generated from the following files:

• Code/GameEngine/Include/GameLogic/Module/CrateCollide.h
• Code/GameEngine/Source/GameLogic/Object/Collide/CrateCollide/CrateCollide.cpp