v0.6.2
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
Lua Syntax
Quick start
Basics of Lua
Declaring an interface() and a run() function
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
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
ChangeLog
master
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
»
Ramses Logic documentation
Edit on GitHub
Ramses Logic documentation
ΒΆ
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
Lua Syntax
Quick start
Basics of Lua
Declaring an interface() and a run() function
Indexing inside Lua
Errors in scripts
Using Lua modules
Additional Lua syntax specifics
Vec2/3/4 types
Numerics
The global IN and OUT objects
Things you should never do
Things you should avoid if possible
Special case: using OUT object in other functions
API
Overview
Object types and their relationships
Data flow
Script creation
Object lifecycle
Creating links between scripts
Linking scripts to Ramses scenes
Error handling
Print messages from within Lua
Iterating over object collections
Saving/Loading from file
Object lifecycle when saving and loading to files
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
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
Override print function example
Links example
Class Index
ChangeLog
master
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
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 Linux builds with Docker
Testing Windows builds locally
Branching
Read the Docs
v: v0.6.2
Versions
latest
stable
v0.6.2
v0.6.1
v0.6.0
v0.5.3
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.