Log inGet started
World

Builtin Library

Branchmain
Branchesmainpublish
Commitdd348ac6c3

README.md

procgen.explain

A plain-text summary of a .procGraph graph for reading before changing it: its size (nodes, composites, inputs, outputs), its description, its declared inputs with their types and descriptions, the op or node each of its nodes runs, the composites it references, and where each output comes from. For a graph of the call form it also lists the nodes that run on the CPU every frame, each with the change that puts it on the device (what procgen.validate reports as CPU_PER_FRAME).

graph is the graph, by its VFS path or its name, or a graph object.

print(tools.use("procgen", "explain", { graph = "/source/fx/Pebbles.procGraph" }).text)

Part of procgen.toolbox, called as tools.use("procgen", "explain", ...) (zero procgen explain in the engine shell). Returns { text }.