Class KaijuAreaMovement

KaijuMovement which looks for handling other KaijuAgents in a given area.

Inheritance

System.Object

KaijuMovement

KaijuAreaMovement

KaijuSeparationMovement

Inherited Members

KaijuMovement.DefaultWeight

KaijuMovement.OnStarted

KaijuMovement.OnStartedGlobal

KaijuMovement.OnStopped

KaijuMovement.OnStoppedGlobal

KaijuMovement.OnPerformed

KaijuMovement.OnPerformedGlobal

KaijuMovement.Agent

KaijuMovement.Weight

KaijuMovement.Initialize(KaijuAgent, Single)

KaijuMovement.Setup()

KaijuMovement.Move(Vector2, Single)

KaijuMovement.Started()

KaijuMovement.Stopped()

KaijuMovement.Performed()

KaijuMovement.Done()

KaijuMovement.Return()

KaijuMovement.EditorVisualize(Vector3)

KaijuMovement.EditorVisualizationColor()

Namespace: KaijuSolutions.Agents.Movement

Syntax

public abstract class KaijuAreaMovement : KaijuMovement

Constructors

KaijuAreaMovement(KaijuAgent, Single, ICollection<UInt32>, Single)

Get an area movement.

Declaration

public KaijuAreaMovement(KaijuAgent agent, float distance = 10F, ICollection<uint> identifiers = null, float weight = 1F)

Parameters

Type	Name	Description
KaijuAgent	agent	The KaijuAgent this is assigned to.
System.Single	distance	The distance to avoid other KaijuAgents from.
System.Collections.Generic.ICollection<System.UInt32>	identifiers	What types of KaijuAgents to avoid.
System.Single	weight	The weight of this KaijuMovement.

Fields

Identifiers

What types of KaijuAgents to avoid.

Declaration

public readonly HashSet<uint> Identifiers

Field Value

Type	Description
HashSet<System.UInt32>

Properties

Distance

The distance to interact with other KaijuAgents from.

Declaration

public float Distance { get; set; }

Property Value

Type	Description
System.Single

Methods

AddIdentifier(UInt32)

Add an identifier for KaijuAgents to interact with.

Declaration

public bool AddIdentifier(uint identifier)

Parameters

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

Returns

Type	Description
System.Boolean	If the identifier was added.

AddIdentifiers(ICollection<UInt32>)

Add identifiers for KaijuAgents to interact with.

Declaration

public bool AddIdentifiers(ICollection<uint> identifiers)

Parameters

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

Returns

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

ClearIdentifiers()

Clear all identifiers of KaijuAgents to interact with.

Declaration

public void ClearIdentifiers()

EditorRenderVisualizations(Vector3)

Render the visualization of the KaijuMovement. The position of the Agent.

Declaration

protected override void EditorRenderVisualizations(Vector3 position)

Parameters

Type	Name	Description
Vector3	position

Overrides

KaijuMovement.EditorRenderVisualizations(Vector3)

Initialize(KaijuAgent, Single, ICollection<UInt32>, Single)

Initialize the KaijuMovement.

Declaration

protected void Initialize(KaijuAgent agent, float distance = 10F, ICollection<uint> identifiers = null, float weight = 1F)

Parameters

Type	Name	Description
KaijuAgent	agent	The KaijuAgent this is assigned to.
System.Single	distance	The distance to avoid other KaijuAgents from.
System.Collections.Generic.ICollection<System.UInt32>	identifiers	What types of KaijuAgents to avoid.
System.Single	weight	The weight of this KaijuMovement.

RemoveIdentifier(UInt32)

Remove an identifier for KaijuAgents to interact with.

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(ICollection<UInt32>)

Remove identifiers for KaijuAgents to interact with.

Declaration

public bool RemoveIdentifiers(ICollection<uint> identifiers)

Parameters

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

Returns

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

Reset()

Perform any needed reset operations.

Declaration

protected override void Reset()

Overrides

KaijuMovement.Reset()

SetIdentifier(UInt32)

Set the identifier of KaijuAgents to interact with.

Declaration

public void SetIdentifier(uint identifier)

Parameters

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

SetIdentifiers(ICollection<UInt32>)

Set the identifier of KaijuAgents to interact with.

Declaration

public void SetIdentifiers(ICollection<uint> identifiers)

Parameters

Type	Name	Description
System.Collections.Generic.ICollection<System.UInt32>	identifiers	The identifiers to set.