Skip to content

Commit c102926

Browse files
fix: Fixed incorrect information about file paths in NPC_LoadRecord function in documentation (#1255)
1 parent 03b839f commit c102926

4 files changed

Lines changed: 91 additions & 3 deletions

File tree

frontend/docs/scripting/functions/NPC_LoadRecord.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,15 @@ public OnPlayerCommandText(playerid, cmdtext[])
4747
4848
## Notes
4949
50-
- Files should have .rec extension but don't include it in filename
5150
- Load recordings before using them with NPC_StartPlayback
5251
52+
:::warning
53+
54+
Unlike [NPC_StartPlayback](NPC_StartPlayback), `filePath` requires the full path from the server root, and the `.rec` extension.
55+
Example: `npcmodes/recordings/myrecording.rec`
56+
57+
:::
58+
5359
## Related Functions
5460
5561
- [NPC_UnloadRecord](NPC_UnloadRecord): Unload a recording
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
title: NPC_LoadRecord
3+
sidebar_label: NPC_LoadRecord
4+
description: Charge un fichier d'enregistrement NPC pour la lecture.
5+
tags: ["npc", "enregistrement", "lecture"]
6+
---
7+
8+
<VersionWarn version='omp v1.5.8.3079' />
9+
10+
## Description
11+
12+
Charge un fichier d'enregistrement NPC pour l'utiliser en lecture.
13+
14+
| Name | Description |
15+
| -------------- | ------------------------------ |
16+
| const filePath | Le chemin vers le fichier d'enregistrement |
17+
18+
## Returns
19+
20+
Retourne l'ID de l'enregistrement chargé, ou `INVALID_RECORD_ID` en cas d'échec.
21+
22+
## Examples
23+
24+
```c
25+
public OnPlayerCommandText(playerid, cmdtext[])
26+
{
27+
if (!strcmp(cmdtext, "/npcloadrecord ", true, 15))
28+
{
29+
new filepath[128];
30+
new len = strlen(cmdtext);
31+
if (len <= 15)
32+
return SendClientMessage(playerid, 0xFF0000FF, "Utilisation : /npcloadrecord [filepath]");
33+
34+
strmid(filepath, cmdtext, 15, len);
35+
36+
new recordid = NPC_LoadRecord(filepath);
37+
38+
if (recordid == -1)
39+
SendClientMessage(playerid, 0xFF0000FF, "Échec du chargement de l'enregistrement depuis : %s", filepath);
40+
else
41+
SendClientMessage(playerid, 0x00FF00FF, "Enregistrement chargé depuis %s avec l'ID : %d", filepath, recordid);
42+
return 1;
43+
}
44+
return 0;
45+
}
46+
```
47+
48+
## Notes
49+
50+
- Chargez les enregistrements avant de les utiliser avec NPC_StartPlayback
51+
52+
:::warning
53+
54+
Contrairement à [NPC_StartPlayback](NPC_StartPlayback), `filePath` nécessite le chemin complet depuis la racine du serveur, ainsi que l'extension `.rec`.
55+
Exemple : `npcmodes/recordings/myrecording.rec`
56+
57+
:::
58+
59+
## Fonctions liées
60+
61+
- [NPC_UnloadRecord](NPC_UnloadRecord): Décharge un enregistrement
62+
- [NPC_UnloadAllRecords](NPC_UnloadAllRecords): Décharge tous les enregistrements
63+
- [NPC_StartPlayback](NPC_StartPlayback): Démarre la lecture d'un enregistrement
64+
- [NPC_GetRecordCount](NPC_GetRecordCount): Obtient le nombre d'enregistrements chargés
65+
66+
## Callbacks liées
67+
68+
- [OnNPCPlaybackStart](../callbacks/OnNPCPlaybackStart): Appelée lorsque la lecture démarre
69+
- [OnNPCPlaybackEnd](../callbacks/OnNPCPlaybackEnd): Appelée lorsque la lecture se termine

frontend/i18n/pt-BR/docusaurus-plugin-content-docs/current/scripting/functions/NPC_LoadRecord.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,18 @@ public OnPlayerCommandText(playerid, cmdtext[])
4545
return 0;
4646
}
4747
```
48+
4849
## Notas
4950
50-
- Os arquivos devem ter extensão .rec, mas não incluí-la no nome do arquivo
5151
- Carregue as gravações antes de usá-las com NPC_StartPlayback
5252
53+
:::warning
54+
55+
Ao contrário de [NPC_StartPlayback](NPC_StartPlayback), `filePath` exige o caminho completo a partir da raiz do servidor e a extensão `.rec`.
56+
Exemplo: `npcmodes/recordings/myrecording.rec`
57+
58+
:::
59+
5360
## Funções Relacionadas
5461
5562
- [NPC_UnloadRecord](NPC_UnloadRecord): Descarregue uma gravação

frontend/i18n/zh-CN/docusaurus-plugin-content-docs/current/scripting/functions/NPC_LoadRecord.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,15 @@ public OnPlayerCommandText(playerid, cmdtext[])
4747
4848
## 注意事项
4949
50-
- 文件应具有 .rec 扩展名,但在文件名中不要包含它
5150
- 在使用 NPC_StartPlayback 之前加载录制
5251
52+
:::warning
53+
54+
与 [NPC_StartPlayback](NPC_StartPlayback) 不同,`filePath` 需要提供从服务器根目录开始的完整路径,并包含 `.rec` 扩展名。
55+
例如:`npcmodes/recordings/myrecording.rec`
56+
57+
:::
58+
5359
## 相关函数
5460
5561
- [NPC_UnloadRecord](NPC_UnloadRecord): 卸载录制

0 commit comments

Comments
 (0)