GANG: Updates to Docs, UI, API (#773)

API Changes:
Adds ns.gang.getRecruitsAvailable: Gets the number of additional gang members that can currently be recruited
Adds ns.gang.respectForNextRecruit: Gets the respect threshold for recruiting the next gang member
Adds ns.gang.renameMember: Renames a gang member

Plus many doc and ui improvements
This commit is contained in:
missymae#2783
2023-09-05 16:07:19 -06:00
committed by GitHub
parent bec737a253
commit 8d3f2bd750
24 changed files with 367 additions and 93 deletions

View File

@@ -771,6 +771,8 @@ interface GangGenInfo {
respect: number;
/** Respect earned per game cycle */
respectGainRate: number;
/** Amount of Respect needed for next gang recruit, if possible */
respectForNextRecruit: number;
/** Amount of territory held */
territory: number;
/** Clash chance */
@@ -3397,6 +3399,18 @@ export interface Gang {
*/
getMemberNames(): string[];
/**
* Rename a Gang member to a new unique name.
* @remarks
* RAM cost: 0 GB
*
* Rename a Gang Member if none already has the new name.
* @param memberName - Name of the member to change.
* @param newName - New name for that gang member.
* @returns True if successful, and false if not.
*/
renameMember(memberName: string, newName: string): boolean;
/**
* Get information about your gang.
* @remarks
@@ -3450,6 +3464,26 @@ export interface Gang {
*/
canRecruitMember(): boolean;
/**
* Check how many gang members you can currently recruit.
* @remarks
* RAM cost: 1 GB
*
* @returns Number indicating how many members can be recruited,
* considering current reputation and gang size.
*/
getRecruitsAvailable(): number;
/**
* Check the amount of Respect needed for your next gang recruit.
* @remarks
* RAM cost: 1 GB
*
* @returns The static number value of Respect needed for the next
* recruit, with consideration to your current gang size.
* Returns `Infinity` if you have reached the gang size limit.
*/
respectForNextRecruit(): number;
/**
* Recruit a new gang member.
* @remarks