doc/index.txt

   1 = LuaGame Documentation =
   2
   3 == Tutorials ==
   4 === Basic Tutorial ===
   5 The link:basic_tutorial.html[basic tutorial] is a light introduction to the concepts that
   6 are central to programming with LuaGame.
   7
   8 === Animation ===
   9 The link:animation_tutorial.html[animation tutorial] discusses how animation works
  10 in LuaGame and how to use it.
  11
  12 === Using Instrumentation ===
  13 The link:instrumentation_guide.html[instrumentation guide] is an introduction to
  14 using the instrumentation functions to do some simple profiling and logging.
  15
  16 == Class Reference ==
  17 === Object ===
  18 The link:class_object.html[Object] class is the basic class that all
  19 in-game entities should descend from.
  20
  21 === ObjectList ===
  22 link:class_objectlist.html[ObjectList]s are a resource manager implemented
  23 as a list. They are designed to hold link:class_object.html[Object]s, but can
  24 technically hold anything.
  25
  26 === EventManager ===
  27 The link:class_eventmanager.html[EventManager] class provides a robust way of
  28 handling user input while still being relatively simple to set up.
  29
  30 === FPSManager ===
  31 The link:class_fpsmanager.html[FPSManager] class is an extremely simple FPS
  32 management class. It also supports deltas.
  33
  34 === Rect ===
  35 The link:class_rect.html[Rect] class is an extremely simple class that is
  36 used for collision detection. If an link:class_object.html[Object] doesn't have any defined collision
  37 link:class_rect.html[Rect]s, then the bounding box is used for collision. This
  38 class allows for highly customized collision behaviors.
  39
  40 === ParticleSystem ===
  41 link:class_particlesystem.html[ParticleSystem]s are highly configurable particle
  42 systems. They are designed to emit link:class_object.html[Object]s with configurable
  43 parameters in arrangements that are fully configurable.
  44
  45 === Label ===
  46 The link:class_label.html[Label] class is a basic text label that descends from
  47 the link:class_object.html[Object] class.
  48
  49 === Line ===
  50
  51 === Rectangle ===
  52
  53 === Circle ===
  54
  55 === Ellipse ===
  56
  57
  58 == Function Reference ==
  59 The link:fun_ref.html[function reference] contains information about all of the
  60 exported functions from C++ to Lua.