# Code Conventions

## Separate complex Skript expressions from skript-mirror calls

Combining Skript expressions with skript-mirror calls may make your code difficult to read. Use variables to separate these different types of calls.

{% hint style="danger" %}

```
(the player's targeted block).breakNaturally()
```

{% endhint %}

{% hint style="success" %}

```
set {_target} to the player's targeted block
{_target}.breakNaturally()
```

{% endhint %}

## Keep the target of a skript-mirror call grouped

When calling a method or accessing a field, avoid using spaces when possible.

{% hint style="danger" %}

```
the event.getPlayer()
```

{% endhint %}

{% hint style="success" %}

```
event.getPlayer()
```

{% endhint %}

If the expression is simple (i.e. does not contain other expressions) but requires a space, surround the expression in parentheses.

{% hint style="danger" %}

```
spawned creeper.isPowered()
```

{% endhint %}

{% hint style="success" %}

```
(spawned creeper).isPowered()
```

{% endhint %}

If the target of the expression is not simple (i.e. contains other expressions), extract the expression into a local variable. ([rule](#separate-complex-skript-expressions-from-skript-mirror-calls))

Variables are the exception to this rule and may contain spaces and/or other expressions

{% hint style="success" %}

```
{my script::%player%::pet}.isDead()
```

{% endhint %}

## Avoid aliasing classes for aesthetic purposes

The purpose of import aliases is to avoid conflicts with other imports and expressions. Do not alias imports in order to make them look like Skript events.

{% hint style="danger" %}

```
import:
  org.bukkit.event.player.PlayerMoveEvent as move

on move:
  # code
```

{% endhint %}

{% hint style="success" %}

```
import:
   org.bukkit.event.player.PlayerMoveEvent

on PlayerMoveEvent:
  # code
```

{% endhint %}

## Avoid unnecessary uses of Java reflection

Especially when copying Java code and translating it for skript-mirror, you may run into instances where you need to use reflection to access a private method, field, or constructor. In skript-mirror, private members are visible and accessible by default.

{% hint style="danger" %}

```
set {_mod count field} to {_map}.getClass().getDeclaredField("modCount")
{_mod count field}.setAccessible(true)
set {_mod count} to {_mod count field}.get({_map})
```

{% endhint %}

{% hint style="success" %}

```
set {_mod count} to {_map}.modCount!
```

{% endhint %}


---

# 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://skript-mirror.gitbook.io/docs/2.x/code-conventions.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.