Documentation

From NeoAxis 3D Engine Wiki

(Difference between revisions)
Jump to: navigation, search
 
(21 intermediate revisions by one user not shown)
Line 12: Line 12:
 
=== Toolset ===
 
=== Toolset ===
  
* [[Documentation/Articles/Overview of Configurator|Overview of Configurator]]
+
* [[Documentation/Articles/Overview of Configurator|Configurator]]
* [[Documentation/Articles/Overview of Game.exe|Overview of Game.exe]]
+
* [[Documentation/Articles/Overview of Game.exe|Game.exe]]
* [[Documentation/Articles/Overview of Map Editor|Overview of Map Editor]]
+
* [[Documentation/Articles/Overview of Map Editor|Map Editor]]
** [[Documentation/Articles/Overview of Logic Editor|Overview of Logic Editor]]
+
** [[Documentation/Articles/Overview of Logic Editor|Logic Editor]]
* [[Documentation/Articles/Overview of Resource Editor|Overview of Resource Editor]]
+
* [[Documentation/Articles/Overview of Resource Editor|Resource Editor]]
** [[Documentation/Articles/Overview of Object Type Editor|Overview of Object Type Editor]]
+
** [[Documentation/Articles/Overview of Object Type Editor|Object Type Editor]]
** [[Documentation/Articles/Overview of Physics Model Editor|Overview of Physics Model Editor]]
+
** [[Documentation/Articles/Overview of Physics Model Editor|Physics Model Editor]]
** [[Documentation/Articles/Overview of Particle System Editor|Overview of Particle System Editor]]
+
** [[Documentation/Articles/Overview of Particle System Editor|Particle System Editor]]
** [[Documentation/Articles/Overview of Mesh Editor|Overview of Mesh Editor]]
+
** [[Documentation/Articles/Overview of Mesh Editor|Mesh Editor]]
** [[Documentation/Articles/Overview of Material Editor|Overview of Material Editor]]
+
** [[Documentation/Articles/Overview of Material Editor|Material Editor]]
** [[Documentation/Articles/Overview of User Interface Editor|Overview of User Interface Editor]]
+
** [[Documentation/Articles/Overview of User Interface Editor|User Interface Editor]]
** [[Documentation/Articles/Overview of Font Definition Editor|Overview of Font Definition Editor]]
+
** [[Documentation/Articles/Overview of Font Definition Editor|Font Definition Editor]]
** [[Documentation/Articles/Overview of Model Import Editor|Overview of Model Import Editor]]
+
** [[Documentation/Articles/Overview of Model Import Editor|Model Import Editor]]
* [[Documentation/Articles/Overview of Deployment Tool|Overview of Deployment Tool]]
+
* [[Documentation/Articles/Overview of Deployment Tool|Deployment Tool]]
* [[Documentation/Articles/Overview of Shader Cache Compiler|Overview of Shader Cache Compiler]]
+
* [[Documentation/Articles/Overview of Shader Cache Compiler|Shader Cache Compiler]]
  
 
|valign="top"|
 
|valign="top"|
  
=== Tutorials ===
+
=== Import Content ===
  
* [[Documentation/Tutorials/Creating a Simple Map|Creating a Simple Map]]
+
* [[Documentation/Tutorials/Export models from Autodesk 3ds Max|Autodesk 3ds Max]]
* [[Documentation/Tutorials/Creating a Simple Object Type|Creating a Simple Object Type]]
+
* [[Documentation/Tutorials/Export models from Autodesk Maya|Autodesk Maya]]
* [[Documentation/Tutorials/Creating a complex dynamic object|Creating a Complex Dynamic Object]]
+
* [[Documentation/Tutorials/Import models from file|Import from file (FBX, COLLADA and other formats)]]
* [[Documentation/Tutorials/Main Character Replacement|Main Character Replacement]]
+
* [[Documentation/Tutorials/Making sky (sky box, sky dome and other methods)|Making Sky (Sky Box, Sky Dome and Other Methods)]]
+
* [[Documentation/Tutorials/Adding a new language|Adding a New Language]]
+
  
