Package

net.katsstuff.scammander

sponge

Permalink

package sponge

Linear Supertypes
SpongeBaseAllEither, SpongeBaseAll, SpongeHelpCommands, HelpCommands, SpongeOrParameter, SpongeParameter, SpongeValidators, ScammanderBaseAll, OrNowParameter, OrParameters, FlagParameters, HelperParameters, ParameterLabelledDeriver, scammander.ParameterDeriver, NormalParameters, SpongeBase, ScammanderBase, ScammanderTypes, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. sponge
  2. SpongeBaseAllEither
  3. SpongeBaseAll
  4. SpongeHelpCommands
  5. HelpCommands
  6. SpongeOrParameter
  7. SpongeParameter
  8. SpongeValidators
  9. ScammanderBaseAll
  10. OrNowParameter
  11. OrParameters
  12. FlagParameters
  13. HelperParameters
  14. ParameterLabelledDeriver
  15. ParameterDeriver
  16. NormalParameters
  17. SpongeBase
  18. ScammanderBase
  19. ScammanderTypes
  20. AnyRef
  21. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type BaseStaticChildCommand = ComplexStaticChildCommand[G, RootSender, RunExtra, TabExtra, ResultTpe, StaticChildCommand]

    Permalink
    Definition Classes
    ScammanderBase
  2. case class BooleanFlag[Name <: String] extends Product with Serializable

    Permalink
    Definition Classes
    FlagParameters
  3. type ChildCommand = ComplexChildCommand[StaticChildCommand]

    Permalink
    Definition Classes
    ScammanderBase
  4. class Command[Sender, Param] extends ComplexCommand

    Permalink
    Definition Classes
    ScammanderBase
  5. type CommandFailure = scammander.CommandFailure

    Permalink
    Definition Classes
    ScammanderTypes
  6. type CommandFailureNEL = NonEmptyList[CommandFailure]

    Permalink
    Definition Classes
    ScammanderTypes
  7. type CommandSuccess = scammander.CommandSuccess[ResultTpe]

    Permalink
    Definition Classes
    ScammanderBase
  8. type ComplexCommand = scammander.ComplexCommand[G, RootSender, RunExtra, TabExtra, ResultTpe, StaticChildCommand]

    Permalink
    Definition Classes
    ScammanderBase
  9. case class DynamicCommand[Args, Identifier, Sender, Param] extends Product with Serializable

    Permalink
    Definition Classes
    ScammanderBase
  10. case class Flags[A, B] extends Product with Serializable

    Permalink
    Definition Classes
    FlagParameters
  11. abstract type G[_]

    Permalink
    Definition Classes
    ScammanderBase
  12. class GetDynamicCommandType[Args, Identifier, Sender, Param] extends AnyRef

    Permalink
    Definition Classes
    ScammanderBase
  13. type HasName[A] = scammander.HasName[A]

    Permalink
    Definition Classes
    ScammanderTypes
  14. case class Named[Name <: String, A] extends Product with Serializable

    Permalink
    Definition Classes
    ScammanderBase
  15. case class NamedCommand[Args, Identifier, Sender, Param] extends Product with Serializable

    Permalink
    Definition Classes
    ScammanderBase
  16. case class NeedPermission[S <: String, A](value: A) extends Product with Serializable

    Permalink

    A class to use for parameter that should require a specific permission.

    A class to use for parameter that should require a specific permission.

    Definition Classes
    SpongeParameter
  17. trait NotUsed extends AnyRef

    Permalink
    Definition Classes
    ScammanderBase
  18. sealed trait Now extends AnyRef

    Permalink
    Definition Classes
    OrNowParameter
  19. case class OneOrMore[A] extends Product with Serializable

    Permalink
    Definition Classes
    HelperParameters
  20. case class OnlyOne[A] extends Product with Serializable

    Permalink
    Definition Classes
    HelperParameters
  21. case class Or[Base, Context] extends Product with Serializable

    Permalink
    Definition Classes
    OrParameters
  22. type OrNow[Base] = (OrNowParameter.this)#Or[Base, (OrNowParameter.this)#Now]

    Permalink
    Definition Classes
    OrNowParameter
  23. type OrSource[Base] = (OrParameters.this)#Or[Base, (OrParameters.this)#Source]

    Permalink
    Definition Classes
    OrParameters
  24. type OrTarget[Base] = (SpongeOrParameter.this)#Or[Base, (SpongeOrParameter.this)#Target]

    Permalink
    Definition Classes
    SpongeOrParameter
  25. trait Parameter[A] extends ComplexParameter[A, RootSender, RunExtra, TabExtra]

    Permalink
    Definition Classes
    ScammanderBase
  26. class ParameterDeriver[A] extends AnyRef

    Permalink
    Definition Classes
    ParameterLabelledDeriver
  27. type ParserError[F[_]] = ApplicativeHandle[F, CommandFailureNEL]

    Permalink
    Definition Classes
    ScammanderTypes
  28. type ParserState[F[_]] = MonadState[F, List[RawCmdArg]]

    Permalink
    Definition Classes
    ScammanderTypes
  29. trait ProxyParameter[A, B] extends Parameter[A]

    Permalink
    Definition Classes
    ScammanderBase
  30. type RawCmdArg = scammander.RawCmdArg

    Permalink
    Definition Classes
    ScammanderTypes
  31. case class RemainingAsString extends Product with Serializable

    Permalink
    Definition Classes
    HelperParameters
  32. type Result = Either[ScammanderBase.CommandFailureNEL, CommandSuccess]

    Permalink
    Definition Classes
    ScammanderBase
  33. implicit class ResultExtra extends AnyRef

    Permalink
    Definition Classes
    ScammanderBase
  34. abstract type ResultTpe

    Permalink
    Definition Classes
    ScammanderBase
  35. implicit class RichCommand[Sender, Param] extends AnyRef

    Permalink
    Definition Classes
    SpongeBase
  36. abstract type RootSender

    Permalink
    Definition Classes
    ScammanderBase
  37. abstract type RunExtra

    Permalink
    Definition Classes
    ScammanderBase
  38. sealed trait Source extends AnyRef

    Permalink
    Definition Classes
    OrParameters
  39. abstract type StaticChildCommand <: BaseStaticChildCommand

    Permalink
    Definition Classes
    ScammanderBase
  40. abstract type TabExtra

    Permalink
    Definition Classes
    ScammanderBase
  41. sealed trait Target extends AnyRef

    Permalink

    Used with Or to get what the sender is targeting.

    Used with Or to get what the sender is targeting.

    Definition Classes
    SpongeOrParameter
  42. trait Targeter[A] extends AnyRef

    Permalink

    A typeclass which returns what the sender is currently targeting.

    A typeclass which returns what the sender is currently targeting.

    Definition Classes
    SpongeOrParameter
  43. abstract type Title

    Permalink
    Definition Classes
    HelpCommands
  44. type UserValidator[A] = ComplexUserValidator[A, RootSender]

    Permalink
    Definition Classes
    ScammanderBase
  45. case class ValueFlag[Name <: String, A] extends Product with Serializable

    Permalink
    Definition Classes
    FlagParameters
  46. case class ZeroOrMore[A] extends Product with Serializable

    Permalink
    Definition Classes
    HelperParameters

