Komodo.Core.ECS.Systems.SoundSystem Class Reference

Manages all Komodo.Core.ECS.Components.SoundComponent objects. More...

Inheritance diagram for Komodo.Core.ECS.Systems.SoundSystem:

Public Member Functions
	SoundSystem (Game game)
	Parameters game Reference to current Komodo.Core.Game instance.
bool	AddEntity ([NotNull] Entity entityToAdd)
	Adds a Komodo.Core.ECS.Entities.Entity to the SoundSystem if the Komodo.Core.ECS.Entities.Entity is not already present. More...
void	ClearEntities ()
	Removes all Komodo.Core.ECS.Entities.Entity objects from the SoundSystem. More...
void	Initialize ()
	Initializes the SoundSystem and all tracked Komodo.Core.ECS.Components.SoundComponent objects. More...
void	PostUpdate (GameTime _)
	Runs any operations needed at the end of the Komodo.Core.Game.Update(GameTime) loop. More...
void	PreUpdate (GameTime _)
	Runs any operations needed at the beginning of the Komodo.Core.Game.Update(GameTime) loop. More...
bool	RemoveEntity (Guid entityID)
	Removes a Komodo.Core.ECS.Entities.Entity from the SoundSystem, including all the Komodo.Core.ECS.Entities.Entity's Komodo.Core.ECS.Components.SoundComponent objects. More...
bool	RemoveEntity (Entity entityToRemove)
	Removes a Komodo.Core.ECS.Entities.Entity from the SoundSystem, including all the Komodo.Core.ECS.Entities.Entity's Komodo.Core.ECS.Components.SoundComponent objects. More...
Public Member Functions inherited from Komodo.Core.ECS.Systems.ISystem< SoundComponent >
bool	AddEntity (Entity entityToAdd)
	Adds a Komodo.Core.ECS.Entities.Entity to the ISystem if the Komodo.Core.ECS.Entities.Entity is not already present. More...
void	ClearEntities ()
	Removes all Komodo.Core.ECS.Entities.Entity objects from the ISystem. More...
void	Initialize ()
	Should update the ISystem as well as all of it's T objects. More...
void	PostUpdate (GameTime gameTime)
	Runs any operations needed at the end of the Komodo.Core.Game.Update(GameTime) loop. More...
void	PreUpdate (GameTime gameTime)
	Runs any operations needed at the beginning of the Komodo.Core.Game.Update(GameTime) loop. More...
bool	RemoveEntity (Guid entityID)
	Removes a Komodo.Core.ECS.Entities.Entity from the ISystem, including all the Komodo.Core.ECS.Entities.Entity's T objects. More...
bool	RemoveEntity (Entity entityToRemove)
	Removes a Komodo.Core.ECS.Entities.Entity from the ISystem, including all the Komodo.Core.ECS.Entities.Entity's Komodo.Core.ECS.Components.Component objects. More...

Properties
List< SoundComponent >	Components [get]
	All tracked Komodo.Core.ECS.Components.SoundComponent objects. More...
Dictionary< Guid, Entity >	Entities [get, set]
	All tracked Komodo.Core.ECS.Entities.Entity objects. More...
Game	Game [get]
	Reference to current Komodo.Core.Game instance. More...
bool	IsInitialized [get]
	Whether or not the SoundSystem has called Initialize(). More...
Properties inherited from Komodo.Core.ECS.Systems.ISystem< SoundComponent >
List< T >	Components [get]
	All tracked T objects. More...
Dictionary< Guid, Entity >	Entities [get, set]
	All tracked Komodo.Core.ECS.Entities.Entity objects. More...
Game	Game [get]
	Reference to current Komodo.Core.Game instance. More...
bool	IsInitialized [get]
	Whether or not the ISystem has called Initialize(). More...

Detailed Description

Manages all Komodo.Core.ECS.Components.SoundComponent objects.

Member Function Documentation

AddEntity()

bool Komodo.Core.ECS.Systems.SoundSystem.AddEntity

(

[NotNull] Entity

entityToAdd

)

Adds a Komodo.Core.ECS.Entities.Entity to the SoundSystem if the Komodo.Core.ECS.Entities.Entity is not already present.

Parameters

entityToAdd

Komodo.Core.ECS.Entities.Entity to add.

Returns

Whether or not the Komodo.Core.ECS.Entities.Entity was added to this SoundSystem's Entites. Returns false if the Komodo.Core.ECS.Entities.Entity already existed.

ClearEntities()

void Komodo.Core.ECS.Systems.SoundSystem.ClearEntities

(

)

Removes all Komodo.Core.ECS.Entities.Entity objects from the SoundSystem.

Initialize()

void Komodo.Core.ECS.Systems.SoundSystem.Initialize

(

)

Initializes the SoundSystem and all tracked Komodo.Core.ECS.Components.SoundComponent objects.

PostUpdate()

void Komodo.Core.ECS.Systems.SoundSystem.PostUpdate

(

GameTime

_

)

Runs any operations needed at the end of the Komodo.Core.Game.Update(GameTime) loop.

Will initialize any new uninitialized Komodo.Core.ECS.Components.SoundComponent objects.

Parameters

_	Time passed since last Komodo.Core.Game.Update(GameTime).

PreUpdate()

void Komodo.Core.ECS.Systems.SoundSystem.PreUpdate

(

GameTime

_

)

Runs any operations needed at the beginning of the Komodo.Core.Game.Update(GameTime) loop.

Will initialize any new uninitialized Komodo.Core.ECS.Components.SoundComponent objects.

Parameters

_	Time passed since last Komodo.Core.Game.Update(GameTime).

RemoveEntity() [1/2]

bool Komodo.Core.ECS.Systems.SoundSystem.RemoveEntity

(

Entity

entityToRemove

)

Removes a Komodo.Core.ECS.Entities.Entity from the SoundSystem, including all the Komodo.Core.ECS.Entities.Entity's Komodo.Core.ECS.Components.SoundComponent objects.

Parameters

entityToRemove

Komodo.Core.ECS.Entities.Entity to remove.

Returns

Whether or not the Komodo.Core.ECS.Entities.Entity was removed from this SoundSystem's Entities. Will return false if the Komodo.Core.ECS.Entities.Entity is not present in Entities.

RemoveEntity() [2/2]

bool Komodo.Core.ECS.Systems.SoundSystem.RemoveEntity

(

Guid

entityID

)

Removes a Komodo.Core.ECS.Entities.Entity from the SoundSystem, including all the Komodo.Core.ECS.Entities.Entity's Komodo.Core.ECS.Components.SoundComponent objects.

Parameters

entityID

Unique identifier for the Komodo.Core.ECS.Entities.Entity.

Returns

Whether or not the Komodo.Core.ECS.Entities.Entity was removed from this SoundSystem's Entities. Will return false if the Komodo.Core.ECS.Entities.Entity is not present in Entities.

Property Documentation

Components

List<SoundComponent> Komodo.Core.ECS.Systems.SoundSystem.Components

get

All tracked Komodo.Core.ECS.Components.SoundComponent objects.

Entities

Dictionary<Guid, Entity> Komodo.Core.ECS.Systems.SoundSystem.Entities

getset

All tracked Komodo.Core.ECS.Entities.Entity objects.

Game

Game Komodo.Core.ECS.Systems.SoundSystem.Game

get

Reference to current Komodo.Core.Game instance.

IsInitialized

bool Komodo.Core.ECS.Systems.SoundSystem.IsInitialized

get

Whether or not the SoundSystem has called Initialize().