pandemonium_engine/modules/steering_ai/doc_classes/GSAIFollowPath.xml

30 lines
1.2 KiB
XML
Raw Normal View History

2023-01-14 13:38:58 +01:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-08-26 22:41:21 +02:00
<class name="GSAIFollowPath" inherits="GSAIArrive" version="4.1">
2023-01-14 13:38:58 +01:00
<brief_description>
Produces a linear acceleration that moves the agent along the specified path.
2023-01-14 13:38:58 +01:00
</brief_description>
<description>
Produces a linear acceleration that moves the agent along the specified path.
2023-01-14 13:38:58 +01:00
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="is_arrive_enabled" type="bool" setter="set_is_arrive_enabled" getter="get_is_arrive_enabled" default="true">
Whether to use GSAIArrive behavior on an open path.
2023-01-14 13:38:58 +01:00
</member>
<member name="path" type="GSAIPath" setter="set_path" getter="get_path">
The path to follow and travel along.
2023-01-14 13:38:58 +01:00
</member>
<member name="path_offset" type="float" setter="set_path_offset" getter="get_path_offset" default="0.0">
The distance along the path to generate the next target position.
2023-01-14 13:38:58 +01:00
</member>
<member name="prediction_time" type="float" setter="set_prediction_time" getter="get_prediction_time" default="0.0">
The amount of time in the future to predict the owning agent's position along the path. Setting it to 0.0 will force non-predictive path following.
2023-01-14 13:38:58 +01:00
</member>
</members>
<constants>
</constants>
</class>