Skip to main content
Corvus Connection

RPG: Use Item

Rpg
Action
Portent preview
Pro
rpg.useItemUses (consumes) a consumable the viewer holds, applying its effects. Defaults to the triggering viewer; set userId to target a specific viewer. Safely no-ops when the item is not held or not usable.Consumes one held copy of an item and applies its effects; binds used.
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
used
Data
System.Boolean
multiplexed
  • Name
    out
    Kind
    Exec
    Type
    exec
    Flags
    None
  • Name
    used
    Kind
    Data
    Type
    System.Boolean
    Flags
    multiplexed

Parameters

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

Lowers to C#

var used = await ctx.Rpg.Characters.ConsumeItemAsync(userId, itemSlug);