Kongregate.KongregateInitBase Class Reference

Base class to help manage interactions with the Kongregate SDK. More...

Public Member Functions
virtual void	OnEnable ()
	The KongregateAPI will be initialized when the associated game object is enabled.

Static Public Member Functions
static void	SetCommonPropsCallback (delegateGetCommonProperties callback)
	Static helper that will pass the callback to IAnalytics.SetCommonPropsCallback when initialization starts.

Protected Member Functions
abstract void	ConfigureAPISettings ()
	Override this method if you prefer to set the API settings in code rather than the Unity inspector, or if you need add legacy settings not included as inspector variables.

Events
static Action	eventInitializing
	Fired when the KongregateInit begins initializing the Kongregate API.
static Action	eventReady
	See KongregateAPI.KONGREGATE_EVENT_READY.
static Action	eventUserChanged
	See KongregateAPI.KONGREGATE_EVENT_USER_CHANGED.
static Action	eventGameAuthChanged
	See KongregateAPI.KONGREGATE_EVENT_GAME_AUTH_CHANGED.
static Action	eventLoginComplete
	See KongregateAPI.KONGREGATE_EVENT_LOGIN_COMPLETE.
static Action	eventOpenPanel
	See KongregateAPI.KONGREGATE_EVENT_OPENING.
static Action	eventClosePanel
	See KongregateAPI.KONGREGATE_EVENT_CLOSED.
static Action	eventUserInventory
	See KongregateAPI.KONGREGATE_EVENT_USER_INVENTORY.
static Action	eventServiceUnavailable
	See KongregateAPI.KONGREGATE_EVENT_SERVICE_UNAVAILABLE.
static Action	eventReceiptVerificationComplete
	See KongregateAPI.KONGREGATE_EVENT_RECEIPT_VERIFICATION_COMPLETE.
static Action	eventSwrveResourceUpdate
	See KongregateAPI.KONGREGATE_EVENT_SWRVE_RESOURCES_UPDATES.
static Action	eventNotificationCountUpdate
	See KongregateAPI.KONGREGATE_EVENT_NOTIFICATION_COUNT_UPDATED.
static Action< string, string >	eventPanelMessage
	Event fired through the Kongregate Panel. More...

Detailed Description

Base class to help manage interactions with the Kongregate SDK.

See KongregateInit for the concrete subclass that handles the initialization of the Kongregate SDK from the JSON file provided by Kongregate.

KongregateManager is a deprecated class that initializes the SDK from values set in the inspector. This class is still supported, however we recommend using KongregateInit in its place.

KongregateGameObject-Example.cs is an example implementation initializing and interacting with the Kongregate SDK directly. It is still maintained for legacy games that followed this approach.

Event Documentation

eventPanelMessage

Action<string,string> Kongregate.KongregateInitBase.eventPanelMessage

static

Event fired through the Kongregate Panel.

Since the panel is hosted on Kongregate.com, events of this type may be added outside of SDK updates and do not have corresponding constants defined in our API package.

---

The documentation for this class was generated from the following file:

• KongregateInitBase.cs