From 6f1822bf4d94d96a56e4b9f0f146d0e60463aacb Mon Sep 17 00:00:00 2001 From: Duck McSouls Date: Sun, 16 Oct 2022 18:34:34 +1100 Subject: [PATCH] DOC: `gang.canRecruitMember()`: when this returns true or false Elaborate on the conditions under which the function would return true or false. In particular, after a gang is successfully created the function always return true so the player can recruit a number of founding members to their gang. When the gang is at capacity, the function always return false. In between, the function returns true or false depending on the amount of respect the player has. --- src/ScriptEditor/NetscriptDefinitions.d.ts | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index 307306035..8e4f0e186 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -3378,6 +3378,14 @@ export interface Gang { * * Returns a boolean indicating whether a member can currently be recruited. * + * Once you have successfully created a gang by using the function + * {@link Gang.createGang | createGang}, you can immediately recruit a small + * number of members to your gang. After you have recruited the founding + * members, to recruit another member you must increase your respect. The + * more members you want to recruit, the more respect you require. If your + * gang has the maximum number of members, then this function would return + * false. + * * @returns True if a member can currently be recruited, false otherwise. */ canRecruitMember(): boolean;