# Quickstart

## Quick Start

Get up and running with **GravityTransform (Custom Gravity System)** in just a few minutes.

***

### 🎯 Goal

After completing this guide, you’ll have a level with:

* A **custom gravity zone** (Box or Sphere),
* An actor or character affected by that zone’s gravity,
* A visible gravity direction change when entering/exiting the zone.

***

### 🧩 Step 1 — Enable and Restart

1. Go to **Edit → Plugins** in Unreal Editor.
2. Search for **GravityTransform**.
3. Click **Enable**, then **Restart the editor**.

***

### 🌍 Step 2 — Add a Gravity Zone

1. Open your level.
2. In the **Place Actors** panel, search for:
   * **Gravity Zone Box**, or
   * **Gravity Zone Sphere**
3. Drag one into the level.
4. Adjust its **shape and size** (via `BoxExtent` or `SphereRadius`).
5. In its **Details panel**, choose the desired gravity type and strength:
   * `Gravity Type`: Directional, Point, Custom, etc.
   * `Gravity Strength`: The pull intensity (e.g. -980 for Earth gravity).
6. Optionally, enable **Debug Draw** to visualize the gravity direction in real time.
7. The `priority` attribute allows you to set the priority for each zone.
8. The MOD attribute allows you to set its direction mode.

***

### 🧍 Step 3 — Prepare Your Actor or Character

To make something respond to gravity zones:

#### Option A — For Characters

1. Select your Character Blueprint (e.g. `BP_Character`).
2. Add the **CustomGravityComponent** (from *Add Component → Custom Gravity Component*).
3. Compile and Save.
4. Make sure the component’s `bUseGlobalGravity` is **true** (to follow world gravity)\
   or **false** (to respond to nearby zones).

#### Option B — For Simple Actors

1. Add a **Static Mesh** actor to the level.
2. In the Details panel, click **Add Component → Custom Gravity Component**.
3. Enable `Simulate Physics` on the mesh.
4. Adjust component settings like `Gravity Scale` or `Affected By Zones`.

#### Option B—GravityMultiplier

1.The GravityMultiplier property allows you to set the force multiplier individually for each component.

***

### 🚀 Step 4 — Play and Test

1. Click **Play**.
2. Move your character or physics object into the gravity zone.
3. Observe the gravity direction and force change:
   * Inside the zone → affected by custom gravity.
   * Outside the zone → returns to world gravity.

If you enabled “Debug Draw”, you’ll see arrows showing the active gravity direction.

***

### 🧭 Step 5 — Combine Zones (Optional)

You can place multiple zones with different shapes and gravity types.\
The plugin’s **GravityWorldSubsystem** automatically picks the most relevant one for each object (e.g., nearest or strongest).

***

### ✅ Done!

You’ve successfully:

* Enabled GravityTransform,
* Created a custom gravity zone,
* Added a gravity-aware component,
* Tested directional or point gravity in action.

You can now experiment with:

* **Multiple zones**,
* **Dynamic switching**,
* **Blueprint control** via `GravityBlueprintLibrary` functions.

{% hint style="info" %}

{% endhint %}

### Import

###


---

# Agent Instructions: 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:

```
GET https://realms-roar.gitbook.io/gravity-transform-custom-gravity-system/getting-started/quickstart.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.