Latest version:
Tramway SDK 0.0.9
Github
Quick links
Home
Get Started

Components


The framework comes packaged with some pre-made EntityComponents. Some of these components are convenient wrappers around lower level systems, others have some logic of their own.

These components are:

  • Animation
  • Allows playback of Animations for 3D models. Can be attached to a RenderComponent.

  • Audio
  • A wrapper around an audio source. Can be used to play back sounds.

  • Controller
  • Controller for characters, i.e. player, NPCs. Accepts movement commands, i.e. walk, turn, jump, etc.

  • Light
  • A wrapper around a light. Used to illuminate the 3D scene.

  • Particle
  • Enables the creation of particle effects, i.e. smoke, sparks, falling leaves, snow, etc.

  • Physics
  • A wrapper around a rigidbody in the physics simulation.

  • Player
  • Maps input from the UI system into commands for a CharacterController.

  • Render
  • A wrapper around a draw list entry. Used to display 3D models in the scene.

  • Sprite
  • Can be used to display a flat 2D image in a 3D scene.

  • Template
  • Blank component, the source of which can be copied to be used as a base to create new components.

  • Trigger
  • A wrapper around a trigger. Can fire off callbacks when a rigidbody enters its volume.