> For the complete documentation index, see [llms.txt](https://rigonix3d.gitbook.io/rigonix3d-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rigonix3d.gitbook.io/rigonix3d-docs/documentation/systems-in-depth/helper-functions-reference.md).

# Helper Functions Reference

A quick reference of the runtime helper methods across the modules.

A grab-bag of the most useful runtime methods, grouped by module. All are called through `core` (body modules) or `controller` (driver modules).

### Locomotion

```csharp
locomotion.ChangeStance(Stance.Crouch);
locomotion.LockPlayerMovement();
locomotion.LockPlayerRotation();
locomotion.SetPlayerMovementAndRotation(lockMove, lockRot);
locomotion.SetPlayerLocomotion(false);
locomotion.RemoveVelocity();
locomotion.ResetSpeed();
locomotion.SetisStrafeLocomotion(true);
locomotion.MovePlayerTo(target, ...);   // scripted movement
```

### Input

```csharp
input.LockCursor();
input.UnlockCursor();
input.inputBlocked = true;   // freeze all intent
```

### Ragdoll

```csharp
ragdoll.TriggerRagdoll(force, hitPoint);
ragdoll.TriggerFallRagdoll(impactForce, preVelocity);
ragdoll.DisableRagdoll();
ragdoll.RefreshColliders();
ragdoll.HasRagdoll;
```

### Foot IK

```csharp
ik.IsGrounded();
ik.SetFootWeight(1f);
ik.SetBodyWeight(1f);
ik.SetCrouching(true);
ik.ResetTuningToDefaults();
```

### Animator

```csharp
animatorModule.Die(true);
animatorModule.SetItemId(id);
animatorModule.ResetItemId();
```

### Inventory

```csharp
inventory.AddItem(item);
inventory.RemoveItem(item);
inventory.HasItem("Torch");
inventory.AddMoney(50);
inventory.SpendMoney(20);
inventory.HasEnoughMoney(20);
```

### Abilities

```csharp
teleport.TeleportTo(position, rotation);
emotes.PlayEmoteByIndex(index);
headIK.SetLookTarget(target);
headIK.ClearLookTarget();
```

### Reference points (Core — great for AI and aiming)

```csharp
core.GetReferenceYaw();
core.GetReferenceForward();
core.GetReferenceRight();
core.GetAimForward();
core.GetAimPoint(distance);
```

These resolve from an assigned `IMovementReference` / `IAimReference` if present, else the main camera, else the character's own facing — so they never throw, camera or no camera.

### Vector extension

```csharp
using Rigonix;
Vector3 flat = someVector.WithY(0f);   // zero out Y on the horizontal plane
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://rigonix3d.gitbook.io/rigonix3d-docs/documentation/systems-in-depth/helper-functions-reference.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.