From 8cc67f0d58691775092f4fa795799cc53921c33d Mon Sep 17 00:00:00 2001 From: Christopher Date: Tue, 20 Sep 2016 16:05:29 +0100 Subject: [PATCH] Tidied up page structure --- Docs/conduct/index.md | 5 ++-- Docs/event_handlers/core_events.md | 11 -------- Docs/event_handlers/input_events.md | 8 ------ Docs/event_handlers/sprite_events.md | 40 ---------------------------- Docs/event_handlers/ui_events.md | 14 ---------- Docs/mainpage.md | 4 ++- Docs/training_course/index.md | 2 +- 7 files changed, 7 insertions(+), 77 deletions(-) delete mode 100644 Docs/event_handlers/core_events.md delete mode 100644 Docs/event_handlers/input_events.md delete mode 100644 Docs/event_handlers/sprite_events.md delete mode 100644 Docs/event_handlers/ui_events.md diff --git a/Docs/conduct/index.md b/Docs/conduct/index.md index 8fc7abe6..53df4dc8 100644 --- a/Docs/conduct/index.md +++ b/Docs/conduct/index.md @@ -1,7 +1,8 @@ -# TL;DR +# Code of conduct {#code_of_conduct} + +## TL;DR Be nice to each other :) -# Code of conduct We want an open and respectful community at Fungus. So we would ask you when communicating (for example, posting on our Forums, Comments or github repository ) to be friendly and helpful. We find, for most people, this is not a problem. Our list of guidelines below is not exhaustive but should give a strong indication of what we consider acceptable community behaviour. ## Be welcoming diff --git a/Docs/event_handlers/core_events.md b/Docs/event_handlers/core_events.md deleted file mode 100644 index 6fcb67c2..00000000 --- a/Docs/event_handlers/core_events.md +++ /dev/null @@ -1,11 +0,0 @@ -## Flowchart Enabled -The block will execute when the Flowchart game object is enabled. -## Game Started -The block will execute when the game starts playing. -## Message Received -The block will execute when the specified message is received from a Send Message command. - -Property | Type | Description - --- | --- | --- -Message | System.String | Fungus message to listen for - diff --git a/Docs/event_handlers/input_events.md b/Docs/event_handlers/input_events.md deleted file mode 100644 index 62d53893..00000000 --- a/Docs/event_handlers/input_events.md +++ /dev/null @@ -1,8 +0,0 @@ -## Key Pressed -The block will execute when a key press event occurs. - -Property | Type | Description - --- | --- | --- -Key Press Type | Fungus.EventHandlers.KeyPressType | The type of keypress to activate on -Key Code | UnityEngine.KeyCode | Keycode of the key to activate on - diff --git a/Docs/event_handlers/sprite_events.md b/Docs/event_handlers/sprite_events.md deleted file mode 100644 index b5c0bab4..00000000 --- a/Docs/event_handlers/sprite_events.md +++ /dev/null @@ -1,40 +0,0 @@ -## Drag Cancelled -The block will execute when the player drags an object and releases it without dropping it on a target object. - -Property | Type | Description - --- | --- | --- -Draggable Object | Fungus.Draggable2D | Draggable object to listen for drag events on - -## Drag Completed -The block will execute when the player drags an object and successfully drops it on a target object. - -Property | Type | Description - --- | --- | --- -Draggable Object | Fungus.Draggable2D | Draggable object to listen for drag events on -Target Object | UnityEngine.Collider2D | Drag target object to listen for drag events on - -## Drag Entered -The block will execute when the player is dragging an object which starts touching the target object. - -Property | Type | Description - --- | --- | --- -Draggable Object | Fungus.Draggable2D | Draggable object to listen for drag events on -Target Object | UnityEngine.Collider2D | Drag target object to listen for drag events on - -## Drag Exited -The block will execute when the player is dragging an object which stops touching the target object. - -Property | Type | Description - --- | --- | --- -Draggable Object | Fungus.Draggable2D | Draggable object to listen for drag events on -Target Object | UnityEngine.Collider2D | Drag target object to listen for drag events on - -## Drag Started -The block will execute when the player starts dragging an object. -## Object Clicked -The block will execute when the user clicks or taps on the clickable object. - -Property | Type | Description - --- | --- | --- -Clickable Object | Fungus.Clickable2D | Object that the user can click or tap on - diff --git a/Docs/event_handlers/ui_events.md b/Docs/event_handlers/ui_events.md deleted file mode 100644 index 15813283..00000000 --- a/Docs/event_handlers/ui_events.md +++ /dev/null @@ -1,14 +0,0 @@ -## Button Clicked -The block will execute when the user clicks on the target UI button object. - -Property | Type | Description - --- | --- | --- -Target Button | UnityEngine.UI.Button | The UI Button that the user can click on - -## End Edit -The block will execute when the user finishes editing the text in the input field. - -Property | Type | Description - --- | --- | --- -Target Input Field | UnityEngine.UI.InputField | The UI Input Field that the user can enter text into - diff --git a/Docs/mainpage.md b/Docs/mainpage.md index 57bccc5d..9da95e72 100644 --- a/Docs/mainpage.md +++ b/Docs/mainpage.md @@ -5,6 +5,7 @@ Welcome to the documentation website for Fungus, the open source visual storytel The main website for Fungus and [community forum](http://fungusgames.com/forum) are available at [FungusGames.com](http://fungusgames.com). * @subpage about +* @subpage training_course * @subpage download * @subpage getting_started * @subpage flowcharts @@ -13,9 +14,10 @@ The main website for Fungus and [community forum](http://fungusgames.com/forum) * @subpage playing_audio * @subpage conversation * @subpage articles +* @subpage narrative_tags * @subpage glossary * @subpage faq -* @subpage narrative_tags +* @subpage code_of_conduct # Overview diff --git a/Docs/training_course/index.md b/Docs/training_course/index.md index 3a20ec61..ab978834 100644 --- a/Docs/training_course/index.md +++ b/Docs/training_course/index.md @@ -1,4 +1,4 @@ -# Fungus Training Course +# Fungus Training Course {#training_course}