Skip to content

Commit

Permalink
chore(Pointer): update pointer direction indicator documentation
Browse files Browse the repository at this point in the history
The documentation for the Pointer Direction Indicator prefab script was
incorrect and still mentioned that the prefab was to be placed on the
VRTK_Pointer script, whereas this has now been changed so it is a
reference on the VRTK_BasePointerRenderer script.
  • Loading branch information
thestonefox committed Jul 16, 2017
1 parent 7aee0d6 commit 881e6ec
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ namespace VRTK
/// The Pointer Direction Indicator is used to determine a given world rotation that can be used by a Destiantion Marker.
/// </summary>
/// <remarks>
/// The Pointer Direction Indicator can be attached to a VRTK_Pointer in the `Direction Indicator` parameter and will the be used to send rotation data when the destination marker events are emitted.
/// The Pointer Direction Indicator can be attached to a VRTK_BasePointerRenderer in the `Direction Indicator` parameter and will the be used to send rotation data when the destination marker events are emitted.
///
/// This can be useful for rotating the play area upon teleporting to face the user in a new direction without expecting them to physically turn in the play space.
/// </remarks>
Expand Down
2 changes: 1 addition & 1 deletion DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -745,7 +745,7 @@ The ResetDestinationPoint resets the destination point back to the default state

The Pointer Direction Indicator is used to determine a given world rotation that can be used by a Destiantion Marker.

The Pointer Direction Indicator can be attached to a VRTK_Pointer in the `Direction Indicator` parameter and will the be used to send rotation data when the destination marker events are emitted.
The Pointer Direction Indicator can be attached to a VRTK_BasePointerRenderer in the `Direction Indicator` parameter and will the be used to send rotation data when the destination marker events are emitted.

This can be useful for rotating the play area upon teleporting to face the user in a new direction without expecting them to physically turn in the play space.

Expand Down

0 comments on commit 881e6ec

Please sign in to comment.