Player Path Tool: Difference between revisions

From Off Grid Wiki
Jump to navigation Jump to search
(Created page with "== Introduction == The player path tool is a simple tool to create multiples lines with various points, giving a visual aid for creating levels, helping the visualization of...")
 
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 5: Line 5:
== How to use it ==
== How to use it ==


To getting started, it's only needed to drag the tool prefab in the wanted scene. The prefab is located in 'Assets/LevelKit/Tools/PlayerPathTool.prefab'.
Drag the Player Path Tool into your scene. The prefab is located in 'Assets/LevelKit/Tools/PlayerPathTool.prefab'.


You can add new points in the path just by clicking on the wanted location in the scene window, but first, a path must be selected (a path can be created in the 'Add new path' button).
The player Path Tool has automatically created a new path called PlayerPath_0:


[[File:PPT NewPath.png|thumb|left]]


[[File:PlayerPathToolInTheScene.png]]


To select a point click on the blue button, to select multiple points hold the spacebar and select the wanted points. When a point is selected you can have access in the following functionalities:


* Change the points position with the position handle
* Remove the selected point on the red button
* Add a new point near the selected point on the green button


== Inspector UI ==


[[File:PlayerPathToolInspector.png]]


==== Path Mode ====


This tool have various modes that can be selected, they're the follow:


* '''Default''' : All the UI and functionalities are enabled
* '''UI Only On Selected Path''' : Is only shown the UI of the selected path
* '''UI Disabled''' : All the UI is disabled in the scene, expect the path line
* '''Add Points Disabled''' : Disabled the creation of new points
* '''Disabled''' : Everything is disabled, expect the path line


==== Default Path Color ====


It's the default path color when a new path it's created.


==== Paths ====


This field has all the path points information, like the position of the points, so that can be used for debugging reasons.


==== Default GUI Style ====


It's the GUI Style used for the optional points text.


=== Options ===
== LOCK YOU TOOL ==


==== Add new path ====
'''PLEASE NOTE:''' When the Player Path Tool is unlocked it will create a Path Point any time that you click in the scene view - which can unintentionally create a mess of path points in your scenes! Remember to use the Lock button whenever you are not using the Player Path Tool.


This tool can contain various paths, to do that this button can add them.
[[File:PPT Lock.png|thumb|left]]


=== Selected Path ===


The first parameter indicates the path selected, it can be changed in the dropdown list. Followed by that is the Remove Button, as the names imply, it removes the selected path. The following fields are:


* '''Name''' : path name
 
* '''Color''' : path line color
 
* '''Text''' '''points''' : show all the path points text if it exists, the text style is determined by the 'Default GUI Style'
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
== Creating Points ==
 
Clicking in scene will create points (if the tool is Unlocked). To visualise the Path you have created, make sure Full Path is Visible is Enabled in the inspector. There are various other visibility settings here you can change. Selecting a point will show you it's number in the sequence.
[[File:PPT APath.png|thumb|left|A path in scene]]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Once points are created they will populate in the Paths dropdown.
 
[[File:PPT points.png|thumb|left|PPT points]]
 
 
 
 
 
 
 
 
 
 
 
Lower in the Editor open the dropdown called '''Path Details''' See image. Here you can type in text - useful for making gameplay notes or leaving messages for your team. For example "Door interaction here" or "Guard Patrol" etc.
 
 
 
 
 
 
 
 
 
 
 
[[File:PPT Text.png|thumb|left|PPT - Text]]
 
 
 
These notes will populate in scene. See image.
 
 
 
 
 
 
 
 
 
 
 
 
 
== Add New Path ==
You can have multiple paths in scene, this is useful for blocking out different puzzles, planning player routes, figuring out guard patrols etc.

Latest revision as of 13:42, 27 March 2024

Introduction

The player path tool is a simple tool to create multiples lines with various points, giving a visual aid for creating levels, helping the visualization of the possible paths that the player can go through the level.

How to use it

Drag the Player Path Tool into your scene. The prefab is located in 'Assets/LevelKit/Tools/PlayerPathTool.prefab'.

The player Path Tool has automatically created a new path called PlayerPath_0:








LOCK YOU TOOL

PLEASE NOTE: When the Player Path Tool is unlocked it will create a Path Point any time that you click in the scene view - which can unintentionally create a mess of path points in your scenes! Remember to use the Lock button whenever you are not using the Player Path Tool.

















Creating Points

Clicking in scene will create points (if the tool is Unlocked). To visualise the Path you have created, make sure Full Path is Visible is Enabled in the inspector. There are various other visibility settings here you can change. Selecting a point will show you it's number in the sequence.

A path in scene










Once points are created they will populate in the Paths dropdown.

PPT points






Lower in the Editor open the dropdown called Path Details See image. Here you can type in text - useful for making gameplay notes or leaving messages for your team. For example "Door interaction here" or "Guard Patrol" etc.






PPT - Text


These notes will populate in scene. See image.







Add New Path

You can have multiple paths in scene, this is useful for blocking out different puzzles, planning player routes, figuring out guard patrols etc.