org.geysermc.cumulus

Interface Form

All Known Subinterfaces:

CustomForm, ModalForm, SimpleForm

public interface Form

Base class of all Forms. While it can be used it doesn't contain every data you could get when using the specific class of the form type.

Method Summary

Modifier and Type	Method and Description
String	getJsonData() Returns the data that will be sent by Geyser to the Bedrock client
Consumer<String>	getResponseHandler() Returns the handler that will be invoked once the form got a response from the Bedrock client
FormType	getType() Returns the form type of this specific instance.
boolean	isClosed(String response) Checks if the given data by the Bedrock client is saying that the client closed the form.
FormResponse	parseResponse(String response) Parses the method into something provided by the form implementation, which will make the data given by the Bedrock client easier to handle.
void	setResponseHandler(Consumer<String> responseHandler) Sets the handler that will be invoked once the form got a response from the Bedrock client.

Method Detail

getType

FormType getType()

Returns the form type of this specific instance. The valid form types can be found in the FormType class

getJsonData

String getJsonData()

Returns the data that will be sent by Geyser to the Bedrock client

getResponseHandler

Consumer<String> getResponseHandler()

Returns the handler that will be invoked once the form got a response from the Bedrock client

setResponseHandler

void setResponseHandler(Consumer<String> responseHandler)

Sets the handler that will be invoked once the form got a response from the Bedrock client. This handler contains the raw data sent by the Bedrock client. See parseResponse(String) if you want to turn the given data into something that's easier to handle.

Parameters:

responseHandler - the response handler

parseResponse

FormResponse parseResponse(String response)

Parses the method into something provided by the form implementation, which will make the data given by the Bedrock client easier to handle.

Parameters:

response - the raw data given by the Bedrock client

Returns:

the data in an easy-to-handle class

isClosed

boolean isClosed(String response)

Checks if the given data by the Bedrock client is saying that the client closed the form.

Parameters:

response - the raw data given by the Bedrock client

Returns:

true if the raw data implies that the Bedrock client closed the form