Logo
v0.12.0

Quickstart

  • Introduction
  • Build
  • Examples
  • Version matrix
  • License

Building

  • Cloning
  • Build requirements
  • Build options
  • Project version
  • Building on Windows
  • Building in Docker (Windows or Linux)
  • Building on Linux natively

Viewer

  • ramses-logic-viewer
  • Lua configuration API

Lua Syntax

  • Quick start
  • Basics of Lua
  • Declaring an interface() and a run() function
  • Global variables and the init() function
  • Environments and isolation
  • Indexing inside Lua
  • Errors in scripts
  • Using Lua modules
  • Additional Lua syntax specifics

API

  • Overview
  • Script creation
  • Object lifecycle
  • Creating links between scripts
  • Linking scripts to Ramses scenes
  • Animations
  • Error handling
  • Print messages from within Lua
  • Iterating over object collections
  • Saving/Loading from file
  • Logging
  • Security and memory safety
  • Performance
  • List of all examples

Class Index

  • Class Index
    • LogicEngine
    • LuaModule
    • LuaScript
    • RamsesNodeBinding
    • RamsesAppearanceBinding
    • RamsesCameraBinding
    • Property
    • LogicNode
    • RamsesBinding
    • DataArray
    • AnimationNode
    • Iterator
    • Collection
    • LuaConfig
    • SetLogHandler
    • SetDefaultLogging
    • GetRamsesLogicVersion
    • PropertyTypeToEnum
    • IsPrimitiveProperty
    • ErrorData
    • EStandardModule
    • EPropertyType
    • EInterpolationType
    • ELogMessageType

ChangeLog

  • master
  • v0.12.0
  • v0.11.0
  • v0.10.2
  • v0.10.1
  • v0.10.0
  • v0.9.1
  • v0.9.0
  • v0.8.1
  • v0.8.0
  • v0.7.0
  • v0.6.2
  • v0.6.1
  • v0.6.0
  • v0.5.3
  • v0.5.2
  • v0.5.0
  • v0.4.2
  • v0.4.1
  • v0.4.0
  • v0.3.1
  • v0.3.0
  • v0.2.0
  • v0.1.0

Developers

  • Understand RAMSES Logic architecture and design
  • Developer guidelines
  • Contributing
  • Pull requests
  • Commit guidelines
  • Review
  • Code style
  • Continuous integration
  • Branching
ramses_logic
  • Docs »
  • Class Index
  • Edit on GitHub

Class IndexΒΆ

API classes

  • LogicEngine
  • LuaModule
  • LuaScript
  • RamsesNodeBinding
  • RamsesAppearanceBinding
  • RamsesCameraBinding
  • Property
  • LogicNode
  • RamsesBinding
  • DataArray
  • AnimationNode
  • Iterator
  • Collection
  • LuaConfig

Logging

  • SetLogHandler
  • SetDefaultLogging

Free functions

  • GetRamsesLogicVersion

Type Traits

  • PropertyTypeToEnum
  • IsPrimitiveProperty

Errors

  • ErrorData

Enums

  • EStandardModule
  • EPropertyType
  • EInterpolationType
  • ELogMessageType
Next Previous

© Copyright 2020, BMW AG Revision 0e3eb067.

Built with Sphinx using a theme provided by Read the Docs.