Discord RPC - MarklyThomas/Secret-Repo GitHub Wiki

Introduction:

To change the character name displayed during the game in your Discord profile, use string ExtraChar.getCharacterName(u8 xtrachar) function.

This function will also automatically display your character's name, along with the number of emeralds collected, so that apart from specifying the name, you don't need anything else.

Usage example:

Return a string with the name to check with your character ID.

// Returns the name of active Extra character.
function string ExtraChar.getCharacterName(u8 xtrachar)
{
	// Shadow's check
	if (xtrachar == 0x05)
		return "Shadow"
	
	// Call the base function
	return base.ExtraChar.getCharacterName(xtrachar)
}

Force To Update

Description:
Optional special function, for characters, with combinations (partner) support

NOTE: This is a special, optional feature. Use only if you know what you're doing.

Introduction:

You can also force a Discord RPC update for non-Extra characters, but for character partners [1], like Extra Slot Ray.

To do this, use bool ExtraChar.RPCManager.checkForceToUpdate() function.

Usage example:

Return true for the states when the Discord RPC needs to be updated. For example, Extra Slot Ray can be a partner for Sonic, Knuckles, and for Extra Slot Mighty.

// The function forcibly updates the Discord RPC.
function bool ExtraChar.RPCManager.checkForceToUpdate()
{
	// Only for main game
	if (global.game_mode == 0x8c)
	{
		if (global.characters == CHARS_SONIC_AND_TAILS && (Ray_Partner == 0x01 || Ray_Partner == 0x04))
			return true
		else if ((useKnucklesAndTails || global.characters == CHARS_KNUCKLES_AND_TAILS) && (Ray_Partner == 0x02 || Ray_Partner == 0x04))
			return true
	}
	
	// Call the base function
	return base.ExtraChar.RPCManager.checkForceToUpdate()
}

Now, when the RPC is updated for the partner character, we need to specify the name displayed in your profile. Just add the same checks as in the forced update function, for string ExtraChar.getCharacterName(u8 xtrachar), but return the name of your character in combination.

// Only for main game
if (global.game_mode == 0x8c)
{
	if (global.characters == CHARS_SONIC_AND_TAILS && (Ray_Partner == 0x01 || Ray_Partner == 0x04))
		return "Sonic & Ray"
	else if ((useKnucklesAndTails || global.characters == CHARS_KNUCKLES_AND_TAILS) && (Ray_Partner == 0x02 || Ray_Partner == 0x04))
		return "Knuckles & Ray"
}

Usage example:

// Returns the name of active Extra character.
function string ExtraChar.getCharacterName(u8 xtrachar)
{
	// Ray's check
	if (xtrachar == 0x02) // As active Extra character
		return "Ray"
	
	// Only for main game
	if (global.game_mode == 0x8c) // As Partner character
	{
		if (global.characters == CHARS_SONIC_AND_TAILS && (Ray_Partner == 0x01 || Ray_Partner == 0x04))
			return "Sonic & Ray"
		else if ((useKnucklesAndTails || global.characters == CHARS_KNUCKLES_AND_TAILS) && (Ray_Partner == 0x02 || Ray_Partner == 0x04))
			return "Knuckles & Ray"
	}
	
	// Call the base function
	return base.ExtraChar.getCharacterName(xtrachar)
j

[1] The partner system is not part of the framework at the moment, but it is in the plans for updating in the future.

Go to top

⚠️ **GitHub.com Fallback** ⚠️