Class RuleElevationPenalty Extends GridGraphRule

Public

Applies penalty based on the elevation of the node.

This is useful if you for example want to discourage agents from walking high up in mountain regions.

The penalty applied is equivalent to:

penalty = curve.evaluate(Mathf.Clamp01(Mathf.InverseLerp(lower elevation range, upper elevation range, elevation))) * penaltyScale

See

Grid Graph Rules

Inner Types

JobElevationPenalty

Public Methods

DisposeUnmanagedData ()

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

Does preprocessing and adds callbacks to the GridGraphRules object.

Public Variables

curve

Public

elevationRange

Public

penaltyScale

Public

Inherited Public Members

Hash

Hash of the settings for this rule.

Public

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.
AfterApplied	After the graph update has been applied to the graph. This pass can only be added as a main-thread pass. If many updates are applied to the graph at the same time, this pass will only execute once after all updates have been applied. Warning No data in the context except the reference to the graph is valid at this point. It has all been disposed. You cannot modify any data in this 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.

SetDirty ()

Call if you have changed any setting of the rule.

enabled

Only enabled rules are executed.

Public

Private/Protected Members

elevationToPenalty

Private

Class RuleElevationPenalty Extends GridGraphRule

Inner Types

Public Methods

Public Variables

AnimationCurve curve = AnimationCurve.Linear(0, 0, 1, 1)

Vector2 elevationRange = new Vector2(0, 100)

float penaltyScale = 10000

Inherited Public Members

int Hash

Pass

bool enabled = true

Private/Protected Members

NativeArray<float> elevationToPenalty