mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
99 lines
1.5 KiB
Plaintext
99 lines
1.5 KiB
Plaintext
---
|
|
id: fmf-hooks
|
|
title: FMF Hook Reference
|
|
sidebar_label: FMF Hook Reference
|
|
description: Auto-generated from FrikaModFramework/fmf_hooks.json — run tools/fmf-hook-scanner.
|
|
---
|
|
|
|
:::info
|
|
This page is generated by `tools/fmf-hook-scanner`. Do not edit by hand.
|
|
:::
|
|
|
|
# FMF Hook Reference
|
|
|
|
## EMPLOYEE
|
|
|
|
### FMF.EMPLOYEE.Hired
|
|
|
|
**Description:** An employee was hired into the roster.
|
|
|
|
**Payload:**
|
|
|
|
- `employeeId` (string)
|
|
- `role` (string)
|
|
|
|
**Example (C#)**
|
|
|
|
```csharp
|
|
FmfApi.On("FMF.EMPLOYEE.Hired", payload => { });
|
|
```
|
|
|
|
## GAMEPLAY
|
|
|
|
### FMF.GAMEPLAY.JobCompleted
|
|
|
|
**Description:** Emitted when a job has been fully processed.
|
|
|
|
**Payload:**
|
|
|
|
- `jobId` (string)
|
|
- `durationSeconds` (number)
|
|
- `revenue` (number)
|
|
|
|
**Example (C#)**
|
|
|
|
```csharp
|
|
FmfApi.On("FMF.GAMEPLAY.JobCompleted", payload => { });
|
|
```
|
|
|
|
## PLAYER
|
|
|
|
### FMF.PLAYER.LevelUp
|
|
|
|
**Description:** Player progression level increased.
|
|
|
|
**Payload:**
|
|
|
|
- `newLevel` (number)
|
|
- `previousLevel` (number)
|
|
|
|
**Example (C#)**
|
|
|
|
```csharp
|
|
FmfApi.On("FMF.PLAYER.LevelUp", payload => { });
|
|
```
|
|
|
|
## RACK
|
|
|
|
### FMF.RACK.PowerLimitExceeded
|
|
|
|
**Description:** Power draw or allocation for a rack exceeded configured limits.
|
|
|
|
**Payload:**
|
|
|
|
- `rackId` (string)
|
|
- `watts` (number)
|
|
|
|
**Example (C#)**
|
|
|
|
```csharp
|
|
FmfApi.On("FMF.RACK.PowerLimitExceeded", payload => { });
|
|
```
|
|
|
|
## SERVER
|
|
|
|
### FMF.SERVER.RackOverheated
|
|
|
|
**Description:** Server rack exceeded a critical temperature threshold.
|
|
|
|
**Payload:**
|
|
|
|
- `rackId` (string)
|
|
- `temperature` (number)
|
|
|
|
**Example (C#)**
|
|
|
|
```csharp
|
|
FmfApi.On("FMF.SERVER.RackOverheated", payload => { });
|
|
```
|