HumanoidControl/HumanoidControl_Free
HumanoidControl/HumanoidControl_Free
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated HelpURLs to new Doxygen documentation

Browse Source
This commit is contained in:
Pascal Serrarens 2022-01-18 17:18:15 +01:00
parent 58d9b0e5ca
commit 650b3c965f
15 changed files with 69 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Runtime/HumanoidFree/Scripts/Extensions/HumanoidSensor.cs
View File

@ -176,7 +176,6 @@ namespace Passer.Humanoid {
protected Vector3 GetTargetPosition(Transform sensorTransform) { protected Vector3 GetTargetPosition(Transform sensorTransform) {
Vector3 targetPosition = sensorTransform.position + sensorTransform.rotation * sensor2TargetRotation * sensor2TargetPosition; Vector3 targetPosition = sensorTransform.position + sensorTransform.rotation * sensor2TargetRotation * sensor2TargetPosition;
Debug.DrawLine(targetPosition, sensorTransform.position, Color.magenta);
return targetPosition; return targetPosition;
} }

6
Runtime/HumanoidFree/Scripts/HumanoidControl.cs
View File

@ -104,8 +104,8 @@ namespace Passer.Humanoid {
/// * \ref HumanoidControl::scaling "Scaling" /// * \ref HumanoidControl::scaling "Scaling"
/// * \ref HumanoidControl::dontDestroyOnLoad "Don't Destroy on Load" /// * \ref HumanoidControl::dontDestroyOnLoad "Don't Destroy on Load"
/// * \ref HumanoidControl::disconnectInstances "Disconnect Instances" /// * \ref HumanoidControl::disconnectInstances "Disconnect Instances"
[HelpURL("https://passervr.com/documentation/humanoid-control/humanoid-control-script/")] [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_humanoid_1_1_humanoid_control.html")]
public class HumanoidControl : MonoBehaviour /*: PawnControl*/ { public class HumanoidControl : MonoBehaviour {
/// <summary>The path at which the HumanoidControl script is found</summary> /// <summary>The path at which the HumanoidControl script is found</summary>
public string path; public string path;
@ -2577,3 +2577,5 @@ namespace Passer.Humanoid {
#endregion #endregion
} }
} }

6
Runtime/HumanoidFree/Scripts/Targets/FootTarget.cs
View File

@ -41,14 +41,14 @@ namespace Passer.Humanoid {
/// ///
/// Settings /// Settings
/// ======== /// ========
/// \ref FootTarget::rotationSpeedLimitation "Rotation Speed Limitation" /// * \ref FootTarget::rotationSpeedLimitation "Rotation Speed Limitation"
/// \ref FootTarget::slidePrevention "Slide Prevention" /// * \ref FootTarget::slidePrevention "Slide Prevention"
/// ///
/// Events /// Events
/// ====== /// ======
/// * \ref FootTarget::groundEvent "Ground Event" /// * \ref FootTarget::groundEvent "Ground Event"
/// ///
[HelpURLAttribute("https://passervr.com/documentation/humanoid-control/foot-target/")] [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_humanoid_1_1_foot_target.html")]
public class FootTarget : HumanoidTarget { public class FootTarget : HumanoidTarget {
public bool isLeft; public bool isLeft;
public Side side; public Side side;

2
Runtime/HumanoidFree/Scripts/Targets/HandTarget.cs
View File

@ -100,7 +100,7 @@ namespace Passer.Humanoid {
/// * Add \ref Passer::Teleporter "Teleporter": Adds a preconfigured interaction pointer /// * Add \ref Passer::Teleporter "Teleporter": Adds a preconfigured interaction pointer
/// to the hand target which can teleport the avatar by pointing to new positions. /// to the hand target which can teleport the avatar by pointing to new positions.
[System.Serializable] [System.Serializable]
[HelpURLAttribute("https://passervr.com/documentation/humanoid-control/hand-target/")] [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_humanoid_1_1_hand_target.html")]
public partial class HandTarget : HumanoidTarget { public partial class HandTarget : HumanoidTarget {
public HandTarget() { public HandTarget() {
shoulder = new TargetedShoulderBone(this); shoulder = new TargetedShoulderBone(this);

2
Runtime/HumanoidFree/Scripts/Targets/HeadTarget.cs
View File

@ -61,7 +61,7 @@ namespace Passer.Humanoid {
/// <a href="http://passervr.com/documentation/interaction-eventsystem-and-ui/">Interaction, Event System and UI</a>. /// <a href="http://passervr.com/documentation/interaction-eventsystem-and-ui/">Interaction, Event System and UI</a>.
/// * Add \ref Passer::Teleporter "Teleporter": Adds a preconfigured gaze interaction pointer /// * Add \ref Passer::Teleporter "Teleporter": Adds a preconfigured gaze interaction pointer
/// to the head target which can teleport the avatar by pointing to new positions. /// to the head target which can teleport the avatar by pointing to new positions.
[HelpURL("https://passervr.com/documentation/humanoid-control/head-target/")] [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_humanoid_1_1_head_target.html")]
public class HeadTarget : HumanoidTarget { public class HeadTarget : HumanoidTarget {
public HeadTarget() { public HeadTarget() {

2
Runtime/HumanoidFree/Scripts/Targets/HipsTarget.cs
View File

@ -38,7 +38,7 @@ namespace Passer.Humanoid {
/// ======== /// ========
/// \ref HipsTarget::bodyRotation "Body Rotation" /// \ref HipsTarget::bodyRotation "Body Rotation"
/// ///
[HelpURLAttribute("https://passervr.com/documentation/humanoid-control/hips-target/")] [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_humanoid_1_1_hips_target.html")]
public partial class HipsTarget : HumanoidTarget { public partial class HipsTarget : HumanoidTarget {
public HipsTarget() { public HipsTarget() {

2
Runtime/HumanoidFree/Scripts/Tools/AvatarManager.cs
View File

@ -42,7 +42,7 @@ namespace Passer.Humanoid {
/// ///
/// \image AvatarManagerControllerInput.png /// \image AvatarManagerControllerInput.png
/// ///
[HelpURLAttribute("https://passervr.com/documentation/humanoid-control/avatar-manager/")] [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_humanoid_1_1_avatar_manager.html")]
public class AvatarManager : MonoBehaviour { public class AvatarManager : MonoBehaviour {
/// <summary>The index of the current avatar in the list</summary> /// <summary>The index of the current avatar in the list</summary>

1
Runtime/Sites/Scripts/Possessable.cs
View File

@ -15,6 +15,7 @@ namespace Passer {
/// * %Is unique, see Possession::isUnique /// * %Is unique, see Possession::isUnique
/// ///
/// \version 4 /// \version 4
[HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_possessable.html")]
public class Possessable : MonoBehaviour { public class Possessable : MonoBehaviour {
/// <summary> /// <summary>

1
Runtime/Sites/Scripts/Site.cs
View File

@ -31,6 +31,7 @@ namespace Passer {
/// Example sites can be found in Assets/Passer/Sites/ /// Example sites can be found in Assets/Passer/Sites/
/// ///
/// \version 4.0 and higher /// \version 4.0 and higher
[HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_site.html")]
[RequireComponent(typeof(HumanoidSpawnPoint))] [RequireComponent(typeof(HumanoidSpawnPoint))]
public class Site : MonoBehaviour { public class Site : MonoBehaviour {

1
Runtime/Tools/Input/ControllerInput.cs
View File

@ -20,6 +20,7 @@ namespace Passer {
/// (e.g. SteamVR or Oculus Touch controllers). /// (e.g. SteamVR or Oculus Touch controllers).
/// For game controllers like the Xbox controller, this corresponds to the left and right side of the gamepad. /// For game controllers like the Xbox controller, this corresponds to the left and right side of the gamepad.
/// Event input is using an EventHandler to define its behaviour. /// Event input is using an EventHandler to define its behaviour.
[HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_controller_input.html")]
public class ControllerInput : MonoBehaviour { public class ControllerInput : MonoBehaviour {
public enum SideButton { public enum SideButton {

2
Runtime/Tools/Networking/NetworkingStarter.cs
View File

@ -17,7 +17,7 @@ namespace Passer {
/// The easiest way to turn a single-user scene in a multi-user environment is to add the /// The easiest way to turn a single-user scene in a multi-user environment is to add the
/// NetworkingStarter prefab to the scene. You can find this in the Humanoid->Prefabs->Networking folder. /// NetworkingStarter prefab to the scene. You can find this in the Humanoid->Prefabs->Networking folder.
[System.Serializable] [System.Serializable]
[HelpURLAttribute("https://passervr.com/documentation/humanoid-control/networking-support/")] [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_networking_starter.html")]
#if hNW_PHOTON #if hNW_PHOTON
#if hPHOTON2 #if hPHOTON2
public class NetworkingStarter : Photon.Pun.MonoBehaviourPunCallbacks public class NetworkingStarter : Photon.Pun.MonoBehaviourPunCallbacks

1
Runtime/Tools/Scripts/Counter.cs
View File

@ -21,6 +21,7 @@ namespace Passer {
/// - Value Change Event, see Counter::counterEvent /// - Value Change Event, see Counter::counterEvent
/// ///
/// \version 4.0 and higher /// \version 4.0 and higher
[HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_counter.html")]
public class Counter : MonoBehaviour { public class Counter : MonoBehaviour {
#region Properties #region Properties

4
Runtime/Tools/Scripts/Handle.cs
View File

@ -40,9 +40,7 @@ namespace Passer {
/// The difference is that empty entries do not override the ControllerInput configuration. /// The difference is that empty entries do not override the ControllerInput configuration.
/// When the handle is released by the hand, /// When the handle is released by the hand,
/// the ControllerInput is restored to the original configuration. /// the ControllerInput is restored to the original configuration.
[HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_handle.html")]
///
[HelpURL("https://passervr.com/documentation/humanoid-control/grabbing-objects/handle/")]
public class Handle : MonoBehaviour { public class Handle : MonoBehaviour {
/// <summary>The way in which the hand can grab the handle</summary> /// <summary>The way in which the hand can grab the handle</summary>

1
Runtime/Tools/Scripts/HumanoidSpawnPoint.cs
View File

@ -19,6 +19,7 @@ namespace Passer.Humanoid {
/// In the scene view, the capsule is visualized as an orange cylinder when the spawn point is selected: /// In the scene view, the capsule is visualized as an orange cylinder when the spawn point is selected:
/// ///
/// \image html HumanoidSpawnPointGizmo.png /// \image html HumanoidSpawnPointGizmo.png
[HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_humanoid_1_1_humanoid_spawn_point.html")]
public class HumanoidSpawnPoint : SpawnPoint { public class HumanoidSpawnPoint : SpawnPoint {
/// <summary> /// <summary>

2
Runtime/Tools/Scripts/Socket.cs
View File

@ -122,7 +122,7 @@ namespace Passer {
/// This joint is implemented using a Configurable Joint /// This joint is implemented using a Configurable Joint
/// such that it will follow the Handle’s Transform as closely as possible. /// such that it will follow the Handle’s Transform as closely as possible.
/// When the Handle is released, the joint is destroyed again. /// When the Handle is released, the joint is destroyed again.
/// [HelpURL("https://passervr.com/apis/HumanoidControl/Unity/class_passer_1_1_socket.html")]
public class Socket : MonoBehaviour { public class Socket : MonoBehaviour {
protected static void DebugLog(string s) { protected static void DebugLog(string s) {