Class CrowdGroupAuthoring
A single group that will navigate on the CrowdSurfaceAuthoring.
Inherited Members
Namespace: ProjectDawn.Navigation.Hybrid
Assembly: ProjectDawn.Navigation.Hybrid.dll
Syntax
[AddComponentMenu("Agents Navigation/Crowd/Crowd Group")]
[DisallowMultipleComponent]
[HelpURL("https://lukaschod.github.io/agents-navigation-docs/manual/crowds/crowd-group.html")]
public class CrowdGroupAuthoring : EntityBehaviour
Fields
| Improve this Doc View Sourcem_CostWeights
A single group that will navigate on the CrowdSurfaceAuthoring.
Declaration
[Tooltip("Controls the cost weights of constructing crowd flow fields.")]
[SerializeField]
protected CostWeights m_CostWeights
Field Value
| Type | Description |
|---|---|
| CostWeights |
m_GoalSource
A single group that will navigate on the CrowdSurfaceAuthoring.
Declaration
[Tooltip("Source from which crowd will get goal.")]
[SerializeField]
protected CrowdGoalSource m_GoalSource
Field Value
| Type | Description |
|---|---|
| CrowdGoalSource |
m_Grounded
A single group that will navigate on the CrowdSurfaceAuthoring.
Declaration
[Tooltip("Anchors the agent to the surface. It is useful to disable then used with physics, to allow more freedom motion and precision.")]
[SerializeField]
protected bool m_Grounded
Field Value
| Type | Description |
|---|---|
| bool |
m_MappingRadius
A single group that will navigate on the CrowdSurfaceAuthoring.
Declaration
[Tooltip("Maximum distance that will be used when attempting to map the agent's position or destination onto surface. The higher the value, the bigger the performance cost.")]
[SerializeField]
protected float m_MappingRadius
Field Value
| Type | Description |
|---|---|
| float |
m_Speed
A single group that will navigate on the CrowdSurfaceAuthoring.
Declaration
[Tooltip("Crowd group speed settings.")]
[SerializeField]
protected Speed m_Speed
Field Value
| Type | Description |
|---|---|
| Speed |
m_Surface
A single group that will navigate on the CrowdSurfaceAuthoring.
Declaration
[SerializeField]
protected CrowdSurfaceAuthoring m_Surface
Field Value
| Type | Description |
|---|---|
| CrowdSurfaceAuthoring |
Properties
| Improve this Doc View SourceCostWeight
Controls the cost weights of constructing crowd flow fields.
Declaration
public CostWeights CostWeight { get; set; }
Property Value
| Type | Description |
|---|---|
| CostWeights |
DefaultGroup
Returns default component of CrowdGroup.
Declaration
public CrowdGroup DefaultGroup { get; }
Property Value
| Type | Description |
|---|---|
| CrowdGroup |
EntityGroup
Accessing this property is potentially heavy operation as it will require wait for agent jobs to finish.
Declaration
public CrowdGroup EntityGroup { get; set; }
Property Value
| Type | Description |
|---|---|
| CrowdGroup |
GoalSource
Source from which crowd will get goal.
Declaration
public CrowdGoalSource GoalSource { get; set; }
Property Value
| Type | Description |
|---|---|
| CrowdGoalSource |
Grounded
Anchors the agent to the surface. It is useful to disable then used with physics, to allow more freedom motion and precision.
Declaration
public bool Grounded { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
HasEntityGroup
Returns true if EntityBehaviour entity has CrowdGroup.
Declaration
public bool HasEntityGroup { get; }
Property Value
| Type | Description |
|---|---|
| bool |
MappingRadius
Maximum distance that will be used when attempting to map the agent's position or destination onto surface. The higher the value, the bigger the performance cost.
Declaration
public float MappingRadius { get; set; }
Property Value
| Type | Description |
|---|---|
| float |
Speed
Crowd group speed settings.
Declaration
public Speed Speed { get; set; }
Property Value
| Type | Description |
|---|---|
| Speed |
Surface
A surface which will be used by this group.
Declaration
public CrowdSurfaceAuthoring Surface { get; }
Property Value
| Type | Description |
|---|---|
| CrowdSurfaceAuthoring |
Methods
| Improve this Doc View SourceSetGoals(ReadOnlySpan<float3>)
Set goals of crowds group. This method requires goal source to be set to Script.
Declaration
public void SetGoals(ReadOnlySpan<float3> goals)
Parameters
| Type | Name | Description |
|---|---|---|
| ReadOnlySpan<float3> | goals |
SetGoals(float3, float3)
Set goals of crowds group. This method requires goal source to be set to Script.
Declaration
public void SetGoals(float3 min, float3 max)
Parameters
| Type | Name | Description |
|---|---|---|
| float3 | min | |
| float3 | max |
SetSurface(CrowdSurfaceAuthoring)
Changes the surface. This is expensive operation.
Declaration
public void SetSurface(CrowdSurfaceAuthoring surface)
Parameters
| Type | Name | Description |
|---|---|---|
| CrowdSurfaceAuthoring | surface |