Package live.crowdcontrol.cc4j

Interface CCEffect

All Known Subinterfaces:
CCTimedEffect
public interface CCEffect
An effect which a viewer can purchase to perform an action.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    EFFECT_ID_PATTERN
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    onTrigger(@NotNull PublicEffectPayload request, @NotNull CCPlayer source)
    Triggers this effect.

  • Field Details

  • Method Details

    • onTrigger

      void onTrigger(@NotNull @NotNull PublicEffectPayload request, @NotNull @NotNull CCPlayer source)
      Triggers this effect. To respond to it, call CCPlayer.sendResponse(CCEffectResponse). Please note that if you fail to emit a terminating response within 60 seconds then a failure response will be produced for you.
      Parameters:
      request - the request responsible for invoking this effect
      source - the player whose connection originated this request