Skip to content

Commit c19687e

Browse files
authored
Merge pull request #50 from ExtendRealityLtd/fix/apply-doc-styling
fix(HowToGuides): apply document styling guidelines
2 parents 9f246a2 + db15d1f commit c19687e

4 files changed

Lines changed: 12 additions & 11 deletions

File tree

  • Documentation/HowToGuides

Documentation/HowToGuides/ConvertingAFloatActionToABooleanAction/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ Create a new `Cube` Unity 3D Object by selecting `Main Menu -> GameObject -> 3D
3030

3131
### Step 2
3232

33-
Expand the `Tilia Input UnityInputManager` Package directory in the Unity Project window and select then `Packages -> Tilia Input UnityInputManager -> Runtime -> Prefabs -> Actions` directory then drag and drop the `Input.UnityInputManager.Axis1DAction` prefab into the Hierarchy window.
33+
Expand the `Tilia Input UnityInputManager` package directory in the Unity Project window and select then `Packages -> Tilia Input UnityInputManager -> Runtime -> Prefabs -> Actions` directory then drag and drop the `Input.UnityInputManager.Axis1DAction` prefab into the Unity Hierarchy window.
3434

3535
> Be sure to use the `Input.UnityInputManager.Axis1DAction` prefab and not just add the `Unity Input Manager Axis 1D Action` component to a GameObject as the component needs linking to a `MomentProcessor` to function.
3636
3737
![Drag Axis1DActionAction To Hierarchy](assets/images/DragAxis1DActionActionToHierarchy.png)
3838

3939
### Step 3
4040

41-
Select the `Input.UnityInputManager.Axis1DAction` GameObject in the Hierarchy window and change the `Axis Name` parameter on the `Unity Input Manager Axis 1D Action` component to listen for the desired axis, in this case enter `Tilia.Input.UnityInputManager_Axis9` to listen for the Left Trigger axis on an Xbox Controller.
41+
Select the `Input.UnityInputManager.Axis1DAction` GameObject in the Unity Hierarchy window and change the `Axis Name` parameter on the `Unity Input Manager Axis 1D Action` component to listen for the desired axis, in this case enter `Tilia.Input.UnityInputManager_Axis9` to listen for the Left Trigger axis on an Xbox Controller.
4242

4343
![Change Axis Name To Axis9](assets/images/ChangeAxisNameToAxis9.png)
4444

Documentation/HowToGuides/CreatingProxyActionsAndChainingActions/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ The [Zinnia] Actions can be used as proxies to enable chaining of Actions to all
1414

1515
Following on from the scene created in [Using The Unity Button Action], we’re going to move the Action functionality to a Proxy Action and then chain the button press Action and keyboard Action to this newly created Proxy Action. This will move our output functionality into one place and allow us to call it from many different actions.
1616

17-
### Prerequistes
17+
### Prerequisites
1818

19-
* [Add the Tilia.Input.UnityInputManager.ButtonAction] prefab to the scene Hierarchy.
19+
* [Add the Tilia.Input.UnityInputManager -> Input.UnityInputManager.ButtonAction] prefab to the scene hierarchy.
2020

2121
## Let's Start
2222

2323
### Step 1
2424

25-
Create an empty `GameObject` in the Unity Hierarchy and rename it to `FloorToggler` then click the `Add Component` button and select the `Boolean Action` component.
25+
Create an empty `GameObject` in the Unity Hierarchy window and rename it to `FloorToggler` then click the `Add Component` button and select the `Boolean Action` component.
2626
This newly created `Boolean Action` will be the action that defines how we toggle the active state of the `Floor` GameObject.
2727

2828
![Creating The Floor Toggler](assets/images/CreatingTheFloorToggler.png)
@@ -88,5 +88,6 @@ This ability to create a Proxy Action and then chain other Actions makes it poss
8888
Play the Unity scene and you will be able to press the Space Key to make the `Floor` GameObject disappear or you can press the Xbox Controller Button A to also make the `Floor` GameObject disappear.
8989

9090
[Zinnia]: https://github.com/ExtendRealityLtd/Zinnia.Unity
91-
[Add the Tilia.Input.UnityInputManager.ButtonAction]: ../UsingTheUnityButtonAction/README.md
91+
[Using The Unity Button Action]: ../UsingTheUnityButtonAction/README.md
92+
[Add the Tilia.Input.UnityInputManager -> Input.UnityInputManager.ButtonAction]: ../UsingTheUnityButtonAction/README.md
9293
[Step 2]: #Step-2

Documentation/HowToGuides/UsingTheUnityAxisAction/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ We will utilize a 1D axis action to control the position of this sphere in the s
2828

2929
### Step 2
3030

31-
Expand the `Tilia Input UnityInputManager` Package directory in the Unity Project window and select then `Packages -> Tilia Input UnityInputManager -> Runtime -> Prefabs -> Actions` directory then drag and drop the `Input.UnityInputManager.1DAxisAction` prefab into the Hierarchy window.
31+
Expand the `Tilia Input UnityInputManager` package directory in the Unity Project window and select then `Packages -> Tilia Input UnityInputManager -> Runtime -> Prefabs -> Actions` directory then drag and drop the `Input.UnityInputManager.1DAxisAction` prefab into the Unity Hierarchy window.
3232

3333
> Be sure to use the `Input.UnityInputManager.1DAxisAction` prefab and not just add the `Unity Input Manager Axis 1D Action` component to a GameObject as the component needs linking to a `MomentProcessor` to function.
3434
@@ -42,7 +42,7 @@ There are many different supported axes depending on the input peripheral being
4242

4343
The Unity software also has 2 default axis values called `Horizontal` and `Vertical` which map to the arrows on the keyboard and the standard joystick movement of an input peripheral.
4444

45-
Select the `Input.UnityInputManager.1DAxisAction` GameObject in the Hierarchy window and update the `Axis Name` parameter on the `Unity Input Manager Axis 1D Action` component to listen changes on the specified axis, in this case type `Horizontal` to listen for changes on the default horizontal axis definition within the Unity Input Manager definitions.
45+
Select the `Input.UnityInputManager.1DAxisAction` GameObject in the Unity Hierarchy window and update the `Axis Name` parameter on the `Unity Input Manager Axis 1D Action` component to listen changes on the specified axis, in this case type `Horizontal` to listen for changes on the default horizontal axis definition within the Unity Input Manager definitions.
4646

4747
![Change Axis Name To Horizontal](assets/images/ChangeAxisNameToHorizontal.png)
4848

Documentation/HowToGuides/UsingTheUnityButtonAction/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ This will form the basic floor of the scene world and provide a way of testing a
3131

3232
### Step 2
3333

34-
Expand the `Tilia Input UnityInputManager` Package directory in the Unity Project window and select then `Packages -> Tilia Input UnityInputManager -> Runtime -> Prefabs -> Actions` directory then drag and drop the `Input.UnityInputManager.ButtonAction` prefab into the Hierarchy window.
34+
Expand the `Tilia Input UnityInputManager` package directory in the Unity Project window and select then `Packages -> Tilia Input UnityInputManager -> Runtime -> Prefabs -> Actions` directory then drag and drop the `Input.UnityInputManager.ButtonAction` prefab into the Unity Hierarchy window.
3535

3636
> Be sure to use the `Input.UnityInputManager.ButtonAction` prefab and not just add the `Unity Input Manager Button Action` component to a GameObject as the component needs linking to a `MomentProcessor` to function.
3737
3838
![Drag ButtonAction To Hierarchy](assets/images/DragButtonActionToHierarchy.png)
3939

4040
### Step 3
4141

42-
Select the `Input.UnityInputManager.ButtonAction` GameObject in the Hierarchy window and change the `Key Code` parameter on the `Unity Input Manager Button Action` component to listen for the desired key press, in this case select `Space` to listen for the press of the Spacebar on the keyboard.
42+
Select the `Input.UnityInputManager.ButtonAction` GameObject in the Unity Hierarchy window and change the `Key Code` parameter on the `Unity Input Manager Button Action` component to listen for the desired key press, in this case select `Space` to listen for the press of the Spacebar on the keyboard.
4343

4444
![Change KeyCode To Space](assets/images/ChangeKeyCodeToSpace.png)
4545

@@ -75,7 +75,7 @@ Play the Unity scene and press the Spacebar on the keyboard and the `Floor` Game
7575

7676
Let's use one the `Controller Mapping` prefabs to do the same action as outlined above but based on a controller press.
7777

78-
Expand the `Tilia Input UnityInputManager` Package directory in the Unity Project window and select then `Packages -> Tilia Input UnityInputManager -> Runtime -> Prefabs -> Controller Mappings` directory then drag and drop the `Input.UnityInputManager.XboxController` prefab into the Hierarchy window.
78+
Expand the `Tilia Input UnityInputManager` Package directory in the Unity Project window and select then `Packages -> Tilia Input UnityInputManager -> Runtime -> Prefabs -> Controller Mappings` directory then drag and drop the `Input.UnityInputManager.XboxController` prefab into the Unity Hierarchy window.
7979

8080
![Drag Xbox Controller Mapping To Hierarchy](assets/images/DragXboxControllerMappingToHierarchy.png)
8181

0 commit comments

Comments
 (0)