Abstract Value Members

  1. abstract def G: MonadError[sponge.components.SpongeBase.G, sponge.components.SpongeBase.CommandFailureNEL]

    Permalink
    Attributes
    protected
    Definition Classes
    SpongeBase
  2. abstract val defaultCommandSuccess: ResultTpe

    Permalink
    Attributes
    protected
    Definition Classes
    ScammanderBase
  3. abstract def runG[A](computation: sponge.components.SpongeBase.G[A]): Either[sponge.components.SpongeBase.CommandFailureNEL, A]

    Permalink
    Attributes
    protected
    Definition Classes
    SpongeBase
  4. abstract def sendCommandHelp(title: (HelpCommands.this)#Title, source: (HelpCommands.this)#RootSender, command: (HelpCommands.this)#StaticChildCommand, path: List[String]): (HelpCommands.this)#G[(HelpCommands.this)#CommandSuccess]

    Permalink
    Definition Classes
    HelpCommands
  5. abstract def sendMultipleCommandHelp(title: (HelpCommands.this)#Title, source: (HelpCommands.this)#RootSender, commands: Set[(HelpCommands.this)#ChildCommand]): (HelpCommands.this)#G[(HelpCommands.this)#CommandSuccess]

    Permalink
    Definition Classes
    HelpCommands
  6. abstract def tabExtraToRunExtra(extra: TabExtra): RunExtra

    Permalink
    Attributes
    protected
    Definition Classes
    ScammanderBase

Concrete Value Members

  1. object Alias

    Permalink

    Helper for creating an alias when registering a command.

    Helper for creating an alias when registering a command.

    Definition Classes
    SpongeBase
  2. val ChildCommand: ComplexChildCommand.type

    Permalink
    Definition Classes
    ScammanderBase
  3. object Description

    Permalink

    Helper for creating an description when registering a command.

    Helper for creating an description when registering a command.

    Definition Classes
    SpongeBase
  4. def GE: ApplicativeHandle[sponge.components.SpongeBase.G, sponge.components.SpongeBase.CommandFailureNEL]

    Permalink
    Definition Classes
    SpongeBase
  5. val HasName: scammander.HasName.type

    Permalink
    Definition Classes
    ScammanderTypes
  6. object Help

    Permalink

    Helper for creating a help when registering a command.

    Helper for creating a help when registering a command.

    Definition Classes
    SpongeBase
  7. object OnlyOne extends Serializable

    Permalink
    Definition Classes
    HelperParameters
  8. object Parameter

    Permalink
    Definition Classes
    ScammanderBase
  9. object Permission

    Permalink

    Helper for creating a alias when registering a command.

    Helper for creating a alias when registering a command.

    Definition Classes
    SpongeBase
  10. val RawCmdArg: scammander.RawCmdArg.type

    Permalink
    Definition Classes
    ScammanderTypes
  11. object Result

    Permalink
    Definition Classes
    ScammanderTypes
  12. object Targeter

    Permalink
    Definition Classes
    SpongeOrParameter
  13. implicit val allPlayerParam: (SpongeParameter.this)#Parameter[Set[Player]]

    Permalink
    Definition Classes
    SpongeParameter
  14. implicit val bigDecimalParam: (NormalParameters.this)#Parameter[BigDecimal]

    Permalink
    Definition Classes
    NormalParameters
  15. implicit val bigIntParam: (NormalParameters.this)#Parameter[BigInt]

    Permalink
    Definition Classes
    NormalParameters
  16. implicit val boolParam: (NormalParameters.this)#Parameter[Boolean]

    Permalink
    Definition Classes
    NormalParameters
  17. implicit def booleanFlagParameter[Name <: String](implicit witness: Aux[Name]): (FlagParameters.this)#Parameter[(FlagParameters.this)#BooleanFlag[Name]]

    Permalink
    Definition Classes
    FlagParameters
  18. implicit val byteParam: (NormalParameters.this)#Parameter[Byte]

    Permalink
    Definition Classes
    NormalParameters
  19. implicit def cConsLabelledParam[HK <: Symbol, HV, T <: Coproduct](implicit hName: Aux[HK], hParam: Lazy[(ParameterLabelledDeriver.this)#Parameter[HV]], tParam: Lazy[(ParameterLabelledDeriver.this)#Parameter[T]]): (ParameterLabelledDeriver.this)#Parameter[:+:[FieldType[HK, HV], T]]

    Permalink
    Definition Classes
    ParameterLabelledDeriver
  20. implicit def cConsParam[H, T <: Coproduct](implicit hParam: Lazy[(scammander.ParameterDeriver.this)#Parameter[H]], tParam: Lazy[(scammander.ParameterDeriver.this)#Parameter[T]]): (scammander.ParameterDeriver.this)#Parameter[:+:[H, T]]

    Permalink
    Definition Classes
    ParameterDeriver
  21. implicit val cNilParam: (scammander.ParameterDeriver.this)#Parameter[CNil]

    Permalink
    Definition Classes
    ParameterDeriver
  22. implicit def catalogTypeHasName[A <: CatalogType]: (SpongeParameter.this)#HasName[A]

    Permalink
    Definition Classes
    SpongeParameter
  23. implicit def catalogedParam[A <: CatalogType](implicit classTag: ClassTag[A], typeable: Typeable[A]): (SpongeParameter.this)#Parameter[Set[A]]

    Permalink
    Definition Classes
    SpongeParameter
  24. package components

    Permalink
  25. def createCommand[Sender, Param](runCmd: (Sender, RunExtra, Param) ⇒ G[CommandSuccess], childSet: Set[ChildCommand])(implicit arg0: UserValidator[Sender], arg1: Parameter[Param]): Command[Sender, Param]

    Permalink
    Attributes
    protected
    Definition Classes
    ScammanderBase
  26. def createCommandHelp(source: CommandSource, commandName: String, fullCommandName: String, command: (SpongeHelpCommands.this)#StaticChildCommand, detail: Boolean, indent: Int = 0, isIndentEnd: Boolean = false): Seq[Text]

    Permalink
    Definition Classes
    SpongeHelpCommands
  27. implicit val dataContainerParam: (SpongeParameter.this)#Parameter[DataContainer]

    Permalink
    Definition Classes
    SpongeParameter
  28. implicit val dateTimeOrNowParam: (OrNowParameter.this)#Parameter[(OrNowParameter.this)#Or[LocalDateTime, (OrNowParameter.this)#Now]]

    Permalink
    Definition Classes
    OrNowParameter
  29. implicit val dateTimeParam: (NormalParameters.this)#Parameter[LocalDateTime]

    Permalink
    Definition Classes
    NormalParameters
  30. implicit val doubleParam: (NormalParameters.this)#Parameter[Double]

    Permalink
    Definition Classes
    NormalParameters
  31. implicit val durationParam: (NormalParameters.this)#Parameter[Duration]

    Permalink
    Definition Classes
    NormalParameters
  32. def dynamicCommandOf[Args, Identifier, Sender, Param](command: (Args) ⇒ Command[Sender, Param], identifier: Identifier): GetDynamicCommandType[Args, Identifier, Sender, Param]

    Permalink
    Definition Classes
    ScammanderBase
  33. implicit def dynamicCommandParameter[Args, Identifier, Sender, Param](implicit cmd: NamedCommand[Args, Identifier, Sender, Param], validator: UserValidator[Sender], parameter: Parameter[Param]): Parameter[DynamicCommand[Args, Identifier, Sender, Param]]

    Permalink
    Definition Classes
    ScammanderBase
  34. implicit def entityParam[A <: Entity](implicit typeable: Typeable[A]): (SpongeParameter.this)#Parameter[Set[A]]

    Permalink
    Definition Classes
    SpongeParameter
  35. implicit def entitySender[A <: Entity](implicit arg0: Typeable[A]): (SpongeValidators.this)#UserValidator[A]

    Permalink
    Definition Classes
    SpongeValidators
  36. implicit def flagsParameter[A, B](implicit flagsParam: (FlagParameters.this)#Parameter[A], paramParam: (FlagParameters.this)#Parameter[B]): (FlagParameters.this)#Parameter[(FlagParameters.this)#Flags[A, B]]

    Permalink
    Definition Classes
    FlagParameters
  37. implicit val floatParam: (NormalParameters.this)#Parameter[Float]

    Permalink
    Definition Classes
    NormalParameters
  38. def genParam[A, Gen](implicit gen: Aux[A, Gen], genParam: Lazy[(ParameterLabelledDeriver.this)#Parameter[Gen]]): (ParameterLabelledDeriver.this)#Parameter[A]

    Permalink
    Definition Classes
    ParameterLabelledDeriver
  39. implicit def hConsLabelledParam[HK <: Symbol, HV, T <: HList](implicit hName: Aux[HK], hParam: Lazy[(ParameterLabelledDeriver.this)#Parameter[HV]], tParam: Lazy[(ParameterLabelledDeriver.this)#Parameter[T]]): (ParameterLabelledDeriver.this)#Parameter[::[FieldType[HK, HV], T]]

    Permalink
    Definition Classes
    ParameterLabelledDeriver
  40. implicit def hConsParam[H, T <: HList](implicit hParam: Lazy[(scammander.ParameterDeriver.this)#Parameter[H]], tParam: Lazy[(scammander.ParameterDeriver.this)#Parameter[T]]): (scammander.ParameterDeriver.this)#Parameter[::[H, T]]

    Permalink
    Definition Classes
    ParameterDeriver
  41. implicit val hNilParam: (scammander.ParameterDeriver.this)#Parameter[HNil]

    Permalink
    Definition Classes
    ParameterDeriver
  42. def helpCommand(title: (HelpCommands.this)#Title, commands: ⇒ Set[(HelpCommands.this)#ChildCommand])(implicit G: Monad[(HelpCommands.this)#G], E: (HelpCommands.this)#ParserError[(HelpCommands.this)#G]): (HelpCommands.this)#Command[(HelpCommands.this)#RootSender, (HelpCommands.this)#ZeroOrMore[String]]

    Permalink
    Definition Classes
    HelpCommands
  43. implicit val intParam: (NormalParameters.this)#Parameter[Int]

    Permalink
    Definition Classes
    NormalParameters
  44. implicit val ipParam: (SpongeParameter.this)#Parameter[InetAddress]

    Permalink
    Definition Classes
    SpongeParameter
  45. implicit val ipSender: (SpongeValidators.this)#UserValidator[InetAddress]

    Permalink
    Definition Classes
    SpongeValidators
  46. implicit val locationParam: (SpongeParameter.this)#Parameter[Set[Location[World]]]

    Permalink
    Definition Classes
    SpongeParameter
  47. implicit val locationSender: (SpongeValidators.this)#UserValidator[Location[World]]

    Permalink
    Definition Classes
    SpongeValidators
  48. implicit val longParam: (NormalParameters.this)#Parameter[Long]

    Permalink
    Definition Classes
    NormalParameters
  49. def mkSingle[A](parName: String, parser: (String) ⇒ A, possibleSuggestions: Eval[Seq[String]]): (NormalParameters.this)#Parameter[A]

    Permalink
    Definition Classes
    NormalParameters
  50. implicit def namedParam[Name <: String, A](implicit paramParam: Parameter[A], witness: Aux[Name]): Parameter[Named[Name, A]]

    Permalink
    Definition Classes
    ScammanderBase
  51. implicit def needPermissionParam[S <: String, A](implicit param0: (SpongeParameter.this)#Parameter[A], w: Aux[S]): (SpongeParameter.this)#Parameter[(SpongeParameter.this)#NeedPermission[S, A]]

    Permalink
    Definition Classes
    SpongeParameter
  52. implicit val notUsedParam: Parameter[NotUsed]

    Permalink
    Definition Classes
    ScammanderBase
  53. implicit def onlyOneParam[A](implicit setParam: (HelperParameters.this)#Parameter[Set[A]]): (HelperParameters.this)#Parameter[(HelperParameters.this)#OnlyOne[A]]

    Permalink
    Definition Classes
    HelperParameters
  54. implicit def optionParam[A](implicit param: (HelperParameters.this)#Parameter[A]): (HelperParameters.this)#Parameter[Option[A]]

    Permalink
    Definition Classes
    HelperParameters
  55. implicit def orSource[Base](implicit parameter: (OrParameters.this)#Parameter[Base], validator: (OrParameters.this)#UserValidator[Base]): (OrParameters.this)#Parameter[(OrParameters.this)#OrSource[Base]]

    Permalink
    Definition Classes
    OrParameters
  56. implicit def orTargetParam[Base](implicit parameter: (SpongeOrParameter.this)#Parameter[Base], targeter: (SpongeOrParameter.this)#Targeter[Base]): (SpongeOrParameter.this)#Parameter[(SpongeOrParameter.this)#OrTarget[Base]]

    Permalink
    Definition Classes
    SpongeOrParameter
  57. implicit val playerHasName: (SpongeParameter.this)#HasName[Player]

    Permalink
    Definition Classes
    SpongeParameter
  58. implicit val playerParam: (SpongeParameter.this)#Parameter[Player]

    Permalink
    Definition Classes
    SpongeParameter
  59. implicit val playerSender: (SpongeValidators.this)#UserValidator[Player]

    Permalink
    Definition Classes
    SpongeValidators
  60. implicit val pluginHasName: (SpongeParameter.this)#HasName[PluginContainer]

    Permalink
    Definition Classes
    SpongeParameter
  61. implicit val pluginParam: (SpongeParameter.this)#Parameter[Set[PluginContainer]]

    Permalink
    Definition Classes
    SpongeParameter
  62. def primitiveParam[A](parName: String, s: (String) ⇒ A): (NormalParameters.this)#Parameter[A]

    Permalink
    Definition Classes
    NormalParameters
  63. implicit val rawCmdArgsParam: Parameter[List[ScammanderBase.RawCmdArg]]

    Permalink
    Definition Classes
    ScammanderBase
  64. implicit val remainingAsStringParam: (HelperParameters.this)#Parameter[(HelperParameters.this)#RemainingAsString]

    Permalink
    Definition Classes
    HelperParameters
  65. implicit def rootValidator: UserValidator[RootSender]

    Permalink
    Definition Classes
    ScammanderBase
  66. implicit val shortParam: (NormalParameters.this)#Parameter[Short]

    Permalink
    Definition Classes
    NormalParameters
  67. implicit val stringParam: (NormalParameters.this)#Parameter[String]

    Permalink
    Definition Classes
    NormalParameters
  68. implicit val unitParam: (NormalParameters.this)#Parameter[Unit]

    Permalink
    Definition Classes
    NormalParameters
  69. implicit val urlParam: (NormalParameters.this)#Parameter[URL]

    Permalink
    Definition Classes
    NormalParameters
  70. implicit val userParam: (SpongeParameter.this)#Parameter[Set[User]]

    Permalink
    Definition Classes
    SpongeParameter
  71. implicit val userSender: (SpongeValidators.this)#UserValidator[User]

    Permalink
    Definition Classes
    SpongeValidators
  72. implicit val uuidParam: (NormalParameters.this)#Parameter[UUID]

    Permalink
    Definition Classes
    NormalParameters
  73. implicit def valueFlagParameter[Name <: String, A](implicit witness: Aux[Name], flagParam: (FlagParameters.this)#Parameter[A]): (FlagParameters.this)#Parameter[(FlagParameters.this)#ValueFlag[Name, A]]

    Permalink
    Definition Classes
    FlagParameters
  74. implicit val vector3dParam: (SpongeParameter.this)#Parameter[Vector3d]

    Permalink
    Definition Classes
    SpongeParameter
  75. implicit val vector3dSender: (SpongeValidators.this)#UserValidator[Vector3d]

    Permalink
    Definition Classes
    SpongeValidators
  76. implicit val worldHasName: (SpongeParameter.this)#HasName[WorldProperties]

    Permalink
    Definition Classes
    SpongeParameter
  77. implicit val worldParam: (SpongeParameter.this)#Parameter[Set[WorldProperties]]

    Permalink
    Definition Classes
    SpongeParameter

Inherited from SpongeBaseAllEither

Inherited from SpongeBaseAll

Inherited from SpongeHelpCommands

Inherited from HelpCommands

Inherited from SpongeOrParameter

Inherited from SpongeParameter

Inherited from SpongeValidators

Inherited from ScammanderBaseAll

Inherited from OrNowParameter

Inherited from OrParameters

Inherited from FlagParameters

Inherited from HelperParameters

Inherited from ParameterLabelledDeriver

Inherited from scammander.ParameterDeriver

Inherited from NormalParameters

Inherited from SpongeBase

Inherited from ScammanderBase

Inherited from ScammanderTypes

Inherited from AnyRef

Inherited from Any

Ungrouped