> For the complete documentation index, see [llms.txt](https://fantacode.gitbook.io/grappling-hook-system/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://fantacode.gitbook.io/grappling-hook-system/grappling-hook-controller.md).
# Grappling Hook Controller
## Main
* **EnableHook**: Enables or disables the grappling hook functionality.
* **HookInput**: Defines the keyboard key for initiating the hook.
* **HookInputButton**: Identifies the input button name for hooking, helpful for controllers.
* **Mode**: Sets the grappling mode, allowing swinging, hooking, or both.
* **MaxSwingAngleLimit**: Limits the maximum angle allowed for swinging.
* **SwingOnlyIfHookPointExists**: Enables swinging only if a hookable point is found between start and end.
* **RopeThrowingClip**: The animation clip used when the rope is being thrown for the hook.
* **AnimationSpeed**: Controls the speed of the rope-throwing animation.
* **MaxDistance**: The maximum distance the grappling hook can reach to attach to a point.
* **MaxSwingDistance**: Sets the maximum range allowed for swinging.
* **MinDistance**: The minimum distance the player must be from the grappling point for the hook to function properly.
* **GrapplingHookMoveSpeed**: The movement speed when using the grappling hook.
* swingActionMoveSpeed: The movement speed during the swing.
## Rope Settings
* **RopeRadius**: Specifies the thickness of the rope used for the grappling hook.
* **RopeMaterial**: The material applied to the rope for visual appearance.
* **RopeThrowSpeed**: The speed at which the rope is thrown towards the target point.
* **RopeResolution**: Determines the number of segments used to render the rope, affecting its smoothness.
* **SpiralRadius**: The radius of the spiral motion when the rope is thrown.
* **SpiralFrequency**: Controls the frequency of the spiral effect in the rope's motion.
* **RopeStartPoint**: The starting point of the rope. If not set, the right hand will be used as the default
* **HookObject**: This Transform represents the physical hook part of the grappling gun, typically the part that travels towards the target point when the grappling hook is fired
## Camera Settings
* **CameraShakeAmount**: The intensity of the camera shakes when the hook is pulled.
* **CameraShakeDuration**: The duration of the camera shakes when the hook is pulled.
## Crosshair
* **CrosshairPrefab**: The crosshair to display when aiming the grappling hook. •
* **CrosshairSize**: The size of the crosshair.
## Events
* **RopeReleased**: An event triggered when the hook is released.
* **RopeHooked**: An event triggered when the hook successfully attaches to a target point.
* **MovementStarted**: An event triggered when the player starts moving towards the point.
* **TargetPointReached**: An event triggered when the player reaches the point.
