Class GridGraphRule

Public

Custom rule for a grid graph.

See

#Pathfinding.GridGraphRules

Grid Graph Rules

Public Methods

DisposeUnmanagedData ()

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

Public

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.

Note

The rule should remain valid after this method has been called. However the Register method is guaranteed to be called before the rule is executed again.

Does preprocessing and adds callbacks to the GridGraphRules object.

Public

void Register (

GridGraphRules

rules

)

Does preprocessing and adds callbacks to the GridGraphRules object.

SetDirty ()

Call if you have changed any setting of the rule.

Public

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.

The purpose of this method call is to cause the Hash property to change. If your custom rule overrides the Hash property to return a hash of some settings, then you do not need to call this method for the changes the hash function already accounts for.

Public Variables

Hash

Hash of the settings for this rule.

Public

int Hash

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.

enabled

Only enabled rules are executed.

Public

bool enabled = true

Only enabled rules are executed.

Public Enums

Pass

Where in the scanning process a rule will be executed.

Public

Pass

BeforeCollision	Before the collision testing phase but after height testing. This is very early. Most data is not valid by this point. You can use this if you want to modify the node positions and still have it picked up by the collision testing code.
BeforeConnections	Before connections are calculated. At this point height testing and collision testing has been done (if they are enabled). This is the most common pass to use. If you are modifying walkability here then connections and erosion will be calculated properly.
AfterConnections	After connections are calculated. If you are modifying connections directly you should do that in this pass. Note If erosion is used then this pass will be executed twice. One time before erosion and one time after erosion when the connections are calculated again.
AfterErosion	After erosion is calculated but before connections have been recalculated. If no erosion is used then this pass will not be executed.
PostProcess	After everything else. This pass is executed after everything else is done. You should not modify walkability in this pass because then the node connections will not be up to date.

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.

Private/Protected Members

dirty

Private

Class GridGraphRule

See

Public Methods

void DisposeUnmanagedData ()

Note

void Register ( GridGraphRules rules )

void SetDirty ()

Public Variables

int Hash

bool enabled = true

Public Enums

Pass

Note

Private/Protected Members

int dirty = 1

void Register (

GridGraphRules

rules

)