Skip to main content
Corvus Connection

RPG: Explore

Rpg
Action
Portent preview
Pro
rpg.exploreExplores an encounter pool (the streamer's default when poolSlug is unset) and resolves the picked encounter for a viewer. Defaults to the triggering viewer; set userId to target a specific viewer. Safely no-ops when no pool is configured.Explores a pool and resolves the picked encounter; binds encounterSlug plus the encounter outcome.
Engagement

Inputs

Name
Kind
Type
Flags
in
Exec
exec
multiplexed
  • Name
    in
    Kind
    Exec
    Type
    exec
    Flags
    multiplexed

Outputs

Name
Kind
Type
Flags
out
Exec
exec
None
encounterSlug
Data
System.String
multiplexed
won
Data
System.Boolean
multiplexed
routed
Data
System.Boolean
multiplexed
total
Data
System.Int32
multiplexed
difficultyClass
Data
System.Int32
multiplexed
gotLoot
Data
System.Boolean
multiplexed
lootItemName
Data
System.String
multiplexed
lootRarity
Data
System.String
multiplexed
  • Name
    out
    Kind
    Exec
    Type
    exec
    Flags
    None
  • Name
    encounterSlug
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    won
    Kind
    Data
    Type
    System.Boolean
    Flags
    multiplexed
  • Name
    routed
    Kind
    Data
    Type
    System.Boolean
    Flags
    multiplexed
  • Name
    total
    Kind
    Data
    Type
    System.Int32
    Flags
    multiplexed
  • Name
    difficultyClass
    Kind
    Data
    Type
    System.Int32
    Flags
    multiplexed
  • Name
    gotLoot
    Kind
    Data
    Type
    System.Boolean
    Flags
    multiplexed
  • Name
    lootItemName
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    lootRarity
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed

Parameters

Name
Type
Required
Default
Choices
poolSlug
System.String
no
""
None
userId
System.String
no
""
None
  • Name
    poolSlug
    Type
    System.String
    Required
    no
    Default
    ""
    Choices
    None
  • Name
    userId
    Type
    System.String
    Required
    no
    Default
    ""
    Choices
    None

Lowers to C#

var explore = await ctx.Rpg.Encounters.ExploreAsync(userId, poolSlug);