Alphabetical API index

Manual contents | Quick reference | Project settings | Supporting types | Compatibility

Look up a name, then follow its owner link for the signature, timing, return value, prerequisites, and limitations. Names are case-sensitive; the index sorts without regard to case. Overloads and getter/setter pairs share one entry. The same name on different owners need not have the same behavior.

This index covers declared members of NLSimMain, NLPatch, HexPatch, NLTurtle, NLRoot, APIRoot, Store, Property, CoordsFactory, internal coordinate objects, AgentSet, and AgentList, plus documented model-facing fields and supporting exports. It is not an inventory of every runtime bookkeeping field, Project key, inherited JavaScript Array/Set method, or internal manager. For those collection shapes, see collections.

Inheritance: Main, Patch, and Turtle inherit NLRoot instance helpers; HexPatch inherits NLPatch. APIRoot static utilities are inherited by NLRoot and its subclasses, but are not instance methods: use NLRoot.random(), not this.random(). Entries marked static are class calls. Overrides are listed separately; consult the most specific owner.

Not an endorsement: internal and broken legacy entry points remain indexed so they can be identified. Follow the linked classification before using an unfamiliar name. Examples and model-author advice assume lifecycle: "aligned"; this is not a runtime-default change.

A | B | C | D | E | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X | Y | Z

A

B

C

D

E

F

G

H

I

K

L

M

N

O

P

R

S

T

U

V

W

X

Y

Z

Private names and callback lookup

Underscore-prefixed backing Stores and runtime bookkeeping fields are grouped in the Main internal inventory, Patch context, Turtle internals, and Store field notes. They are not substitutes for public built-in properties.

For callback arguments and binding, use the callback signature lookup. For settings such as lifecycle, visitMode strings, agent defaults, and display codes, use the Project configuration reference.

Index verification

The guide tests check alphabetical order, unique case-sensitive names, owner-specific coverage of declared instance and static members in the classes listed above, and all relative links/anchors. The linked references retain their own executable example and behavior checks.