Reference

Look things up. Complete technical reference for Needle Engine APIs, configuration, and capabilities.

Not sure what you need?

• Need to learn the basics? See Tutorials
• Want to solve a specific problem? See How-To Guides
• Want to understand concepts? See Explanation

What is Reference?

Reference documentation is information-oriented and provides:

• Complete API listings
• Configuration specifications
• Platform compatibility matrices
• Technical facts and data

API Documentation

Needle Engine API

• Needle Engine API Documentation - Complete API reference
• Component Lifecycle Methods - awake, start, update, onEnable, etc.
• Physics Event Methods - Collision and trigger events
• Input Event Methods - Mouse, touch, keyboard events
• XR Event Methods - WebXR-specific events
• Time API - Time and deltaTime reference

three.js API

• three.js Documentation - Official three.js API

Components

• Built-in Components Catalog - All 100+ built-in components
• Needle Engine API Documentation - Complete API reference

Configuration

• needle.config.json - Project configuration file
• Needle Engine Attributes - Component attributes and metadata
• TypeScript Decorators - @serializable and other decorators
• Needle Cloud - Official hosting platform and license server

Platform & Format Support

• Features Overview - Complete feature matrix
• Needle Cloud - Official hosting platform and license server

Troubleshooting

• FAQ - Frequently asked questions

Code Examples

• Scripting Examples - Code snippets and patterns

Pricing & Legal

• Pricing Information - View pricing plans and options
• End User License Agreement - Legal terms and conditions

Need Help?

• Want to learn by doing? See Tutorials
• Need to solve a problem? See How-To Guides
• Want to understand concepts? See Explanation
• Have questions? Ask in Discord or check FAQ