Documenting done.

This commit is contained in:
2022-10-20 07:49:42 -07:00
parent 23df65a241
commit df1ae47624
19 changed files with 243 additions and 123 deletions

View File

@@ -15,13 +15,36 @@ namespace Dawn {
public:
SceneItem &item;
/**
* Constructs a new SceneItemComponent. Components are attached to
* SceneItems and will be individual responsibility components, and must
* communicate to other items/components using methods and events.
*
* @param item Scene Item thsi component belongs to.
*/
SceneItemComponent(SceneItem &item);
/**
* Requested on the first frame that the parent scene item has become
* active.
*/
virtual void start() = 0;
/**
* Shorthand to return the scene that this component's item belongs to.
* @return The current scene.
*/
Scene & getScene();
/**
* Shorthand to return the game that this scene belongs to.
* @return The current game.
*/
DawnGame & getGame();
/**
* Cleanup the SceneItemComponent.
*/
virtual ~SceneItemComponent();
};
}