Scripting API

Get Started with Scripting

Learn how to write your first custom scripts!

Built-in components

Find information about Overload engine built-in components

• Component
• Transform
• Camera
• MaterialRenderer
• ModelRenderer
• Light
• PointLight
• SpotLight
• DirectionalLight
• AmbientBoxLight
• AmbientSphereLight
• PhysicalObject
• PhysicalBox
• PhysicalSphere
• PhysicalCapsule
• AudioListener
• AudioSource
• PostProcessStack

Mathematical objects

Mathematical usertypes for your scripts

• Vector2
• Vector3
• Vector4
• Matrix3
• Matrix4
• Quaternion

Miscellaneous usertypes

Other usertypes related to the entity, physics, scene systems

• Actor
• Scene
• RaycastHit

Post-Processing data structures

• EffectSettings
• BloomSettings
• AutoExposureSettings
• TonemappingSettings
• FXAASettings

Global functions

Functions that can be called from anywhere. Debugging tools, input system, physics, resource loading...

• Debug
• Inputs
• Scenes
• Physics
• Math
• Resources

Enumerations

Enumerations that you can use in your scripts

• Key
• MouseButton
• FrustumBehaviour
• ProjectionMode
• CollisionDetectionMode
• TonemappingMode