=== Export Models from Modeling Packages ===
+
=== Tutorials ===
  
* [[Documentation/Tutorials/Export models from Autodesk 3ds Max|Export Models from Autodesk 3ds Max]]
+
* [[Documentation/Tutorials/Creating a Simple Map|Creating a simple map]]
* [[Documentation/Tutorials/Export models from Autodesk Maya|Export Models from Autodesk Maya]]
+
* [[Documentation/Tutorials/Creating a Simple Object Type|Creating a simple object type]]
* [[Documentation/Tutorials/Export models from Blender, Autodesk Softimage and other packages with using intermediate format|Export models from Blender, Autodesk Softimage and other packages with using intermediate format]]
+
* [[Documentation/Tutorials/Creating a complex dynamic object|Creating a complex dynamic object]]
 +
* [[Documentation/Tutorials/Main Character Replacement|Main character replacement]]
 +
* [[Documentation/Tutorials/Making sky (sky box, sky dome and other methods)|Making sky (sky box, sky dome, other methods)]]
 +
* [[Documentation/Tutorials/Adding a new language|Adding a new language]]
 +
* [[Documentation/Articles/How to improve performance and reduce loading time|How to improve performance and reduce loading time]]
  
 
=== Components ===
 
=== Components ===
  
* [[Documentation/Articles/Overview of Full-Screen Effects|Overview of Full-Screen Effects]]
+
* [[Documentation/Articles/Overview of Full-Screen Effects|Full-screen effects]]
* [[Documentation/Articles/Overview of Portal System|Overview of Portal System (invisible geometry culling)]]
+
* [[Documentation/Articles/Overview of Portal System|Portal system (invisible geometry culling)]]
* [[Documentation/Articles/Overview of Animation System|Overview of Animation System]]
+
* [[Documentation/Articles/Overview of Animation System|Animation system]]
* [[Documentation/Articles/Overview of Object Components|Overview of Object Components]]
+
* [[Documentation/Articles/Overview of Object Components|Object components]]
 
+
=== Performance Optimization ===
+
 
+
* [[Documentation/Articles/How to improve performance and reduce loading time|How to Improve Performance and Reduce Loading Time]]
+
  
 
|}
 
|}
Line 92: Line 89:
 
* Portal System \ [[Documentation/Entity_Types/Base/Zone.type|Zone]] — Zone. It's a part of the Portal System.
 
* Portal System \ [[Documentation/Entity_Types/Base/Zone.type|Zone]] — Zone. It's a part of the Portal System.
 
* Special \ [[Documentation/Entity_Types/Special/CutSceneManager.type|CutSceneManager]] — Used to create cut-scenes.
 
* Special \ [[Documentation/Entity_Types/Special/CutSceneManager.type|CutSceneManager]] — Used to create cut-scenes.
 +
* Special \ [[Documentation/Entity_Types/Special/Freeze Objects Manager.type|Freeze Objects Manager]] — The manager for management freezing of the object for optimization purposes.
 +
* Special \ [[Documentation/Entity_Types/Special/Freeze Objects Area.type|Freeze Objects Area]] — Area for Freeze Objects Manager.
 
* Special \ [[Documentation/Entity_Types/Special/HelperPoint.type|HelperPoint]] — Helper point.
 
* Special \ [[Documentation/Entity_Types/Special/HelperPoint.type|HelperPoint]] — Helper point.
 
* Special \ [[Documentation/Entity_Types/Special/MapChangeRegion.type|MapChangeRegion]] — Trigger area that will make the player change level.
 
* Special \ [[Documentation/Entity_Types/Special/MapChangeRegion.type|MapChangeRegion]] — Trigger area that will make the player change level.
Line 108: Line 107:
 
== Programming Articles ==
 
== Programming Articles ==
  
