> For the complete documentation index, see [llms.txt](https://arrayscripts.gitbook.io/arrayscripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://arrayscripts.gitbook.io/arrayscripts/products/array_hud/api-reference.md).

# API Reference

{% hint style="info" %} <mark style="color:$info;">**Developer Note:**</mark> All exports and events listed below are available once the resource has been started.
{% endhint %}

## Exports

{% tabs %}
{% tab title="Client Exports" %}
{% code lineNumbers="true" expandable="true" %}

```
exports['array_hud']:Notify("Title", "Your Message", success, 5000)
exports['array_hud']:Announce("Title", "Your Message", 5000)
exports['array_hud']:Progressbar("Title", 5000, "E")
exports['array_hud']:HelpNotify("E", "Your Text")
exports['array_hud']:HideHud(true) -- true or false
exports['array_hud']:HideHud(true) -- true or false
```

{% endcode %}
{% endtab %}

{% tab title="Server Exports" %}
{% code lineNumbers="true" expandable="true" %}

```
No exports are currently available for this resource.
```

{% endcode %}
{% endtab %}
{% endtabs %}

## Events

{% tabs %}
{% tab title="Client Events" %}
{% code lineNumbers="true" expandable="true" %}

```
TriggerEvent("array_hud:hideHud", true) -- true or false
TriggerEvent("array_hud:notify", "Title", "Your Message", success, 5000)
TriggerEvent("array_hud:lifeinvader", "Lifeinvader Message", name, number)
TriggerEvent("array_hud:announce", "Title", "Your Message", 5000)
TriggerEvent("array_hud:progressbar", "Title", 5000, "E")
```

{% endcode %}
{% endtab %}

{% tab title="Server Events" %}
{% code lineNumbers="true" expandable="true" %}

```
TriggerClientEvent("array_hud:hideHud", id, true) -- true or false
TriggerClientEvent("array_hud:notify", id, "Title", "Your Message", success, 5000)
TriggerClientEvent("array_hud:lifeinvader", id, "Your Message", name, number)
TriggerClientEvent("array_hud:announce", id, "Title", "Your Message", 5000)
TriggerClientEvent("array_hud:progressbar", id, "Title", 5000, "E")
```

{% endcode %}
{% endtab %}
{% endtabs %}

## Entry Events

{% tabs %}
{% tab title="More Events" %}
{% code lineNumbers="true" expandable="true" %}

```
-- Parameters:
-- type:
--   "user" -> Modifies the user count
--   "team" -> Modifies the team count
--
-- action:
--   "add"    -> Increases the value by 1
--   "remove" -> Decreases the value by 1
--   "set"    -> Sets the value to the number provided in "data"
--
-- data:
--   Only required when using the "set" action.
--   Specifies the value the counter should be set to.
--
-- Examples:
-- TriggerEvent("array_hud:EditEntryData", "user", "add")
-- TriggerEvent("array_hud:EditEntryData", "team", "remove")
-- TriggerEvent("array_hud:EditEntryData", "user", "set", 25)
```

{% endcode %}
{% endtab %}
{% endtabs %}

## Commands

{% tabs %}
{% tab title="Ingame Commands" %}

<pre data-line-numbers data-expandable="true"><code>/hud - Opens the Hud settings, where you can manage your Hud.
/t - Opens the Hud Chat
<strong>/tc {message} - You must provide a message.
</strong>/announce {message} - You must provide a message.
/teamannounce {message} - You must provide a message.
/frakannounce {fractionname} {message} - You must provide a fractionname and a message.
</code></pre>

{% endtab %}

{% tab title="Console Commands" %}
{% code lineNumbers="true" expandable="true" %}

```
/tc {message} - You must provide a message.
/reloadperms - Reload the Player Groups
/announce {message} - You must provide a message.
/teamannounce {message} - You must provide a message.
/frakannounce {fractionname} {message} - You must provide a fractionname and a message.
```

{% endcode %}
{% endtab %}
{% endtabs %}