Class KaijuMovementConfiguration

Allow for defining KaijuMovement settings for KaijuAgents to use as default values.

Inheritance

System.Object

KaijuMovementConfiguration

Namespace: KaijuSolutions.Agents.Movement

Syntax

public class KaijuMovementConfiguration : ScriptableObject

Fields

areaMask

The default bitfield mask specifying which navigation mesh areas can be used for the path.

Declaration

public int areaMask

Field Value

Type	Description
System.Int32

avoidanceAngle

The default angle for rays.

Declaration

public float avoidanceAngle

Field Value

Type	Description
System.Single

avoidanceHeight

The default height offset for the rays.

Declaration

public float avoidanceHeight

Field Value

Type	Description
System.Single

avoidanceHorizontal

The default horizontal shift for the side rays.

Declaration

public float avoidanceHorizontal

Field Value

Type	Description
System.Single

clear

The default behaviour for if new KaijuMovements should clear all other current KaijuMovements and become the only one the KaijuAgent is performing.

Declaration

public bool clear

Field Value

Type	Description
System.Boolean

collisionMask

The default layers to use for KaijuPathFollowMovement string-pulling and KaijuObstacleAvoidanceMovement.

Declaration

public LayerMask collisionMask

Field Value

Type	Description
LayerMask

collisionTriggers

How string-pulling should consider triggers by default.

Declaration

public QueryTriggerInteraction collisionTriggers

Field Value

Type	Description
QueryTriggerInteraction

DefaultMask

The default collision layer mask.

Declaration

public const int DefaultMask = -5

Field Value

Type	Description
System.Int32

Properties

ApproachingDistance

The default distance at which we can consider KaijuSeekMovement, KaijuPursueMovement, and KaijuPathFollowMovement behaviours done.

Declaration

public float ApproachingDistance { get; set; }

Property Value

Type	Description
System.Single

Avoidance

The default distance from a wall the KaijuAgent should maintain.

Declaration

public float Avoidance { get; set; }

Property Value

Type	Description
System.Single

AvoidanceDistance

The default distance for rays.

Declaration

public float AvoidanceDistance { get; set; }

Property Value

Type	Description
System.Single

AvoidanceSideDistance

The default distance of the side rays. Zero or less will use the AvoidanceDistance.

Declaration

public float AvoidanceSideDistance { get; set; }

Property Value

Type	Description
System.Single

Identifiers

Identifiers for KaijuAgents when separating.

Declaration

public IReadOnlyList<uint> Identifiers { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<System.UInt32>

LeavingDistance

The default distance at which we can consider KaijuFleeMovement and KaijuEvadeMovement behaviours done.

Declaration

public float LeavingDistance { get; set; }

Property Value

Type	Description
System.Single

PathAutoCalculateDistance

The default distance to automatically recalculate the path from.

Declaration

public float PathAutoCalculateDistance { get; set; }

Property Value

Type	Description
System.Single

SeparationCoefficient

The default distance to interact with other KaijuAgents from.

Declaration

public float SeparationCoefficient { get; set; }

Property Value

Type	Description
System.Single

SeparationDistance

The default distance to interact with other KaijuAgents from.

Declaration

public float SeparationDistance { get; set; }

Property Value

Type	Description
System.Single

WanderDistance

How far out to generate the KaijuWanderMovement circles by default.

Declaration

public float WanderDistance { get; set; }

Property Value

Type	Description
System.Single

WanderRadius

The radius of the KaijuWanderMovement circles by default.

Declaration

public float WanderRadius { get; set; }

Property Value

Type	Description
System.Single

Weight

The default weight of all KaijuMovements.

Declaration

public float Weight { get; set; }

Property Value

Type	Description
System.Single

Methods

AddIdentifier(UInt32)

Add an identifier to this agent.

Declaration

public bool AddIdentifier(uint identifier)

Parameters

Type	Name	Description
System.UInt32	identifier	The identifier to set.

Returns

Type	Description
System.Boolean	If the identifier was added.

AddIdentifiers(IEnumerable<UInt32>)

Add identifiers to this agent.

Declaration

public bool AddIdentifiers(IEnumerable<uint> collection)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.UInt32>	collection	The identifiers to add.

Returns

Type	Description
System.Boolean	If any of the identifiers were added.

ClearIdentifiers()

Clear all identifiers.

Declaration

public void ClearIdentifiers()

HasAnyIdentifier(IEnumerable<UInt32>)

If this agent has any one of a set of identifiers.

Declaration

public bool HasAnyIdentifier(IEnumerable<uint> collection)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.UInt32>	collection	The identifiers to check.

Returns

Type	Description
System.Boolean	If this agent has any one of a set of identifiers.

HasIdentifier(UInt32)

If this agent has an identifier.

Declaration

public bool HasIdentifier(uint identifier)

Parameters

Type	Name	Description
System.UInt32	identifier	The identifier to check.

Returns

Type	Description
System.Boolean	If this agent has the identifier.

RemoveIdentifier(UInt32)

Remove an identifier from this agent.

Declaration

public bool RemoveIdentifier(uint identifier)

Parameters

Type	Name	Description
System.UInt32	identifier	The identifier to remove.

Returns

Type	Description
System.Boolean	If the identifier was removed.

RemoveIdentifiers(IEnumerable<UInt32>)

Remove identifiers from this agent.

Declaration

public bool RemoveIdentifiers(IEnumerable<uint> collection)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.UInt32>	collection	The identifiers to remove.

Returns

Type	Description
System.Boolean	If any of the identifiers were removed.

SetIdentifier(UInt32)

Set an identifier to this agent.

Declaration

public void SetIdentifier(uint identifier)

Parameters

Type	Name	Description
System.UInt32	identifier	The identifier to set.

SetIdentifiers(IEnumerable<UInt32>)

If this agent has any one of a set of identifiers.

Declaration

public void SetIdentifiers(IEnumerable<uint> collection)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.UInt32>	collection	The identifiers to check.