Package de.jcm.discordgamesdk

Class Core

java.lang.Object

de.jcm.discordgamesdk.Core

All Implemented Interfaces:

AutoCloseable

public class Core
extends Object
implements AutoCloseable

The main component for accessing Discord's game SDK.

Author:

JCM

See Also:

• https://discordapp.com/developers/docs/game-sdk/discord#functions-in-the-sdk

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Core.CorePrivate

Field Summary

Fields

Modifier and Type	Field	Description
static final Consumer<Result>	DEFAULT_CALLBACK	Default callback to use for operation returning a Result.
static final BiConsumer<LogLevel,String>	DEFAULT_LOG_HOOK	Default log hook.

Constructor Summary

Constructors

Constructor	Description
Core(CreateParams params)	Creates an instance of the SDK from CreateParams and sets the log hook to DEFAULT_LOG_HOOK.

Method Summary

Modifier and Type	Method	Description
ActivityManager	activityManager()	Returns the ActivityManager associated with this core.
ApplicationManager	applicationManager()	Returns the ApplicationManager associated with this core.
void	close()	Closes and destroys the instance.
static final de.jcm.discordgamesdk.impl.channel.DiscordChannel	getDiscordChannel()
ImageManager	imageManager()	Returns the ImageManager associated with this core.
boolean	isDiscordRunning()
boolean	isOpen()	Returns true if this Core instance is open, i.e.
OverlayManager	overlayManager()	Returns the OverlayManager associated with this core.
RelationshipManager	relationshipManager()	Returns the RelationshipManager associated with this core.
void	runCallbacks()	Listens for new events and runs pending callbacks.
void	setLogHook(LogLevel minLevel, BiConsumer<LogLevel,String> logHook)	Registers a log function.
UserManager	userManager()	Returns the UserManager associated with this core.
VoiceManager	voiceManager()	Returns the VoiceManager associated with this core.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_CALLBACK

public static final Consumer<Result> DEFAULT_CALLBACK

Default callback to use for operation returning a Result.

Checks if the result is Result.OK and throws a GameSDKException if it is not.

DEFAULT_LOG_HOOK

public static final BiConsumer<LogLevel,String> DEFAULT_LOG_HOOK

Default log hook. Simply prints the log message in pattern "[level] message" to System.out.

Constructor Details

Core

public Core(CreateParams params)

Creates an instance of the SDK from CreateParams and sets the log hook to DEFAULT_LOG_HOOK.

Example:

  try(CreateParams params = new CreateParams())
  {
      params.setClientID(<client ID of your application>);
      params.setFlags(CreateParams.getDefaultFlags());
      try(Core core = new Core(params))
      {
          // do something with your Core
      }
  }

Parameters:

params - Parameters to create Core from.

See Also:

• https://discordapp.com/developers/docs/game-sdk/discord#create

Method Details

getDiscordChannel

public static final de.jcm.discordgamesdk.impl.channel.DiscordChannel getDiscordChannel()
                                                                                 throws IOException

Throws:

IOException

activityManager

public ActivityManager activityManager()

Returns the ActivityManager associated with this core.

An ActivityManager is used to set the User's activity/status.

Returns:

An ActivityManager

See Also:

• https://discordapp.com/developers/docs/game-sdk/discord#getactivitymanager

applicationManager

public ApplicationManager applicationManager()

Returns the ApplicationManager associated with this core.

An ApplicationManager is used to obtain an OAuth2 token for the application.

Returns:

An ApplicationManager

See Also:

• https://discordapp.com/developers/docs/game-sdk/discord#getapplicationmanager

userManager

public UserManager userManager()

Returns the UserManager associated with this core.

A UserManager is used to receive information about Discord users.

Returns:

A UserManager

See Also:

• https://discordapp.com/developers/docs/game-sdk/discord#getusermanager

overlayManager

public OverlayManager overlayManager()

Returns the OverlayManager associated with this core.

An OverlayManager is used to control the overlay for this game.

Returns:

An OverlayManager

See Also:

• https://discordapp.com/developers/docs/game-sdk/discord#getoverlaymanager

relationshipManager

public RelationshipManager relationshipManager()

Returns the RelationshipManager associated with this core.

A RelationshipManager is used to receive information about the user's relationships with other Discord users (e.g. friends).

Returns:

A RelationshipManager

See Also:

• https://discordapp.com/developers/docs/game-sdk/discord#getrelationshipmanager

imageManager

public ImageManager imageManager()

Returns the ImageManager associated with this core.

An ImageManager is used to fetch images and information about images (dimensions) from Discord (mainly avatars).

Returns:

An ImageManager

See Also:

• https://discordapp.com/developers/docs/game-sdk/discord#getimagemanager

voiceManager

public VoiceManager voiceManager()

Returns the VoiceManager associated with this core.

A VoiceManager is used to control Discord Lobby voice channels. It can be used to configure input modes, to mute and deaf the current user, to locally mute other users and to locally adjust their volume.

Returns:

A VoiceManager

See Also:

• https://discord.com/developers/docs/game-sdk/discord#getvoicemanager

runCallbacks

public void runCallbacks()

Listens for new events and runs pending callbacks.

This method should be called in a main loop every few millis.

See Also:

• https://discordapp.com/developers/docs/game-sdk/discord#runcallbacks

isDiscordRunning

public boolean isDiscordRunning()

setLogHook

public void setLogHook(LogLevel minLevel,
 BiConsumer<LogLevel,String> logHook)

Registers a log function.

Parameters:

minLevel - Minimal level of message to receive.

logHook - Hook to send log messages to.

See Also:

• DEFAULT_LOG_HOOK
• https://discordapp.com/developers/docs/game-sdk/discord#setloghook

isOpen

public boolean isOpen()

Returns true if this Core instance is open, i.e. close() has not been called yet. Calling certain SDK methods will throw CoreClosedException if the Core is not open.

Returns:

True if this Core is still open, false otherwise

close

public void close()

Closes and destroys the instance.

This should be called at the end of the program.

Specified by:

close in interface AutoCloseable

See Also:

• https://discordapp.com/developers/docs/game-sdk/discord#destroy