AttemptModifier (api 0.1.0 API)

java.lang.Object
- me.nemo_64.betterinputs.api.input.modifier.AbstractModifier<T>
- - me.nemo_64.betterinputs.api.input.modifier.AttemptModifier<T>

public final class AttemptModifier<T>
extends AbstractModifier<T>

Constructor Summary

Constructors
Constructor	Description
`AttemptModifier(int attempts, Predicate<T> validator)`	Creates a new `AttemptModifier`
`AttemptModifier(int attempts, Predicate<T> validator, Consumer<IPlatformActor<?>> messageSupplier)`	Creates a new `AttemptModifier`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`attempt(T input)`	Accepts input and validates it using the `valdiator` Predicate
`void`	`onExpire(InputProvider<T> provider)`	Is called once the modifier expires
`void`	`sendMessage(IPlatformActor<?> actor)`	Sends a "try again" message to the `actor`

Methods inherited from class me.nemo_64.betterinputs.api.input.modifier.AbstractModifier
isExpired, isTicking, onDone, tick

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AttemptModifier
```
public AttemptModifier(int attempts,
                       Predicate<T> validator,
                       Consumer<IPlatformActor<?>> messageSupplier)
```
    Creates a new AttemptModifier
    
    Parameters:
    
    attempts - number of allowed attempts
    
    validator - the input validator
    
    messageSupplier - the "try again" message sender function
  - AttemptModifier
```
public AttemptModifier(int attempts,
                       Predicate<T> validator)
```
    Creates a new AttemptModifier
    
    Parameters:
    
    attempts - number of allowed attempts
    
    validator - the input validator
- Method Detail
  - attempt
```
public boolean attempt(T input)
```
    Accepts input and validates it using the valdiator Predicate
    
    Parameters:
    
    input - the provided input
    
    Returns:
    
    if the attempt was valid or not
  - sendMessage
```
public final void sendMessage(IPlatformActor<?> actor)
```
    Sends a "try again" message to the actor
    
    Parameters:
    
    actor - the actor that should receive the message
  - onExpire
```
public void onExpire(InputProvider<T> provider)
```
    Description copied from class: AbstractModifier
    
    Is called once the modifier expires
    
    Overrides:
    
    onExpire in class AbstractModifier<T>
    
    Parameters:
    
    provider - the input provider that this modifier was set to