Wrap Usage for Docs

Stuyk · Mar 26, 2023 · 6013452 · 6013452
1 parent 627294b
commit 6013452
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 11 deletions.
diff --git a/scripts/documentation/index.js b/scripts/documentation/index.js
@@ -76,5 +76,17 @@ for (let file of files) {
  rows.unshift(`title: ${apiPath}`);
  rows.unshift('---');
 
+ for (let i = 0; i < rows.length; i++) {
+ if (!rows[i].includes('▸')) {
+ continue;
+ }
+
+ const rowWithPathway = rows[i].replace('▸ ', apiPath + '.');
+ rows[i] = rowWithPathway;
+ rows.splice(i, 0, '::: Tip');
+ rows.splice(i + 2, 0, ':::');
+ i += 1; // Increment by 1 to prevent endless loop
+ }
+
  fs.writeFileSync(file, rows.join('\n'));
 }
diff --git a/src/core/server/player/emit.ts b/src/core/server/player/emit.ts
@@ -7,7 +7,6 @@ import { ANIMATION_FLAGS } from '@AthenaShared/flags/animationFlags';
 import IAttachable from '@AthenaShared/interfaces/iAttachable';
 import ICredit from '@AthenaShared/interfaces/iCredit';
 import IErrorScreen from '@AthenaShared/interfaces/iErrorScreen';
-import { InputMenu } from '@AthenaShared/interfaces/inputMenus';
 import IShard from '@AthenaShared/interfaces/iShard';
 import ISpinner from '@AthenaShared/interfaces/iSpinner';
 import { Particle } from '@AthenaShared/interfaces/particle';
@@ -315,14 +314,6 @@ export function taskTimeline(player: alt.Player, tasks: Array<Task | TaskCallbac
  alt.emitClient(player, SYSTEM_EVENTS.PLAYER_EMIT_TASK_TIMELINE, tasks);
 }
 
-export function inputMenu(player: alt.Player, inputMenu: InputMenu) {
- if (Overrides.inputMenu) {
- return Overrides.inputMenu(player, inputMenu);
- }
-
- alt.emitClient(player, View_Events_Input_Menu.SetMenu, inputMenu);
-}
-
 /**
  * Create a spinner in the bottom-right corner.
  * @param {alt.Player} player An alt:V Player Entity
@@ -651,7 +642,6 @@ interface EmitFunctions {
  createShard: typeof createShard;
  createSpinner: typeof createSpinner;
  clearTimeCycleEffect: typeof clearTimeCycleEffect;
- inputMenu: typeof inputMenu;
  fadeScreenToBlack: typeof fadeScreenToBlack;
  fadeScreenFromBlack: typeof fadeScreenFromBlack;
  message: typeof message;
@@ -687,7 +677,6 @@ export function override(functionName: 'createMissionText', callback: typeof cre
 export function override(functionName: 'createProgressBar', callback: typeof createProgressBar);
 export function override(functionName: 'createShard', callback: typeof createShard);
 export function override(functionName: 'createSpinner', callback: typeof createSpinner);
-export function override(functionName: 'inputMenu', callback: typeof inputMenu);
 export function override(functionName: 'fadeScreenFromBlack', callback: typeof fadeScreenFromBlack);
 export function override(functionName: 'fadeScreenToBlack', callback: typeof fadeScreenToBlack);
 export function override(functionName: 'message', callback: typeof message);
@@ -712,6 +701,7 @@ export function override(functionName: 'wheelMenu', callback: typeof wheelMenu);
 /**
  * Used to override any internal emit functions.
  *
+ * @ignore
  * @export
  * @param {keyof EmitFunctions} functionName
  * @param {*} callback