orxonox::BaseObject Class Reference

Constructor: Registers the object in the BaseObject-list.

Destructor.

Adds an object which listens to the events of this object.

The events are sent to the other objects mainstate.

Adds a new event source for a specific state.

Parameters:

	source	The object which sends events to this object
	state	The state of this object which will be affected by the events

Adds a new event-state to the object.

Event-states are states which can be changed by events.

Parameters:

	name	The name of the event
	state	The object containing information about the event-state

Adds a Template to the object.

Parameters:

temp

The Template

Adds a Template to the object.

Parameters:

name

The name of the Template

This function gets called if the activity of the object changes.

Reimplemented in orxonox::Attacher, orxonox::CheckPoint, orxonox::PortalEndPoint, orxonox::FadingBillboard, orxonox::ParticleEmitter, orxonox::WorldAmbientSound, orxonox::WorldSound, and orxonox::WorldEntity.

Reimplemented in orxonox::PongCenterpoint, orxonox::TetrisCenterpoint, orxonox::TowerDefenseCenterpoint, orxonox::HumanPlayer, and orxonox::PlayerInfo.

This function gets called if the main state name of the object changes.

This function gets called if the name of the object changes.

Reimplemented in orxonox::Template, orxonox::NotificationQueue, orxonox::NotificationQueueCEGUI, orxonox::HUDHealthBar, orxonox::PickupRepresentation, orxonox::PlayerInfo, and orxonox::OrxonoxOverlay.

This function gets called if the visibility of the object changes.

Reimplemented in orxonox::Attacher, orxonox::Planet, orxonox::Trigger, orxonox::GUIOverlay, orxonox::HUDHealthBar, orxonox::Scoreboard, orxonox::BillboardProjectile, orxonox::ParticleProjectile, orxonox::Backlight, orxonox::Billboard, orxonox::FadingBillboard, orxonox::GlobalShader, orxonox::Light, orxonox::Model, orxonox::ParticleEmitter, orxonox::OrxonoxOverlay, orxonox::OverlayGroup, orxonox::Pawn, and orxonox::WorldEntity.

Fires an event, using the Event struct.

Fires an event which activates or deactivates a state with agiven originator (the object which triggered the event).

Fires an event which activates or deactivates a state.

Fires an event (without a state).

Returns an event listener with a given index.

Returns an eventsource with a given index.

Returns the event-state with the given name.

Returns a pointer to the XMLFile that loaded this object.

Returns:

The XMLFile

Returns the levelfile that loaded this object.

Returns:

The levelfile

Returns the indentation of the debug output in the Loader.

Returns:

The indentation

Returns the name of the main state.

Returns the name of the object.

Reimplemented in orxonox::NotificationQueue.

Returns the old name of the object.

Reimplemented in orxonox::Scene.

Returns the name of the first Template.

Returns:

The name as string.

Returns the Template with the given index.

Parameters:

index

The index

Returns the set of all aplied templates.

Returns the state of the objects activity.

Returns:

The state of the activity

Reimplemented in orxonox::MultiTrigger, orxonox::Trigger, and orxonox::TriggerBase.

Returns if the object was initialized (passed the object registration).

Returns:

True was the object is initialized

Reimplemented in orxonox::Bot, orxonox::HumanPlayer, and orxonox::PlayerInfo.

Returns the state of the objects visibility.

Returns:

The state of the visibility

Manually loads all event states, even if the class doesn't officially support them.

This is needed by some classes like EventDispatcher or EventTarget.

Processing an event by calling the right main state.

Parameters:

event

The event struct which contains the information about the event

Reimplemented in orxonox::Attacher, orxonox::EventDispatcher, orxonox::EventFilter, orxonox::EventListener, and orxonox::EventTarget.

Adds an object which listens to the events of this object.

Calls XMLEventPort with an empty XML-element to register the event states if necessary.

Removes an eventsource (but doesn't unregister itself at the source).

Sets the state of the objects activity.

Parameters:

bActive

True = active

Reimplemented in orxonox::QuestEffectBeacon.

Sets a pointer to the xml file that loaded this object.

Parameters:

file

The pointer to the XMLFile

Sets the indentation of the debug output in the Loader.

Parameters:

indentation

The indentation

Sets the main state of the object to a given boolean value.

Note: The main state of an object can be set with the setMainStateName function. It's part of the eventsystem and used for event forwarding (when the target object can't specify a specific state, the main state is used by default).

Sets the name of the main state (used for event reactions).

Sets the name of the object.

Parameters:

name

The name

Reimplemented in orxonox::NotificationQueue.

Sets the state of the objects visibility.

Parameters:

bVisible

True = visible

Loads the name of the object through XML and calls all XMLNameListener.

Parameters:

name

The name of the object

Removes an event listener from this object.

Defines the possible event states of this object and parses eventsources from an XML file.

Parameters:

	xmlelement	The XML-element
	mode	The mode defines the operation that is being executed: loading or saving the object (from or to XML respectively)

Reimplemented in orxonox::Dock, orxonox::NotificationDispatcher, orxonox::Script, orxonox::EventMultiTrigger, orxonox::EventTrigger, orxonox::PortalEndPoint, orxonox::QuestEffectBeacon, orxonox::ParticleSpawner, orxonox::WorldAmbientSound, and orxonox::WorldSound.

