> For the complete documentation index, see [llms.txt](https://ferdowsur.gitbook.io/3d-ranks/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ferdowsur.gitbook.io/3d-ranks/rank.md).

# Rank

A Rank can have different pieces. 

<figure><img src="https://96267253-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWP4h0q7qUXVTnCbRAstH%2Fuploads%2FvuVsEN1ChusDb0ht5bUx%2FParts%20Indicator.png?alt=media&amp;token=159b3bfd-bdb0-4548-b4c9-bdb0c000d4ee" alt=""><figcaption></figcaption></figure>

Each piece has many different variances you can choose from with an interactive inspector.&#x20;

The inspector will automatically update with new fields and options depending on your choice, and whether you are in play-mode or edit-mode.

<figure><img src="https://96267253-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWP4h0q7qUXVTnCbRAstH%2Fuploads%2FQRRMr7xnwX0GGoqCV6se%2FCustomize%20Rank%20Tab.png?alt=media&amp;token=6a3dfa56-e15b-44c3-91ed-54a8804c97c3" alt="" width="375"><figcaption></figcaption></figure>

When you are done, you can save it. And it will show up in the list of available Ranks.

<figure><img src="https://96267253-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWP4h0q7qUXVTnCbRAstH%2Fuploads%2FOaPY7gVa42XXd23uYKLG%2Fimage.png?alt=media&amp;token=330d353d-5567-49c1-ac77-cb939d1db909" alt="" width="329"><figcaption></figcaption></figure>

## Script Reference

You can use the ApplyRank method to modify the rank via code or buttons.

```csharp
ranksAnimationController.ApplyRank(i);
```

<table data-full-width="false"><thead><tr><th width="315.6666666666667">Method</th><th>Description</th></tr></thead><tbody><tr><td><pre class="language-csharp"><code class="lang-csharp"><strong>ApplyRank(int index);
</strong></code></pre></td><td><p>Retrieves the rank from the ranks list at the specified index and applies it.</p><p><br>If an invalid index is passed, it logs a warning message and returns. Doesn't print an error.</p></td></tr><tr><td><pre class="language-csharp"><code class="lang-csharp"><strong>ApplyRank(string rankName);
</strong></code></pre></td><td>Applies a rank from the ranks list by its exact name.<br><br>If the rank is not found or the name is invalid, a warning is logged.</td></tr><tr><td><pre class="language-csharp"><code class="lang-csharp"><strong>ApplyRank(Rank targetRank);
</strong></code></pre></td><td>Applies the rank passed as parameter.</td></tr></tbody></table>