Paththrough

Omni-Bot_Map_Scripting

Paththrough

In Omni-bot versions prior to 0.7, the bots had no concept of using a mover (such as a tram or an elevator) as a means to get to a certain location. The bots could be scripted to use them, but at the cost of completely overriding their built-in navigation via script. More or less the same was true for switches: using a switch was a goal in itself and not part of the path finding, as it sometimes should be, for example if the switch controls an elevator or a door.

In Omni-bot 0.7+ a feature called paththrough deals with this type of requirement. It has to be set up both in the waypoint file and in the script. Basically, when a bot reaches a waypoint whose paththrough property is set to a valid value, its normal movement towards the next waypoint in the path is overridden by the script. For example, upon reaching a waypoint at a switch that opens a door, the bots can be instructed to press the switch and wait for the door to open, and move along their path normally afterwards.

As of now, there are three types of paththrough:

• Paththrough Navigation
• Paththrough RideMovers
• Paththrough UseSwitch

Only one paththrough can be active at any time. Paththrough functions run as LowLevel goal.

Helpful commands:

/bot waypoint_showproperty                prints the current properties in the console,
/bot waypoint_clearproperty paththrough   will remove the paththrough property.