iLand Javascript API Reference
iLand includes an embedded Javascript scripting engine that allows you to automate tasks, script custom disturbances, evaluate stand state, and configure the Agent-Based Management Engine (ABE).
This reference documentation is automatically parsed from the source code, organizing the scripting API into three main sections:
API Modules
iLand Core API
Classes for automating model execution and accessing spatial grid/tree-level states.
* Globals — Helper utilities and core model control
* Grid — 2D spatial grid operations
* Tree — Individual tree-level inspection
Agent-Based Management (ABE)
Core classes to script customized agents, activities, and stand treatment programs.
* FMEngine — Main entry point for ABE scripting
* Stand — Properties of forest stands
* TreeList, SaplingList, DeadTreeList — Act on ecosystem components
ABE Library
A set of pre-defined building blocks for thinning, planting, and harvesting.
* helper — Utilities to construct and inspect STPs
* thinning — Thinning block operations
* harvest — Harvesting block operations
Scripting Overview
For a broader introduction on how to use JavaScript within iLand, including running scripts, time events, and expressions, please refer to the general scripting guides:
- Scripting Overview: Introduction to scripting concepts in iLand.
- General Scripting in iLand: Details about integrating scripts, file paths, and interactive executions.