API V5

ShowQuestion and AnswerResultReceived should only be used by developers who are given permission to use the Question Overlay.

Initialization

Method

Description

LOLSDK.Init

Generates a new LOLSDK Singleton instance. Must be called before any of the following methods.

Subscribe

Event (LOLSDK.Instance.__)

Payload Sent to Subscribers (LoLSDK.)

Description

Added

StartGameReceived

string json

Game initialization payload

V2

LanguageDefsReceived

string json

Receive Game Text

V2

AnswerResultReceived

string json

Question overlay complete

V4

Publish

Method (LOLSDK.Instance)

Purpose

Added

GameIsReady

Game Lifecycle

Game indicates it is ready to begin. Fire this after all subscriptions have been registered

V1

Complete

Game Lifecycle

Game indicates it has completed

V1

LoadingProgress

Game Lifecycle

Game submits loading progress

V1

SubmitProgress

Reporting

Game submits at least 8 progress points throughout the game

V1

SpeakText

Speech

Speaks a language string identified by key. Will auto-cancel any currently running text to speech. No need to call CancelSpeakText before this call.

V2

CancelSpeakText

Speech

Cancels the current text to speech. Useful when switching scenes or ui panels where the user could have started a long running text to speech but is no longer viewing the text.

V5

ShowQuestion

Questions

Platform displays an overlay with an LoL question

V4

SaveState

State

Game submits state data to save on the LoL server (or local)

V5

LoadState

State

Game checks for previously saved state data and provides a callback to process the state

V5

Last updated