W3Booster SDK 2.0.0
First app
Guides
Examples
Preparing search index...
index
W3BoosterEventMap
Interface W3BoosterEventMap<TSettings, TOverlayExtensions>
interface
W3BoosterEventMap
<
TSettings
extends
object
=
JsonObject
,
TOverlayExtensions
extends
object
=
object
,
>
{
"application.settings.changed"
:
{
application
?:
ApplicationState
<
TSettings
>
;
previousSettings
:
DeepReadonly
<
TSettings
>
|
undefined
;
settings
:
DeepReadonly
<
TSettings
>
|
undefined
;
state
:
MatchState
<
TSettings
,
TOverlayExtensions
>
;
}
;
"hero.abilities.changed"
:
HeroEvent
<
TSettings
,
TOverlayExtensions
>
&
{
abilities
:
readonly
HeroAbility
[]
;
previousAbilities
:
readonly
HeroAbility
[]
;
}
;
"hero.added"
:
HeroEvent
<
TSettings
,
TOverlayExtensions
>
;
"hero.changed"
:
HeroChangedEvent
<
TSettings
,
TOverlayExtensions
>
;
"hero.inventory.changed"
:
HeroEvent
<
TSettings
,
TOverlayExtensions
>
&
{
inventory
:
readonly
string
[]
;
previousInventory
:
readonly
string
[]
;
}
;
"hero.removed"
:
HeroEvent
<
TSettings
,
TOverlayExtensions
>
;
issue
:
W3BoosterIssue
;
"match.changed"
:
MatchChangedEvent
<
TSettings
,
TOverlayExtensions
>
;
"match.ended"
:
MatchLifecycleEvent
<
TSettings
,
TOverlayExtensions
>
;
"match.started"
:
MatchLifecycleEvent
<
TSettings
,
TOverlayExtensions
>
;
"player.added"
:
PlayerEvent
<
TSettings
,
TOverlayExtensions
>
;
"player.changed"
:
PlayerChangedEvent
<
TSettings
,
TOverlayExtensions
>
;
"player.removed"
:
PlayerEvent
<
TSettings
,
TOverlayExtensions
>
;
"player.resources.changed"
:
PlayerEvent
<
TSettings
,
TOverlayExtensions
>
&
{
previousResources
?:
Resources
;
resources
?:
Resources
;
}
;
"player.stats.changed"
:
PlayerEvent
<
TSettings
,
TOverlayExtensions
>
&
{
previousStats
?:
PlayerStatsCollection
;
stats
?:
PlayerStatsCollection
;
}
;
"player.upgrades.changed"
:
PlayerEvent
<
TSettings
,
TOverlayExtensions
>
&
{
previousUpgrades
?:
UpgradeState
;
upgrades
?:
UpgradeState
;
}
;
"state.changed"
:
StateChangedEvent
<
TSettings
,
TOverlayExtensions
>
;
"state.ready"
:
{
state
:
MatchState
<
TSettings
,
TOverlayExtensions
>
}
;
status
:
ConnectionStatus
;
"stream.gap"
:
{
expected
:
number
;
received
:
number
}
;
}
Type Parameters
TSettings
extends
object
=
JsonObject
TOverlayExtensions
extends
object
=
object
Index
Properties
application.settings.changed
hero.abilities.changed
hero.added
hero.changed
hero.inventory.changed
hero.removed
issue
match.changed
match.ended
match.started
player.added
player.changed
player.removed
player.resources.changed
player.stats.changed
player.upgrades.changed
state.changed
state.ready
status
stream.gap
Properties
application.settings.changed
"application.settings.changed"
:
{
application
?:
ApplicationState
<
TSettings
>
;
previousSettings
:
DeepReadonly
<
TSettings
>
|
undefined
;
settings
:
DeepReadonly
<
TSettings
>
|
undefined
;
state
:
MatchState
<
TSettings
,
TOverlayExtensions
>
;
}
hero.abilities.changed
"hero.abilities.changed"
:
HeroEvent
<
TSettings
,
TOverlayExtensions
>
&
{
abilities
:
readonly
HeroAbility
[]
;
previousAbilities
:
readonly
HeroAbility
[]
;
}
hero.added
"hero.added"
:
HeroEvent
<
TSettings
,
TOverlayExtensions
>
hero.changed
"hero.changed"
:
HeroChangedEvent
<
TSettings
,
TOverlayExtensions
>
hero.inventory.changed
"hero.inventory.changed"
:
HeroEvent
<
TSettings
,
TOverlayExtensions
>
&
{
inventory
:
readonly
string
[]
;
previousInventory
:
readonly
string
[]
;
}
hero.removed
"hero.removed"
:
HeroEvent
<
TSettings
,
TOverlayExtensions
>
issue
issue
:
W3BoosterIssue
match.changed
"match.changed"
:
MatchChangedEvent
<
TSettings
,
TOverlayExtensions
>
match.ended
"match.ended"
:
MatchLifecycleEvent
<
TSettings
,
TOverlayExtensions
>
match.started
"match.started"
:
MatchLifecycleEvent
<
TSettings
,
TOverlayExtensions
>
player.added
"player.added"
:
PlayerEvent
<
TSettings
,
TOverlayExtensions
>
player.changed
"player.changed"
:
PlayerChangedEvent
<
TSettings
,
TOverlayExtensions
>
player.removed
"player.removed"
:
PlayerEvent
<
TSettings
,
TOverlayExtensions
>
player.resources.changed
"player.resources.changed"
:
PlayerEvent
<
TSettings
,
TOverlayExtensions
>
&
{
previousResources
?:
Resources
;
resources
?:
Resources
;
}
player.stats.changed
"player.stats.changed"
:
PlayerEvent
<
TSettings
,
TOverlayExtensions
>
&
{
previousStats
?:
PlayerStatsCollection
;
stats
?:
PlayerStatsCollection
;
}
player.upgrades.changed
"player.upgrades.changed"
:
PlayerEvent
<
TSettings
,
TOverlayExtensions
>
&
{
previousUpgrades
?:
UpgradeState
;
upgrades
?:
UpgradeState
;
}
state.changed
"state.changed"
:
StateChangedEvent
<
TSettings
,
TOverlayExtensions
>
state.ready
"state.ready"
:
{
state
:
MatchState
<
TSettings
,
TOverlayExtensions
>
}
status
status
:
ConnectionStatus
stream.gap
"stream.gap"
:
{
expected
:
number
;
received
:
number
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
application.settings.changed
hero.abilities.changed
hero.added
hero.changed
hero.inventory.changed
hero.removed
issue
match.changed
match.ended
match.started
player.added
player.changed
player.removed
player.resources.changed
player.stats.changed
player.upgrades.changed
state.changed
state.ready
status
stream.gap
First app
Guides
Examples
W3Booster SDK 2.0.0
Loading...