{|
+
* [[Documentation/Programming_Articles/Introduction to SDK Structure|Introduction to SDK structure.]]
|width="500" valign="top"|
+
* [[Documentation/API Reference|API Reference.]]
 
+
* [[Documentation/Programming Tutorials/Creation of an Entity Class|Creation of an entity class.]]
=== Articles ===
+
* [[Documentation/Programming Tutorials/Creation of a new Game Type|Creation of a new game type.]]
* [[Documentation/Programming_Articles/Introduction to SDK Structure|Introduction to SDK Structure]]
+
* [[Documentation/Programming Tutorials/Creation of a custom GUI class|Creation of a custom GUI class.]]
* [[Documentation/Programming_Articles/Transferring the project to the new engine version|Transferring the project to the new engine version]]
+
* [[Documentation/Programming Tutorials/Adding additional gui controls to selected entities in the Map Editor|Adding additional GUI controls to selected entities in the Map Editor.]]
* [[Documentation/Programming_Articles/Entity System|Entity System]]
+
* [[Documentation/Programming Tutorials/Creation of a new Posteffect|Creation of a new post-effect.]]
* [[Documentation/Programming_Articles/Map System|Map System]]
+
* [[Documentation/Programming Tutorials/Adding a new custom input device|Adding a new custom input device.]]
* [[Documentation/Programming_Articles/Overview of a GuiRenderer|Overview of a GuiRenderer]]
+
* [[Documentation/Programming Tutorials/Adding a new localization file format|Adding a new localization file format.]]
* [[Documentation/Programming_Articles/Engine Console|Engine Console]]
+
* [[Documentation/Programming_Articles/Overview of a GuiRenderer|Overview of a GuiRenderer.]]
* [[Documentation/Programming_Articles/Overview of TextBlock format|Overview of TextBlock format]]
+
* [[Documentation/Programming_Articles/Engine Console|Engine console.]]
 
+
* [[Documentation/Programming_Articles/Overview of TextBlock format|Overview of TextBlock format.]]
=== Various ===
+
* [[Documentation/Programming_Articles/Transferring the project to the new engine version|Transferring the project to the new engine version.]]
 
+
* [[Documentation/Code Snippets|Code Snippets]]
+
* [[Documentation/API Reference|API Reference]]
+
 
+
|valign="top"|
+
 
+
=== Tutorials ===
+
 
+
* [[Documentation/Programming Tutorials/Creation of an Entity Class|Creation of an Entity Class]]
+
* [[Documentation/Programming Tutorials/Creation of a new Game Type|Creation of a new Game Type]]
+
* [[Documentation/Programming Tutorials/Creation of a custom GUI class|Creation of a custom GUI class]]
+
* [[Documentation/Programming Tutorials/Adding additional gui controls to selected entities in the Map Editor|Adding additional gui controls to selected entities in the Map Editor]]
+
* [[Documentation/Programming Tutorials/Creation of a new Posteffect|Creation of a new Posteffect]]
+
* [[Documentation/Programming Tutorials/Adding a new custom input device|Adding a new custom input device]]
+
* [[Documentation/Programming Tutorials/Creation of addons for the Resource Editor and for the Map Editor|Creation of addons for the Resource Editor and for the Map Editor]]
+
* [[Documentation/Programming Tutorials/Adding a new localization file format|Adding a new localization file format]]
+
 
+
=== Third-Party Tutorials ===
+
 
+
* [[Documentation/Programming Tutorials/How to Create a Terrain for NeoAxis using L3DT|How to Create a Terrain for NeoAxis using L3DT]]
+
* [[Documentation/Programming Tutorials/Attach Camera to a Bone|Attach Camera to a Bone]]
+
 
+
|}
+
  
 
== Additional ==
 
== Additional ==
  
* [[Documentation/Frequently Asked Questions|Frequently Asked Questions]]
+
* [[Documentation/Third-Party Content Creation Tools|Third-party content creation tools.]]
* [[Documentation/Video Tutorials|Video Tutorials]]
+
* [[Documentation/Third-Party Content Creation Tools|Third-Party Content Creation Tools]]
+
 
