Ramses Logic documentation

Quickstart

• Introduction
• Build
• Examples
• Version matrix
• License

Building

• Cloning
• Build requirements
• Build options
• Project version
• Building on Windows
• Building on Linux natively

Viewer

• ramses-logic-viewer
  • Synopsis
  • Description
  • Options
• Lua configuration API
  • Logic Nodes
  • Logic Properties
  • Views
  • Screenshots
  • Logic Engine Update

Lua Syntax

• Quick start
• Basics of Lua
• Declaring an interface() and a run() function
• Global variables and the init() function
• Custom functions
• Environments and isolation
• Indexing inside Lua
• Errors in scripts
• Using Lua modules
  • Standard modules
  • Custom modules
• Additional Lua syntax specifics
  • Userdata vs. table
  • Vec2/3/4 types
  • Numerics
  • Reading error stack traces

API

• Overview
  • Object types and their relationships
  • Data flow
• Logic node creation
• Object lifecycle
• Creating links between nodes
• Linking logic nodes to Ramses scenes
• Dynamic sorting of content
• Animations
  • Data Arrays
  • Animation Nodes
  • Timer Node
  • Static vs. dynamic animation data
• Error handling
• Iterating over object collections
• Saving/Loading from file
  • Object lifecycle when saving and loading to files
  • File compatibility
  • File compatibility (prior version 1.1 and feature levels)
  • Saving and loading together with a Ramses scene
  • Using memory buffer instead of file
• Logging
• Security and memory safety
  • Additional memory safety measures
  • Additional security considerations
  • Sanitizing of files and buffers
• Performance
  • Profiling logic update cycles
  • Optimizing Lua code
  • Benchmarks
  • Optimizing file size
• List of all examples
  • Minimal example
  • Example with primitive properties
  • Example with structured properties
  • Example with indexed (vector, array) properties
  • Handling compilation errors
  • Handling runtime errors
  • Example with Ramses
  • Save/load from file example
  • Links example
  • Animation example
  • Dynamic animation (animateTo) example
  • Modules example
  • Globals example
  • Interfaces example
  • Anchor points example
  • Render order example
  • SkinBinding example
  • MeshNodeBinding example

Class Index

• Class Index
  • AnimationNode
  • AnimationNodeConfig
  • Collection
  • DataArray
  • Iterator
  • LogicEngine
  • LogicEngineReport
  • LogicNode
  • LogicObject
  • LuaConfig
  • LuaModule
  • LuaInterface
  • LuaScript
  • Property
  • RamsesAppearanceBinding
  • RamsesBinding
  • RamsesCameraBinding
  • RamsesNodeBinding
  • RamsesRenderPassBinding
  • RamsesRenderGroupBinding
  • RamsesRenderGroupBindingElements
  • RamsesMeshNodeBinding
  • SkinBinding
  • SaveFileConfig
  • TimerNode
  • AnchorPoint
  • AnimationChannel
  • ErrorData
  • IsPrimitiveProperty
  • PropertyEnumToType
  • PropertyTypeToEnum
  • WarningData
  • PropertyLink
  • SetLogHandler
  • SetDefaultLogging
  • GetRamsesLogicVersion
  • EInterpolationType
  • ELogMessageType
  • EPropertyType
  • ERotationType
  • EStandardModule
  • EFeatureLevel
  • ELuaSavingMode
  • vec2f
  • vec3f
  • vec4f
  • vec2i
  • vec3i
  • vec4i
  • matrix44f

ChangeLog

• master
• Unreleased
• v1.4.2
• v1.4.1
• v1.4.0
• v1.3.0
• v1.2.2
• v1.2.1
• v1.2.0
• v1.1.1
• v1.1.0
• v1.0.3
• v1.0.2
• v1.0.1
• v1.0.0
• v0.15.0
• v0.14.2
• v0.14.1
• v0.14.0
• v0.13.0
• 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
  • Current Architecture
  • Source contents
  • API, ABI and file format changes
  • I want to understand the code, where do I start?
  • Design decision log
• Developer guidelines
• Contributing
• Pull requests
• Commit guidelines
  • Make smaller but expressive commits
  • Bundle commits into multiple PRs when it makes sense
• Review
  • Review requirements
  • Review steps
• Code style
  • Clang Tidy
  • Custom style check
  • Additional conventions
• Continuous integration
  • Testing Windows builds locally
• Branching