XML loading and saving.

Parameters:

	xmlelement	The XML-element
	mode	The mode defines the operation that is being executed: loading or saving the object (from or to XML respectively)

Reimplemented in orxonox::Namespace, orxonox::Template, orxonox::ResourceCollection, orxonox::ResourceLocation, orxonox::CreateStars, orxonox::Dock, orxonox::DockingTarget, orxonox::DockToShip, orxonox::OldRaceCheckPoint, orxonox::RaceCheckPoint, orxonox::SpaceRaceController, orxonox::SpaceRaceManager, orxonox::CommandNotification, orxonox::SimpleNotification, orxonox::NotificationDispatcher, orxonox::NotificationQueue, orxonox::NotificationQueueCEGUI, orxonox::Attacher, orxonox::BoxCollisionShape, orxonox::ConeCollisionShape, orxonox::PlaneCollisionShape, orxonox::SphereCollisionShape, orxonox::EventDispatcher, orxonox::EventFilter, orxonox::EventListener, orxonox::EventTarget, orxonox::ForceField, orxonox::Planet, orxonox::Script, orxonox::SpaceBoundaries, orxonox::CheckPoint, orxonox::DistanceMultiTrigger, orxonox::DistanceTrigger, orxonox::EventMultiTrigger, orxonox::MultiTrigger, orxonox::Trigger, orxonox::TriggerBase, orxonox::Turret, orxonox::FadeoutText, orxonox::GUIOverlay, orxonox::BarColour, orxonox::HUDBar, orxonox::HUDHealthBar, orxonox::HUDNavigation, orxonox::HUDRadar, orxonox::LastManStandingInfos, orxonox::LastTeamStandingInfos, orxonox::TeamBaseMatchScore, orxonox::OverlayText, orxonox::DamageBoostPickup, orxonox::DronePickup, orxonox::HealthPickup, orxonox::InvisiblePickup, orxonox::MetaPickup, orxonox::ShieldPickup, orxonox::ShrinkPickup, orxonox::SpeedPickup, orxonox::Pickup, orxonox::PickupCollection, orxonox::PickupRepresentation, orxonox::PickupSpawner, orxonox::PongCenterpoint, orxonox::PongScore, orxonox::PortalEndPoint, orxonox::PortalLink, orxonox::AddQuest, orxonox::AddQuestHint, orxonox::AddReward, orxonox::ChangeQuestStatus, orxonox::CompleteQuest, orxonox::FailQuest, orxonox::GlobalQuest, orxonox::LocalQuest, orxonox::Quest, orxonox::QuestDescription, orxonox::QuestEffectBeacon, orxonox::QuestHint, orxonox::QuestItem, orxonox::QuestListener, orxonox::TetrisCenterpoint, orxonox::TetrisScore, orxonox::TowerDefenseCenterpoint, orxonox::TowerDefenseController, orxonox::TowerDefenseHUDController, orxonox::EnergyDrink, orxonox::HsW01, orxonox::CollisionShape, orxonox::CompoundCollisionShape, orxonox::ArtificialController, orxonox::FormationController, orxonox::WaypointPatrolController, orxonox::AnimatedModel, orxonox::Backlight, orxonox::Billboard, orxonox::BlinkingBillboard, orxonox::FadingBillboard, orxonox::GlobalShader, orxonox::Light, orxonox::MeshLodInformation, orxonox::Model, orxonox::ParticleEmitter, orxonox::ParticleSpawner, orxonox::Engine, orxonox::MultiStateEngine, orxonox::Level, orxonox::LevelInfo, orxonox::GUISheet, orxonox::OrxonoxOverlay, orxonox::OverlayGroup, orxonox::Scene, orxonox::WorldAmbientSound, orxonox::WorldSound, orxonox::DefaultWeaponmodeLink, orxonox::Weapon, orxonox::WeaponMode, orxonox::WeaponPack, orxonox::WeaponSet, orxonox::CameraPosition, orxonox::ControllableEntity, orxonox::Drone, orxonox::EffectContainer, orxonox::MobileEntity, orxonox::MovableEntity, orxonox::FpsPlayer, orxonox::Pawn, orxonox::SpaceShip, orxonox::SpawnPoint, orxonox::TeamSpawnPoint, and orxonox::WorldEntity.

True = the object is active.

Reimplemented in orxonox::EventFilter, orxonox::EventListener, orxonox::EventTarget, and orxonox::Trigger.

True if the object was initialized (passed the object registration).

Becomes true after the object registered its event states (with XMLEventPort).

True = the object is visible.

List of objects which listen to the events of this object.

List of objects which listen to the events of this object through the "eventlisteners" subsection in XML.

List of objects which send events to this object, mapped to the state which they affect.

Maps the name of the event states to their helper objects.

The XMLFile that loaded this object.

Reimplemented in orxonox::Level.

Non 0 if the TinyXML attributes have already been copied to our own lowercase map.

Indentation of the debug output in the Loader.

The name of the object.

Reimplemented in orxonox::PickupRepresentation.

The old name of the object.

Lowercase XML attributes.