package sponge
- Alphabetic
- By Inheritance
- sponge
- SpongeBaseAllEither
- SpongeBaseAll
- SpongeHelpCommands
- HelpCommands
- SpongeOrParameter
- SpongeParameter
- SpongeValidators
- ScammanderBaseAll
- OrNowParameter
- OrParameters
- FlagParameters
- HelperParameters
- ParameterLabelledDeriver
- ParameterDeriver
- NormalParameters
- SpongeBase
- ScammanderBase
- ScammanderTypes
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
type
BaseStaticChildCommand = ComplexStaticChildCommand[sponge.G, sponge.RootSender, sponge.RunExtra, sponge.TabExtra, sponge.ResultTpe, sponge.StaticChildCommand]
- Definition Classes
- ScammanderBase
-
case class
BooleanFlag[Name <: String] extends Product with Serializable
- Definition Classes
- FlagParameters
-
type
ChildCommand = ComplexChildCommand[sponge.StaticChildCommand]
- Definition Classes
- ScammanderBase
-
class
Command[Sender, Param] extends ComplexCommand
- Definition Classes
- ScammanderBase
-
type
CommandFailure = scammander.CommandFailure
- Definition Classes
- ScammanderTypes
-
type
CommandFailureNEL = NonEmptyList[CommandFailure]
- Definition Classes
- ScammanderTypes
-
type
CommandSuccess = scammander.CommandSuccess[sponge.ResultTpe]
- Definition Classes
- ScammanderBase
-
type
ComplexCommand = scammander.ComplexCommand[sponge.G, sponge.RootSender, sponge.RunExtra, sponge.TabExtra, sponge.ResultTpe, sponge.StaticChildCommand]
- Definition Classes
- ScammanderBase
-
case class
DynamicCommand[Args, Identifier, Sender, Param] extends Product with Serializable
- Definition Classes
- ScammanderBase
-
case class
Flags[A, B] extends Product with Serializable
- Definition Classes
- FlagParameters
-
abstract
type
G[_]
- Definition Classes
- ScammanderBase
-
class
GetDynamicCommandType[Args, Identifier, Sender, Param] extends AnyRef
- Definition Classes
- ScammanderBase
-
type
HasName[A] = scammander.HasName[A]
- Definition Classes
- ScammanderTypes
-
case class
Named[Name <: String, A] extends Product with Serializable
- Definition Classes
- ScammanderBase
-
case class
NamedCommand[Args, Identifier, Sender, Param] extends Product with Serializable
- Definition Classes
- ScammanderBase
-
trait
NotUsed extends AnyRef
- Definition Classes
- ScammanderBase
-
sealed
trait
Now extends AnyRef
- Definition Classes
- OrNowParameter
-
case class
OneOrMore[A] extends Product with Serializable
- Definition Classes
- HelperParameters
-
case class
OnlyOne[A] extends Product with Serializable
- Definition Classes
- HelperParameters
-
case class
Or[Base, Context] extends Product with Serializable
- Definition Classes
- OrParameters
-
type
OrNow[Base] = Or[Base, Now]
- Definition Classes
- OrNowParameter
-
type
OrSource[Base] = Or[Base, Source]
- Definition Classes
- OrParameters
-
type
OrTarget[Base] = Or[Base, Target]
- Definition Classes
- SpongeOrParameter
-
trait
Parameter[A] extends ComplexParameter[A, RootSender, RunExtra, TabExtra]
- Definition Classes
- ScammanderBase
-
class
ParameterDeriver[A] extends AnyRef
- Definition Classes
- ParameterLabelledDeriver
-
type
ParserError[F[_]] = ApplicativeHandle[F, CommandFailureNEL]
- Definition Classes
- ScammanderTypes
-
type
ParserState[F[_]] = MonadState[F, List[RawCmdArg]]
- Definition Classes
- ScammanderTypes
-
trait
ProxyParameter[A, B] extends Parameter[A]
- Definition Classes
- ScammanderBase
-
type
RawCmdArg = scammander.RawCmdArg
- Definition Classes
- ScammanderTypes
-
case class
RemainingAsString extends Product with Serializable
- Definition Classes
- HelperParameters
-
type
Result = Either[CommandFailureNEL, CommandSuccess]
- Definition Classes
- ScammanderBase
-
implicit
class
ResultExtra extends AnyRef
- Definition Classes
- ScammanderBase
-
abstract
type
ResultTpe
- Definition Classes
- ScammanderBase
-
abstract
type
RootSender
- Definition Classes
- ScammanderBase
-
abstract
type
RunExtra
- Definition Classes
- ScammanderBase
-
sealed
trait
Source extends AnyRef
- Definition Classes
- OrParameters
-
abstract
type
StaticChildCommand <: BaseStaticChildCommand
- Definition Classes
- ScammanderBase
-
abstract
type
TabExtra
- Definition Classes
- ScammanderBase
-
abstract
type
Title
- Definition Classes
- HelpCommands
-
type
UserValidator[A] = ComplexUserValidator[A, sponge.RootSender]
- Definition Classes
- ScammanderBase
-
case class
ValueFlag[Name <: String, A] extends Product with Serializable
- Definition Classes
- FlagParameters
-
case class
ZeroOrMore[A] extends Product with Serializable
- Definition Classes
- HelperParameters
-
implicit
class
RichCommand[Sender, Param] extends AnyRef
- Definition Classes
- SpongeBase
-
sealed
trait
Target extends AnyRef
Used with Or to get what the sender is targeting.
Used with Or to get what the sender is targeting.
- Definition Classes
- SpongeOrParameter
-
trait
Targeter[A] extends AnyRef
A typeclass which returns what the sender is currently targeting.
A typeclass which returns what the sender is currently targeting.
- Definition Classes
- SpongeOrParameter
-
case class
NeedPermission[S <: String, A](value: A) extends Product with Serializable
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
Abstract Value Members
-
abstract
def
G: MonadError[sponge.G, CommandFailureNEL]
- Attributes
- protected
- Definition Classes
- SpongeBase
-
abstract
val
defaultCommandSuccess: sponge.ResultTpe
- Attributes
- protected
- Definition Classes
- ScammanderBase
-
abstract
def
runG[A](computation: sponge.G[A]): Either[CommandFailureNEL, A]
- Attributes
- protected
- Definition Classes
- SpongeBase
-
abstract
def
sendCommandHelp(title: sponge.Title, source: sponge.RootSender, command: sponge.StaticChildCommand, path: List[String]): sponge.G[CommandSuccess]
- Definition Classes
- HelpCommands
-
abstract
def
sendMultipleCommandHelp(title: sponge.Title, source: sponge.RootSender, commands: Set[ChildCommand]): sponge.G[CommandSuccess]
- Definition Classes
- HelpCommands
-
abstract
def
tabExtraToRunExtra(extra: sponge.TabExtra): sponge.RunExtra
- Attributes
- protected
- Definition Classes
- ScammanderBase
Concrete Value Members
-
val
ChildCommand: ComplexChildCommand.type
- Definition Classes
- ScammanderBase
-
def
GE: ApplicativeHandle[sponge.G, CommandFailureNEL]
- Definition Classes
- SpongeBase
-
val
HasName: scammander.HasName.type
- Definition Classes
- ScammanderTypes
-
val
RawCmdArg: scammander.RawCmdArg.type
- Definition Classes
- ScammanderTypes
-
implicit
val
allPlayerParam: Parameter[Set[Player]]
- Definition Classes
- SpongeParameter
-
implicit
val
bigDecimalParam: Parameter[BigDecimal]
- Definition Classes
- NormalParameters
-
implicit
val
bigIntParam: Parameter[BigInt]
- Definition Classes
- NormalParameters
-
implicit
val
boolParam: Parameter[Boolean]
- Definition Classes
- NormalParameters
-
implicit
def
booleanFlagParameter[Name <: String](implicit witness: Aux[Name]): Parameter[BooleanFlag[Name]]
- Definition Classes
- FlagParameters
-
implicit
val
byteParam: Parameter[Byte]
- Definition Classes
- NormalParameters
-
implicit
def
cConsLabelledParam[HK <: Symbol, HV, T <: Coproduct](implicit hName: Aux[HK], hParam: Lazy[Parameter[HV]], tParam: Lazy[Parameter[T]]): Parameter[:+:[FieldType[HK, HV], T]]
- Definition Classes
- ParameterLabelledDeriver
-
implicit
def
cConsParam[H, T <: Coproduct](implicit hParam: Lazy[Parameter[H]], tParam: Lazy[Parameter[T]]): Parameter[:+:[H, T]]
- Definition Classes
- ParameterDeriver
-
implicit
val
cNilParam: Parameter[CNil]
- Definition Classes
- ParameterDeriver
-
implicit
def
catalogTypeHasName[A <: CatalogType]: HasName[A]
- Definition Classes
- SpongeParameter
-
implicit
def
catalogedParam[A <: CatalogType](implicit classTag: ClassTag[A], typeable: Typeable[A]): Parameter[Set[A]]
- Definition Classes
- SpongeParameter
-
def
createCommand[Sender, Param](runCmd: (Sender, sponge.RunExtra, Param) ⇒ sponge.G[CommandSuccess], childSet: Set[ChildCommand])(implicit arg0: UserValidator[Sender], arg1: Parameter[Param]): Command[Sender, Param]
- Attributes
- protected
- Definition Classes
- ScammanderBase
-
def
createCommandHelp(source: CommandSource, commandName: String, fullCommandName: String, command: sponge.StaticChildCommand, detail: Boolean, indent: Int = 0, isIndentEnd: Boolean = false): Seq[Text]
- Definition Classes
- SpongeHelpCommands
-
implicit
val
dataContainerParam: Parameter[DataContainer]
- Definition Classes
- SpongeParameter
-
implicit
val
dateTimeOrNowParam: Parameter[Or[LocalDateTime, Now]]
- Definition Classes
- OrNowParameter
-
implicit
val
dateTimeParam: Parameter[LocalDateTime]
- Definition Classes
- NormalParameters
-
implicit
val
doubleParam: Parameter[Double]
- Definition Classes
- NormalParameters
-
implicit
val
durationParam: Parameter[Duration]
- Definition Classes
- NormalParameters
-
def
dynamicCommandOf[Args, Identifier, Sender, Param](command: (Args) ⇒ Command[Sender, Param], identifier: Identifier): GetDynamicCommandType[Args, Identifier, Sender, Param]
- Definition Classes
- ScammanderBase
-
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]]
- Definition Classes
- ScammanderBase
-
implicit
def
entityParam[A <: Entity](implicit typeable: Typeable[A]): Parameter[Set[A]]
- Definition Classes
- SpongeParameter
-
implicit
def
entitySender[A <: Entity](implicit arg0: Typeable[A]): UserValidator[A]
- Definition Classes
- SpongeValidators
-
implicit
def
flagsParameter[A, B](implicit flagsParam: Parameter[A], paramParam: Parameter[B]): Parameter[Flags[A, B]]
- Definition Classes
- FlagParameters
-
implicit
val
floatParam: Parameter[Float]
- Definition Classes
- NormalParameters
-
def
genParam[A, Gen](implicit gen: Aux[A, Gen], genParam: Lazy[Parameter[Gen]]): Parameter[A]
- Definition Classes
- ParameterLabelledDeriver
-
implicit
def
hConsLabelledParam[HK <: Symbol, HV, T <: HList](implicit hName: Aux[HK], hParam: Lazy[Parameter[HV]], tParam: Lazy[Parameter[T]]): Parameter[::[FieldType[HK, HV], T]]
- Definition Classes
- ParameterLabelledDeriver
-
implicit
def
hConsParam[H, T <: HList](implicit hParam: Lazy[Parameter[H]], tParam: Lazy[Parameter[T]]): Parameter[::[H, T]]
- Definition Classes
- ParameterDeriver
-
implicit
val
hNilParam: Parameter[HNil]
- Definition Classes
- ParameterDeriver
-
def
helpCommand(title: sponge.Title, commands: ⇒ Set[ChildCommand])(implicit G: Monad[sponge.G], E: ParserError[sponge.G]): Command[sponge.RootSender, ZeroOrMore[String]]
- Definition Classes
- HelpCommands
-
implicit
val
intParam: Parameter[Int]
- Definition Classes
- NormalParameters
-
implicit
val
ipParam: Parameter[InetAddress]
- Definition Classes
- SpongeParameter
-
implicit
val
ipSender: UserValidator[InetAddress]
- Definition Classes
- SpongeValidators
-
implicit
val
locationParam: Parameter[Set[Location[World]]]
- Definition Classes
- SpongeParameter
-
implicit
val
locationSender: UserValidator[Location[World]]
- Definition Classes
- SpongeValidators
-
implicit
val
longParam: Parameter[Long]
- Definition Classes
- NormalParameters
-
def
mkSingle[A](parName: String, parser: (String) ⇒ A, possibleSuggestions: Eval[Seq[String]]): Parameter[A]
- Definition Classes
- NormalParameters
-
implicit
def
namedParam[Name <: String, A](implicit paramParam: Parameter[A], witness: Aux[Name]): Parameter[Named[Name, A]]
- Definition Classes
- ScammanderBase
-
implicit
def
needPermissionParam[S <: String, A](implicit param0: Parameter[A], w: Aux[S]): Parameter[NeedPermission[S, A]]
- Definition Classes
- SpongeParameter
-
implicit
val
notUsedParam: Parameter[NotUsed]
- Definition Classes
- ScammanderBase
-
implicit
def
onlyOneParam[A](implicit setParam: Parameter[Set[A]]): Parameter[OnlyOne[A]]
- Definition Classes
- HelperParameters
-
implicit
def
optionParam[A](implicit param: Parameter[A]): Parameter[Option[A]]
- Definition Classes
- HelperParameters
-
implicit
def
orSource[Base](implicit parameter: Parameter[Base], validator: UserValidator[Base]): Parameter[OrSource[Base]]
- Definition Classes
- OrParameters
-
implicit
def
orTargetParam[Base](implicit parameter: Parameter[Base], targeter: Targeter[Base]): Parameter[OrTarget[Base]]
- Definition Classes
- SpongeOrParameter
-
implicit
val
playerHasName: HasName[Player]
- Definition Classes
- SpongeParameter
-
implicit
val
playerParam: Parameter[Player]
- Definition Classes
- SpongeParameter
-
implicit
val
playerSender: UserValidator[Player]
- Definition Classes
- SpongeValidators
-
implicit
val
pluginHasName: HasName[PluginContainer]
- Definition Classes
- SpongeParameter
-
implicit
val
pluginParam: Parameter[Set[PluginContainer]]
- Definition Classes
- SpongeParameter
-
def
primitiveParam[A](parName: String, s: (String) ⇒ A): Parameter[A]
- Definition Classes
- NormalParameters
-
implicit
val
rawCmdArgsParam: Parameter[List[RawCmdArg]]
- Definition Classes
- ScammanderBase
-
implicit
val
remainingAsStringParam: Parameter[RemainingAsString]
- Definition Classes
- HelperParameters
-
implicit
def
rootValidator: UserValidator[sponge.RootSender]
- Definition Classes
- ScammanderBase
-
implicit
val
shortParam: Parameter[Short]
- Definition Classes
- NormalParameters
-
implicit
val
stringParam: Parameter[String]
- Definition Classes
- NormalParameters
-
implicit
val
unitParam: Parameter[Unit]
- Definition Classes
- NormalParameters
-
implicit
val
urlParam: Parameter[URL]
- Definition Classes
- NormalParameters
-
implicit
val
userParam: Parameter[Set[User]]
- Definition Classes
- SpongeParameter
-
implicit
val
userSender: UserValidator[User]
- Definition Classes
- SpongeValidators
-
implicit
val
uuidParam: Parameter[UUID]
- Definition Classes
- NormalParameters
-
implicit
def
valueFlagParameter[Name <: String, A](implicit witness: Aux[Name], flagParam: Parameter[A]): Parameter[ValueFlag[Name, A]]
- Definition Classes
- FlagParameters
-
implicit
val
vector3dParam: Parameter[Vector3d]
- Definition Classes
- SpongeParameter
-
implicit
val
vector3dSender: UserValidator[Vector3d]
- Definition Classes
- SpongeValidators
-
implicit
val
worldHasName: HasName[WorldProperties]
- Definition Classes
- SpongeParameter
-
implicit
val
worldParam: Parameter[Set[WorldProperties]]
- Definition Classes
- SpongeParameter
-
object
OnlyOne extends Serializable
- Definition Classes
- HelperParameters
-
object
Parameter
- Definition Classes
- ScammanderBase
-
object
Result
- Definition Classes
- ScammanderTypes
-
object
Alias
Helper for creating an alias when registering a command.
Helper for creating an alias when registering a command.
- Definition Classes
- SpongeBase
-
object
Description
Helper for creating an description when registering a command.
Helper for creating an description when registering a command.
- Definition Classes
- SpongeBase
-
object
Help
Helper for creating a help when registering a command.
Helper for creating a help when registering a command.
- Definition Classes
- SpongeBase
-
object
Permission
Helper for creating a alias when registering a command.
Helper for creating a alias when registering a command.
- Definition Classes
- SpongeBase
-
object
Targeter
- Definition Classes
- SpongeOrParameter