diff --git a/.gitignore b/.gitignore index 96cbdcdb..685cb37e 100644 --- a/.gitignore +++ b/.gitignore @@ -90,4 +90,6 @@ crashlytics-build.properties # Files generated by documentation tool /Assets/Virtual Agents Framework/Editor/Scripts/Behaviour Tree/obj -/Assets/Virtual Agents Framework/Editor/Scripts/Behaviour Tree/obj.meta \ No newline at end of file +/Assets/Virtual Agents Framework/Editor/Scripts/Behaviour Tree/obj.meta +/Assets/Automation/obj +/Assets/Automation/obj.meta diff --git a/Assets/Virtual Agents Framework/Runtime/Scripts/ScheduleBasedExecution/AgentTaskManager.cs b/Assets/Virtual Agents Framework/Runtime/Scripts/ScheduleBasedExecution/AgentTaskManager.cs index eb223ad0..c0bd4eca 100644 --- a/Assets/Virtual Agents Framework/Runtime/Scripts/ScheduleBasedExecution/AgentTaskManager.cs +++ b/Assets/Virtual Agents Framework/Runtime/Scripts/ScheduleBasedExecution/AgentTaskManager.cs @@ -267,7 +267,7 @@ public void RemoveTask(IAgentTask task) /// /// Aborts the current task - /// public void Abort() { if (CurrentTask != null) diff --git a/Documentation/manual/quickstart-guide.md b/Documentation/manual/quickstart-guide.md index 4708baf9..0efac7a3 100644 --- a/Documentation/manual/quickstart-guide.md +++ b/Documentation/manual/quickstart-guide.md @@ -47,13 +47,14 @@ At this point it is recommended to take a look at the samples provided with the 4. On the right side, expand the samples section. Here, you can find a list of available examples. 5. Click the import button to download the samples. - They are saved in your Assets folder in a folder ``Samples/Virtual Agents Framework/1.2.0``. Every sample provides one or more documentation object that explains how the scene and the functions behind that scene work, and also links to recommended manual pages here. + They are saved in your Assets folder in a folder ``Samples/Virtual Agents Framework/{version}``. +1. Every sample provides one or more documentation object that explains how the scene and the functions behind that scene work, and also links to recommended manual pages here. Going from least to most complex, it is recommended to look at the samples in the following order: 1. Navigation Sample 2. Wait Sample 3. Dynamic Navigation Sample -4. Rotation Sample ([manual page](rotation.md) +4. Rotation Sample ([manual page](rotation.md)) 5. Audio Sample ([manual page](audio.md)) 6. TaskBundle Sample ([manual page](task-bundle.md)) 7. Parallel Task Sample ([manual page](parallel-tasks.md)) diff --git a/Documentation/manual/rotation.md b/Documentation/manual/rotation.md index 82ee03b0..cfb3663f 100644 --- a/Documentation/manual/rotation.md +++ b/Documentation/manual/rotation.md @@ -7,7 +7,7 @@ The constructor using the angle parameter has an extra boolean parameter `isRota This is set to `True` by default. To then use the task, schedule it as usual. This illustration shows the difference between rotating _towards_ and _by_ an angle: -![3 part illustration: First the initial position is shown, with the agent looking towards the 0° world coordinate angle. Then the agent rotates by 90°, thus also looking towards the 90° world coordinate angle. The last step is split in two: When the agent rotates by 180°, he looks towards 270° in terms of world coordinates. In contrast when he turns towards 180°, he turns by 90°.](rotation_illustration.svg) +![3 part illustration: First the initial position is shown, with the agent looking towards the 0° world coordinate angle. Then the agent rotates by 90°, thus also looking towards the 90° world coordinate angle. The last step is split in two: When the agent rotates by 180°, he looks towards 270° in terms of world coordinates. In contrast when he turns towards 180°, he turns by 90°.](../resources/rotation_illustration.svg) Example: ```csharp diff --git a/Documentation/manual/toc.yml b/Documentation/manual/toc.yml index 663e2899..0ae31e32 100644 --- a/Documentation/manual/toc.yml +++ b/Documentation/manual/toc.yml @@ -6,14 +6,22 @@ href: task-system.md - name: Parallel Tasks href: parallel-tasks.md - - name: Items - href: items.md - - name: Adaptive Gaze - href: adaptive-gaze.md - - name: Aiming and Pointing - href: aiming.md - name: TaskBundles href: task-bundle.md + - name: Tasks + items: + - name: Adaptive Gaze + href: adaptive-gaze.md + - name: Aiming and Pointing + href: aiming.md + - name: Audio + href: audio.md + - name: Item Pick Up + href: items.md + - name: Rotation + href: rotation.md + - name: Sitting + href: sitting.md - name: Customization items: - name: Adding Own Agent Models and Animations diff --git a/Documentation/manual/rotation_illustration.svg b/Documentation/resources/rotation_illustration.svg similarity index 100% rename from Documentation/manual/rotation_illustration.svg rename to Documentation/resources/rotation_illustration.svg