> For the complete documentation index, see [llms.txt](https://gley.gitbook.io/mobile-pedestrian-system/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gley.gitbook.io/mobile-pedestrian-system/complete-api.md).

# Complete API

All API methods are located inside Gley.PedestrianSystem.API

<table><thead><tr><th width="299" data-type="content-ref">API Name</th><th></th></tr></thead><tbody><tr><td><a href="/mobile-pedestrian-system/complete-api/addexcludedpedestriantosystem.md">AddExcludedPedestrianToSystem</a></td><td>Adds a previously excluded pedestrian back to the Pedestrian System.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/addpedestrian.md">AddPedestrian</a></td><td>Adds a pedestrian to the nearest waypoint from the provided position. </td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/addpedestrianwithdestination.md">AddPedestrianWithDestination</a></td><td>Adds a pedestrian to the nearest waypoint from the provided position and automatically sets a destination for it. </td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/addspecificpedestrian.md">AddSpecificPedestrian</a></td><td>Adds the pedestrian with the specified index to the nearest waypoint from the provided position.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/addpedestrianwithdestination.md">AddPedestrianWithDestination</a></td><td>Adds the pedestrian with the specified index to the nearest waypoint from the provided position and automatically sets a destination for it. </td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/disableareawaypoints.md">DisableAreaWaypoints</a></td><td>Disable all waypoints on the specified area.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/donotchangewaypoint.md">DoNotChangeWaypoint</a></td><td>Forbids a pedestrian to receive another waypoint. Useful for traffic lights.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/enableallwaypoints.md">EnableAllWaypoints</a></td><td>Enable all disabled area waypoints.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/excludepedestrianfromsystem.md">ExcludePedestrianFromSystem</a></td><td>An excluded pedestrian will never be instantiated by the system. Can be instantiated using API.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/getcrossingstate.md">GetCrossingState</a></td><td>Get the current state of a Street Crossing Component.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/getcurrentbehaviour.md">GetCurrentBehaviour</a></td><td>Get the current running behaviour of a pedestrian.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/getcurrentwaypointindex.md">GetCurrentWaypointIndex</a></td><td>Gets the index of the target waypoint of the pedestrian.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/getcurrentwaypointposition.md">GetCurrentWaypointPosition</a></td><td>Returns the position of the target waypoint of the pedestrian.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/getexcludedpedestrianlist.md">GetExcludedPedestrianList</a></td><td>Returns a list of all excluded pedestrians. Useful to manage the instantiation of specific pedestrians in specific locations.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/getnextwaypointposition.md">GetNextWaypointPosition</a></td><td>Returns the position of the next waypoint of the pedestrian.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/getpath.md">GetPath</a></td><td>Returns a waypoint path between a start position and an end position for a specific pedestrian type.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/getpathlength.md">GetPathLength</a></td><td>Get the number of waypoints included in the pedestrian path.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/getpedestrian.md">GetPedestrian</a></td><td>Convert the pedestrian index to the Pedestrian script.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/getpedestrianbehaviouroftype.md">GetPedestrianBehaviourOfType</a></td><td>Get a specific pedestrian behaviour. Useful to call additional methods or set parameters on that behaviour.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/getpreviouswaypointindex.md">GetPreviousWaypointIndex</a></td><td>Returns the index of the waypoint that the pedestrian just passed.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/getwaypointfromindex.md">GetWaypointFromIndex</a></td><td>Returns the PedestrianWaypoint object for a given waypoint index.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/getwaypointlist.md">GetWaypointList</a></td><td>Get the waypoint indexes that are included in the pedestrian path.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/initialize.md">Initialize</a></td><td>Initializes the entire Pedestrian System by adding all the necessary components before starting the Pedestrian System.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/insertpositionastarget.md">InsertPositionAsTarget</a></td><td>Insert a Vector3 position (which has no waypoint associated) as a target for a pedestrian. </td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/isinitialized.md">IsInitialized</a></td><td>Check if the Pedestrian System is initialized.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/iscurrentwaypointastopwaypoint.md">IsCurrentWaypointAStopWaypoint</a></td><td>Check if the current waypoint of the pedestrian has the stop property set to true.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/ispedestrianatthiswaypoint.md">IsPedestrianAtThisWaypoint</a></td><td>Verifies if a pedestrian has as a target a specific waypoint.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/pedestriansystemoptions.md">PedestrianSystemOptions</a></td><td>A properties class that is used to initialize the Pedestrian System.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/removepath.md">RemovePath</a></td><td>Remove a predefined path for a pedestrian. </td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/removepedestrian.md">RemovePedestrian</a></td><td>Remove a specific pedestrian from the scene bypassing the remove conditions of the Pedestrian System.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/removewaypointfrompath.md">RemoveWaypointFromPath</a></td><td>Removes a waypoint index from a pedestrian path. If the waypoint does not exist in the path, the method does nothing.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/requestnewwaypoint.md">RequestNewWaypoint</a></td><td>Force a waypoint request. This will make the pedestrian skip the current target.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/setallpedestriansbehaviours.md">SetAllPedestriansBehaviours</a></td><td>Change the complete behaviour list for all pedestrians. The old behaviours list will be overridden. </td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/setcamera.md">SetCamera</a></td><td>Update the active camera that is used to remove pedestrians when they are not in view.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/setcameras.md">SetCameras</a></td><td>Update active cameras that are used to remove pedestrians when they are not in view. This is used in multiplayer/split-screen setups.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/setcrossingstate.md">SetCrossingState</a></td><td>Set the state of a Street Crossing Component.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/setdestination.md">SetDestination</a></td><td>Calculates a path from the current position of the pedestrian to a specified destination. </td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/setpath.md">SetPath</a></td><td>A specific predefined path can be assigned to any active pedestrian within the Pedestrian System.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/setpedestrianbehaviours.md">SetPedestrianBehaviours</a></td><td>Change the complete beheviour list for a pedestrian. </td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/setpedestrianoffset.md">SetPedestrianOffset</a></td><td>Set the deviation between the waypoint that the pedestrian is using.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/startbehavior.md">StartBehavior</a></td><td>Start executing a specific behaviour.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/stopbehavior.md">StopBehavior</a></td><td>Stop executing a specific behaviour.</td></tr><tr><td><a href="/mobile-pedestrian-system/complete-api/triggercolliderremovedevent.md">TriggerColliderRemovedEvent</a></td><td> Remove an obstacle from the pedestrian obstacles list.</td></tr></tbody></table>
