Skip to main content
Corvus Connection

RPG: Get Character

Rpg
Query
Portent preview
Pro
rpg.getCharacterReads a viewer's character: join state, luck (Fortune), and any pending one-shot next-fight modifier. Defaults to the triggering viewer; set userId to target a specific viewer. Safely reports not-joined when the viewer has no character.Awaits the viewer's character, Fortune, and pending modifier; binds hasJoined / displayName / fortune / hasPendingModifier / pendingModifierStat / pendingModifierAmount.
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
hasJoined
Data
System.Boolean
multiplexed
displayName
Data
System.String
multiplexed
fortune
Data
System.Int32
multiplexed
hasPendingModifier
Data
System.Boolean
multiplexed
pendingModifierStat
Data
System.String
multiplexed
pendingModifierAmount
Data
System.Int32
multiplexed
  • Name
    out
    Kind
    Exec
    Type
    exec
    Flags
    None
  • Name
    hasJoined
    Kind
    Data
    Type
    System.Boolean
    Flags
    multiplexed
  • Name
    displayName
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    fortune
    Kind
    Data
    Type
    System.Int32
    Flags
    multiplexed
  • Name
    hasPendingModifier
    Kind
    Data
    Type
    System.Boolean
    Flags
    multiplexed
  • Name
    pendingModifierStat
    Kind
    Data
    Type
    System.String
    Flags
    multiplexed
  • Name
    pendingModifierAmount
    Kind
    Data
    Type
    System.Int32
    Flags
    multiplexed

Parameters

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

Lowers to C#

var character = await ctx.Rpg.Characters.GetAsync(userId);