CRYENGINE Engine Code

In This Topic

• Getting Started with Engine Code — This document covers basic information on using and compiling engine source code and software needed.
• Engine Modules — One by one explanation what each engine module contributes to CRYENGINE.
  • CryCommon
    • CryExtension
      • CryExtension Samples
    • CryString
    • ICrySizer
    • CryColor Table
    • Serialization Library
  • CryAction — CryAction is the framework that is placed between your game project and the engine.
    • ActionMapManager
    • Effect System
    • Item System
    • Level System
    • Vehicle System
    • View System
  • Cry3DEngine
    • RenderNode Interface
  • CryAISystem — The AI system is composed of several internal subsystems that build a framework for artificial intelligence.
    • Modular Behavior Tree — The Modular Behavior tree is used to make decisions and run Actions over time.
      • Modular Behavior Tree Nodes
      • Modular Behavior Tree Debugging
    • Multi-Layer Navigation Mesh (MNM) — Defines areas in the world on which agents can move.
      • Creating a NavMesh in Sandbox
      • Debugging Navigation
    • Movement System — Allows agents to move through the world by traversing the Navigation Mesh.
      • Movement System (design details)
    • AI Bubbles System — A debugging facility to display arbitrary text in the world.
    • Tactical Point System — A powerful method of querying the environment for places of interest.
    • AI Communication — Playing sound/voice and/or animations at the right times during the game.
    • Auto-disable — Save CPU time by disabling specific AIs.
    • Factions — Organizing AIs in factions to specify their reaction towards each other.
    • Signals — Signals are used to send all kind of events to other AI entities.
      • Signal Reference
    • Cluster Detector — A C++ class for clustering data
    • Obsolete AI Documentation
      • Behavior Trees
      • Coordinating Agents with Behavior Trees
      • Triangulation-based Navigation
      • How to Create a Simple Flying Entity
      • Flight Navigation
      • Sensory Models
      • Navigation Q & A
      • Path Following
      • Flight AI
      • Pathfinding Costs
      • AI System Overview
        • Navigation
        • Individual AI
        • Global AI
        • More
      • Refpoints
      • Obsolete AI Scripting Documentation
        • General Logic Scripts
        • Character Scripts
        • Behavior Scripts (Obsolete Version)
        • AI Wander Behavior
        • Behavior Selection Trees
          • Create A Simple AI Behavior
        • Behavior Scripts
        • Behavior Scripts and Goal Pipes
        • Goal Pipes
          • Goalop Reference
          • Goalpipes - From Lua to XML
  • CryAnimation — CryAnimation is a collection of systems and utilities focused on animating game entities through playback of pre-authored sequences and procedural motion synthesis.
    • CryAnimation Overview
    • Animation Events
    • Limb IK Technical
    • Facial Animation Programming
    • Animation Streaming
    • Animation Debugging
    • Fall and Play
    • Time in CryAnimation
  • CryEntitySystem
    • Entity Property Prefixes
    • Creating a New Entity Class
    • EntityID Explained
    • Adding Usable Support on an Entity
    • Entity System Script Callbacks
  • CryInput
  • CryLobby — CryLobby is a collection of modules abstracting away platform specific Lobby and Matchmaking services.
  • CryMovie — CryMovie is the central point for managing camera and sequence related things in CRYENGINE.
  • CryNetwork — CryNetwork is a compound module incorporating everything needed to create and run a multiplayer game on the network.
    • Concepts Overview
    • RMI Functions
    • Network Scheduling
    • Host Migration
    • Bandwidth Profiler
    • Network Serialization and Aspects
  • CryParticleSystem — The Particle System is responsible for simulating particle effects. It provides facilities to create, manipulate and render particles of different kinds.
  • CryPhysics — The physics subsystem is used to physically simulate objects registered in it.
    • In Depth Simulation Description
    • GetEntitiesInBox
    • Collision Classes
    • Registering geometries in the physics
    • Physical entity types
    • Physical entity interface
    • Physical Areas
    • Ray and Primitive Tracing
    • Physical Explosions
    • Physical Breakage Systems
    • Using NVIDIA PhysX in CRYENGINE
    • Local Simulation Grids
  • Rendering Modules
    • Shaders — Information for shader development and customization. This includes a material and pipeline overview with the Effect format, Shader Cache and Remote Shader Compiler.
      • Shader Cache — This section provides information on folder structure, benefits of cache files and how to build them with the Remote Shader Compiler.
        • Remote Shader Compiler — An explanation of how to configure and run the Remote Shader Compiler.
        • Generating Shader Combinations — Tips for listing the shader combinations that will be necessary for a game.
        • ShaderCache Generation — Learn how to setup and create Shader Cache packages for multiple platforms.
      • Shader Development Introduction — A basic introduction to the development setup for shader development with CRYENGINE.
    • Generating Stars DAT File — Instructions for generating or modifying the stars data used in the sky rendering.
  • CryScriptSystem
    • Lua Scripting
      • Common Lua Functions
        • Common Lua
        • EntityUtils Lua
        • Math Lua
        • Physics Lua
      • Integrations Between Lua and C++
      • Learning the Lua language
      • Script Usage
      • Using the Lua Debugger
      • Using the Lua XML Loader
  • CrySystem — CrySystem is the main controller of the engine. It takes care of the lifetime of most other engine modules and invokes their update functions.
    • Threading
      • Creating a Thread
      • Destroying a Thread
      • Managing Threads (.thread_config)
    • Streaming System — The CRYENGINE streaming engine takes care of the streaming of meshes, textures, audio, animations and more.
    • Text Localization & Unicode Support
    • Logging System
    • Console — The console is a user interface system which handles console commands and console variables.
      • CVar Tutorial
    • File System — enter short explanation here
      • CryPak
        • Accessing Files with CryPak
      • Tracking File Access
    • User Interface (Programming)
      • Scaleform GFx and CRYENGINE
      • Using FlashUI from C++
      • Enabling IME in code
    • Memory Manager
      • Memory Handling
  • CryMonoBridge — The purpose of CryMonoBridge is to load and handle the Mono runtime for the execution of .NET based modules.
• Python Plugins