Cafu Engine
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
oNCommonThis group contains auxiliary libraries (e.g. script classes and object instances) that are available and can be used in all Cafu scripts, such as map scripts, GUI scripts, etc
|oCglobalsThe functions in this group are globals, and are used exactly like the functions from the basic Lua library
|oCConsoleUse the methods of this library for printing strings to the Cafu in-game console
|\CciClass ci provides access to the Cafu in-game console from other scripts (e.g. map scripts, GUI scripts, ...)
oNGameSysThis group contains all script classes related to game worlds in Cafu
|oCComponentBaseTThis is the base class for the components that a game entity is composed/aggregated of
|oCComponentBasicsTThis component adds the basic details of the entity (its name, the "is static?" flag, Map Editor data)
|oCComponentCarriedWeaponTThis component represents a weapon that a player can pick up and use
|oCComponentCollisionModelTThis component adds a collision model to its entity
|oCComponentHumanPlayerTEntities with this component are associated with a client connection at whose end is a human player who provides input to control the entity
|oCComponentInventoryTThis component keeps an inventory count for an arbitrary set of items
|oCComponentLightTThe common base class for light source components
|oCComponentModelTThis component adds a 3D model to its entity
|oCComponentMoverTThis component controls the movement of one or more entities and implements the related effects
|oCComponentParticleSystemOldTThis component adds a particle system to its entity
|oCComponentPhysicsTThis component includes the body of this entity in the dynamic simulation of physics
|oCComponentPlayerPhysicsTThis component implements human player physics for its entity
|oCComponentPlayerStartTThis component marks its entity as possible spawn point for human players that begin a single-player level or join a multi-player game
|oCComponentPointLightTThis component adds a dynamic point light source to its entity
|oCComponentRadiosityLightTThis component adds a radiosity point light source to its entity
|oCComponentScriptTThis component runs custom Lua script code, implementing the behaviour of the entity in the game world
|oCComponentSoundTThis component adds 3D sound output to its entity
|oCComponentTargetTThis component connects its entity to another
|oCComponentTransformTThis component adds information about the position and orientation of its entity
|oCEntityTAn entity is the basic element in a game world
|\CWorldTThis class holds the hierarchy of game entities that populate a game world
\NGuiSysThis group contains all script classes related to Graphical User Interfaces (GUIs) in Cafu
 oCComponentBaseTThis is the base class for the components that a window is composed/aggregated of
 oCComponentBasicsTThis component adds the basics of the window (its name and the "is shown?" flag)
 oCComponentBorderTThis components adds a border to its window
 oCComponentChoiceTThis components add the behaviour of a choice field to its window
 oCComponentImageTThis component adds an image to its window
 oCComponentListBoxTThis components turns its window into a list-box control
 oCComponentModelTThis component adds a 3D model to its window
 oCComponentTextEditTWith this component, the user can edit the text in a sibling text component
 oCComponentTextTThis components adds text to its window
 oCComponentTransformTThis component adds information about the position and size of the window
 oCGuiImplTThis class holds the hierarchy of windows that together form a GUI
 \CWindowTA window is the basic element of a graphical user interface