Entities

The framework comes with some pre-made enitites. These are very nice, you should try using them. If you want, you can extend them by subclassing them and building a new entity on top of them.

• Crate

A crate is basically a RenderComponent and a PhysicsComponent glued together. It doesn't do anything special. Can be used for small clutter objects.

• Decoration

Decorations are meant to display dynamic models. They can have a PhysicsComponent to be used as a collider, but it won't participate in the dynamics simulation.

They also have aRenderComponent and an optional AnimationComponent.

• Light

A wrapper around a LightComponent. Can be used for real-time illumination of dynamic objects and for pre-computed lightmaps.

• Marker

A most basic entity. Has no components, doesn't do anything. It is only used for its transform. Can be used as a template to create further entity types on top of it.

• Player

A very basic entity that serves as a wrapper for a PlayerComponent and a ControllerComponent, which are connected together. Useful if you want the user of your application to be able to walk around the scene.

• Sound

A wrapper around a AudioComponent. Can be used for environmental sounds, or if you just want to trigger a sound by a Signal.

• Static World Object

It's meant for creating worldspawns. RenderComponent for the 3D model part and PhysicsComponent for the collision. Can add lightmaps.

• Trigger

A wrapper for a TriggerComponent. When triggered, outputs Signal, so can be used for logics and stuff.