Kiln API / kiln / system

Function: system()

Call Signature

function system(fn, options?): System;

A system with no query: runs once per phase run with only the context.

Parameters

Parameter	Type
fn	(ctx) => void
options?	SystemOptions

Returns

System

Call Signature

function system<P>(
   query, 
   fn, 
   options?
): System;

A per-entity system: runs fn once per entity matching the query.

Type Parameters

Type Parameter
P extends QueryList

Parameters

Parameter	Type
query	P
fn	(row, ctx) => void
options?	SystemOptions

Returns

System

Call Signature

function system<Q>(
   queries, 
   fn, 
   options?
): System;

A system over named queries: runs once per phase run with each query's results.

Type Parameters

Type Parameter
Q extends NamedQueries

Parameters

Parameter	Type
queries	Q
fn	(queries, ctx) => void
options?	SystemOptions

Returns

System