Class RuleExampleConnection Extends GridGraphRule

void Register (

GridGraphRules

rules

)

Does preprocessing and adds callbacks to the #GridGraphRules object.

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	Sub-rectangle of the grid graph that is being updated/scanned
NativeArray<float4>	nodeNormals	Data for all node normals. This is used to determine if a node exists (important for layered grid graphs).
ref T	callback	The ModifyNode method on the callback struct will be called for each node.

)

Iterate through all nodes.

? int GetNeighbourDataIndex (

IntBounds	bounds	Sub-rectangle of the grid graph that is being updated/scanned
NativeArray<int>	nodeConnections	Data for all node connections
bool	layeredDataLayout	True if this is a layered grid graph
int	dataX	X coordinate in the data arrays for the node for which you want to get a neighbour
int	dataLayer	Layer (Y) coordinate in the data arrays for the node for which you want to get a neighbour
int	dataZ	Z coordinate in the data arrays for the node for which you want to get a neighbour
int	direction	Direction to the neighbour. See GridNode.HasConnectionInDirection.

)

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

The bounds, nodeConnections and layeredDataLayout fields can be retrieved from the GridGraphRules.Context.data object.

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.

Check the documentation for GridGraphScanData to see which data fields are valid in which passes.

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.