> For the complete documentation index, see [llms.txt](https://docs.oakwood-mp.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.oakwood-mp.net/public-api/events.md).

# Events

This page describes server-side events

## Gamemode start

`start()`

{% tabs %}
{% tab title="Details" %}

### Remarks

### Arguments

| Type         | Description |
| ------------ | ----------- |
| {% endtab %} |             |

{% tab title="Example" %}

```javascript
oak.event('start', () => {
    console.log('[info] connection started')
    oak.log('[info] oakwood-node connected')
})
```

{% endtab %}
{% endtabs %}

## Server console

`console(text)`

{% tabs %}
{% tab title="Details" %}

### Remarks

Executed on server console input.

### Arguments

| Type         | Description |
| ------------ | ----------- |
| string       | Text        |
| {% endtab %} |             |

{% tab title="Example" %}

```javascript
// TODO
```

{% endtab %}
{% endtabs %}

## Unknown chat command

`unknownCommand(pid, text)`

{% tabs %}
{% tab title="Details" %}

### Remarks

### Arguments

| Type         | Description  |
| ------------ | ------------ |
| player       | Player ID    |
| string       | Command Used |
| {% endtab %} |              |

{% tab title="Example" %}

```javascript
oak.event('unknownCommand', (pid, text) => {
    oak.chatSend(pid, `[error] unknown command: ${text}`)
})
```

{% endtab %}
{% endtabs %}

## Gamemode stop

`stop()`

{% tabs %}
{% tab title="Details" %}

### Remarks

Happens when the server is shut down.

### Arguments

| Type         | Description |
| ------------ | ----------- |
| {% endtab %} |             |

{% tab title="Example" %}

```javascript
oak.event('start', () => {
    console.log('[info] connection stopped')
})
```

{% endtab %}
{% endtabs %}

## Player connect

`playerConnect(pid)`

{% tabs %}
{% tab title="Details" %}

### Remarks

Best place to spawn the player.

### Arguments

| Type         | Description |
| ------------ | ----------- |
| player       | Player ID   |
| {% endtab %} |             |

{% tab title="Example" %}

```javascript
oak.event('playerConnect', async pid => {
    console.log('[info] player connected', pid)
    oak.chatBroadcast(`[info] player ${await oak.playerNameGet(pid)} connected.`)
    oak.playerModelSet(pid, "Tommy.i3d")
    oak.playerPositionSet(pid, [-1774.59301758, -4.88487052917, -2.40491962433 ])
    oak.playerHealthSet(pid, 200)
    oak.hudFadeout(pid, 1, 500, 0xFFFFFF)
    oak.hudFadeout(pid, 0, 500, 0xFFFFFF)
    oak.playerSpawn(pid)
})
```

{% endtab %}
{% endtabs %}

## Player disconnect

`playerDisconnect(pid)`

{% tabs %}
{% tab title="Details" %}

### Remarks

Happens when the player disconnects or times out.

{% hint style="warning" %}

```
There's no way to find out if the player timed out as of right now. This will be added later on.
```

{% endhint %}

### Arguments

| Type         | Description |
| ------------ | ----------- |
| player       | Player ID   |
| {% endtab %} |             |

{% tab title="Example" %}

```javascript
oak.event('playerDisconnect', async pid => {
    oak.chatBroadcast(`[info] player ${await oak.playerNameGet(pid)} disconnected.`)
})
```

{% endtab %}
{% endtabs %}

## Player death

`playerDeath(pid)`

{% tabs %}
{% tab title="Details" %}

### Remarks

### Arguments

| Type         | Description |
| ------------ | ----------- |
| player       | Player ID   |
| {% endtab %} |             |

{% tab title="Example" %}

```javascript
oak.event('playerDeath', async pid => {
    oak.chatSend(pid, `[info] you died! Get a new life!`)
    oak.playerModelSet(pid, "Tommy.i3d")
    oak.playerPositionSet(pid, [-1774.59301758, -4.88487052917, -2.40491962433 ])
    oak.playerHealthSet(pid, 200)
    oak.hudFadeout(pid, 1, 500, 0xFFFFFF)
    oak.hudFadeout(pid, 0, 500, 0xFFFFFF)
    oak.playerSpawn(pid)
})
```

{% endtab %}
{% endtabs %}

## Player hit

`playerhit(pid, atkr, float)`

{% tabs %}
{% tab title="Details" %}

### Remarks

Happens when attacker lands a hit on another player.

### Arguments

| Type         | Description  |
| ------------ | ------------ |
| player       | Player ID    |
| player       | Attacker ID  |
| float        | Damage Dealt |
| {% endtab %} |              |

{% tab title="Example" %}

```javascript
// TODO
```

{% endtab %}
{% endtabs %}

## Vehicle player use

`vehicleUse(veh, pid, success, seatId, enterOrLeave)`

{% tabs %}
{% tab title="Details" %}

### Remarks

Success is true if car is unlocked, we can also provide which seat he wants to enter or whether he wants to enter or leave the vehicle.

### Arguments

| Type         | Description          |
| ------------ | -------------------- |
| vehicle      | Vehicle ID           |
| player       | Player ID            |
| int          | Success State        |
| int          | Seat ID              |
| int          | Enter or Leave State |
| {% endtab %} |                      |

{% tab title="Example" %}

```javascript
oak.event("vehicleUse", async (veh, pid, success, seatId, enterOrLeave) => {
    if (success) return;

    oak.hudMessage(pid, "This vehicle is locked!", 0xff0000)
})
```

{% endtab %}
{% endtabs %}

## Player key

`playerKey(pid, vkey, down)`

{% tabs %}
{% tab title="Details" %}

### Remarks

Executed on player key press. The key codes are documented at [MSDN page](https://docs.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes).

### Arguments

| Type         | Description |
| ------------ | ----------- |
| player       | Player ID   |
| int          | Virtual Key |
| int          | Is Key Down |
| {% endtab %} |             |

{% tab title="Example" %}

```javascript
// TODO
```

{% endtab %}
{% endtabs %}