+
== Old Articles to Update ==
+
 
+
* [[Documentation/Articles/Introduction to Game Object System|Introduction to Game Object System]]
+
* [[Documentation/Articles/Overview of File System|Overview of File System]]
+
  
 
__NOEDITSECTION__
 
__NOEDITSECTION__

Latest revision as of 07:58, 15 June 2016

Go to higher level

Contents

Articles for NeoAxis 3D Engine

Getting Started

Toolset

Import Content

Tutorials

Components

Object Types

In the Map Editor each object has it's own type. You will find here a list of the base object types available in the SDK. In addition to these base types, you can create your own type of objects and place such objects in the Map Editor.

Root map object:

  • Map — Map object. This type is automatically created with a new map and can't be deleted.

Basic types:

  • Basic \ CollisionVolume — This type is used to create invisible obstacles on the map.
  • Basic \ DecorativeObjectManager — This type allows you to create a large amount of objects (like grass, trees, rocks) to quickly populate your map.
  • Basic \ Fog — Fog.
  • Basic \ GeneralMapObject — For objects without special behaviour.
  • Basic \ MapCompositorManager — This type is used for setting up post-processing effects on the map.
  • Basic \ ParticleSystemSource — This type is used as a particle source on the map.
  • Basic \ Region — An area you place on the map (can be used as a trigger).
  • Basic \ SkyBox — Sky using a cubic texture.
  • Basic \ SkyDome — Sky using a hemisphere.
  • Basic \ SoundSource — Sound source on the map.
  • Basic \ SpawnPoint — Spawn point for the player (or other units).
  • Basic \ StaticMesh — An object used for creating static geometry on the map.
  • Camera \ MapCamera — This type is used for placing cameras on the map.
  • Camera \ MapCameraCurve — This type allows you to create a camera path.
  • Lighting \ CubemapZone — Used to generate a cubemap texture of the environment.
  • Lighting \ CubemapZone_BoxParallaxCorrectedZone — Used to correct rendering reflections from cubemaps (CubemapZone.type).
  • Lighting \ LensFlareManager — Used to manage lens flares from the Sun light source.
  • Lighting \ Light — Light source.
  • Lighting \ StaticLightingManager — Allows you to configure and bake precalculated static lighting.
  • Lighting \ Sun — Sun light source.
  • Pathfinding \ GridBasedNavigationSystem — Pathfinding system based on a grid.
  • Pathfinding \ RecastNavigationSystem — Pathfinding system based on Navigation Mesh technology.
  • Portal System \ Occluder — Used for switching portals on and off. It's a part of the Portal System.
  • Portal System \ Portal — Portal. It's a part of the Portal System.
  • Portal System \ Zone — Zone. It's a part of the Portal System.
  • Special \ CutSceneManager — Used to create cut-scenes.
  • Special \ Freeze Objects Manager — The manager for management freezing of the object for optimization purposes.
  • Special \ Freeze Objects Area — Area for Freeze Objects Manager.
  • Special \ HelperPoint — Helper point.
  • Special \ MapChangeRegion — Trigger area that will make the player change level.
  • Special \ MapCurve — This type is used to set map paths (from point to point).
  • Special \ ObserveCameraArea — An area where the player can move the camera along a given path.
  • Special \ RenderableCurve — Allows you to create curves with any width, color and texture.
  • Terrain \ HeightmapTerrain — Heightmap-based landscape.
  • Terrain \ HeightmapTerrainManager — Heightmap-based landscape with support for streaming.
  • Water Plane \ WaterPlane — This type is used for creating water surfaces.
  • Water Plane \ WaterPlaneClipVolume — Additional type of WaterPlane to control reflection generation.

Additional types that can't be created directly in the Map Editor:

  • Decal — Decals are used to render bullet holes, blood traces, explosion burns etc.
  • ItemCreator — Used to generate items.

Programming Articles

Additional