Class RuleExample Extends GridGraphRule

void Register (

GridGraphRules

rules

)

Does preprocessing and adds callbacks to the #GridGraphRules object.

int dummyParameter

Just some integer that we can show in the inspector.

void DisposeUnmanagedData ()

Called when the rule is removed or the graph is destroyed.

Use this to e.g. clean up any NativeArrays that the rule uses.

bool enabled = true

Only enabled rules are executed.

void FilterNodeConnections< T > (

IntBounds	bounds
NativeArray<int>	nodeConnections
bool	layeredDataLayout
ref T	filter

)

void ForEachNode< T > (

IntBounds	bounds
ref T	callback

)

int GetNeighbourDataIndex (

IntBounds	bounds
NativeArray<int>	nodeConnections
bool	layeredDataLayout
int	dataIndex
int	direction

)

Returns the data index for a node's neighbour in the given direction.

int Hash => dirty

Hash of the settings for this rule.

The Register method will be called again whenever the hash changes. If the hash does not change it is assumed that the Register method does not need to be called again.

Pass

Where in the scanning process a rule will be executed.

void SetDirty ()

Call if you have changed any setting of the rule.

This will ensure that any cached data the rule uses is rebuilt. If you do not do this then any settings changes may not affect the graph when it is rescanned or updated.