Skip to content

Game.Pathfind.SetupQueueItem

Assembly: Assembly-CSharp
Namespace: Game.Pathfind

Type: struct

Base: System.ValueType

Summary:
Represents a single entry placed into the pathfinding setup queue. Contains the requesting entity (owner), the pathfinding parameters that control how the path will be computed, and the origin and destination targets used by the pathfinding system to build a route. This struct is a lightweight value container intended to be enqueued and consumed by the pathfinding setup systems.

Fields

  • public Entity m_Owner
    The Entity that requested the pathfinding operation. This is typically used to identify which game object or simulation entity should receive the resulting path or follow-up messages.

  • public PathfindParameters m_Parameters
    Parameters that influence how the pathfinding should be performed (for example heuristics, allowed travel modes, costs, or other tuning options). The exact contents are defined by the PathfindParameters type in the pathfinding subsystem.

  • public SetupQueueTarget m_Origin
    The origin target for the pathfind. A SetupQueueTarget encodes the starting location and target-specific details (such as lane, segment, position or node) that the pathfinding system requires.

  • public SetupQueueTarget m_Destination
    The destination target for the pathfind. Similar to m_Origin, this encodes the end location and any details required to compute an accurate route.

Properties

  • None.
    This struct exposes only public fields and does not define properties.

Constructors

  • public SetupQueueItem(Entity owner, PathfindParameters parameters, SetupQueueTarget origin, SetupQueueTarget destination)
    Initializes a new SetupQueueItem with the provided owner, parameters, origin, and destination. All values are stored directly in the struct fields.

Methods

  • None.
    This struct is a plain data container and does not define any methods.

Usage Example

// Example: create a SetupQueueItem and enqueue it into a hypothetical setup queue.
Entity requester = /* obtain Entity that requested path */;
PathfindParameters parameters = new PathfindParameters {
    // set relevant pathfinding options here
};
SetupQueueTarget origin = new SetupQueueTarget(/* origin details */);
SetupQueueTarget destination = new SetupQueueTarget(/* destination details */);

SetupQueueItem item = new SetupQueueItem(requester, parameters, origin, destination);

// Enqueue into the pathfinding setup system (pseudo-code)
PathfindSetupQueue.Enqueue(item);