Package org.vrspace.server.api

Class Worlds.CreateWorldOptions

java.lang.Object

org.vrspace.server.api.Worlds.CreateWorldOptions

Enclosing class:

Worlds

public static class Worlds.CreateWorldOptions
extends Object

World options

Constructor Summary

Constructors

Constructor	Description
CreateWorldOptions()
CreateWorldOptions(@NonNull String worldName, String templateName, String token, boolean publicWorld, boolean temporaryWorld)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getTemplateName()	Optional world template to use
String	getToken()	Optional UUID used as world token, required to enter private worlds, defaults to a random UUID
@NonNull String	getWorldName()	World name of created world, must be unique, required
int	hashCode()
boolean	isPublicWorld()	Optional flag to create public or private world, default false
boolean	isTemporaryWorld()	optional flag to create a temporary world, default true
void	setPublicWorld(boolean publicWorld)	Optional flag to create public or private world, default false
void	setTemplateName(String templateName)	Optional world template to use
void	setTemporaryWorld(boolean temporaryWorld)	optional flag to create a temporary world, default true
void	setToken(String token)	Optional UUID used as world token, required to enter private worlds, defaults to a random UUID
void	setWorldName(@NonNull String worldName)	World name of created world, must be unique, required
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CreateWorldOptions

public CreateWorldOptions()

CreateWorldOptions

public CreateWorldOptions(@NonNull
 @NonNull String worldName,
 String templateName,
 String token,
 boolean publicWorld,
 boolean temporaryWorld)

Method Details

getWorldName

@NonNull
public @NonNull String getWorldName()

World name of created world, must be unique, required

getTemplateName

public String getTemplateName()

Optional world template to use

getToken

public String getToken()

Optional UUID used as world token, required to enter private worlds, defaults to a random UUID

isPublicWorld

public boolean isPublicWorld()

Optional flag to create public or private world, default false

isTemporaryWorld

public boolean isTemporaryWorld()

optional flag to create a temporary world, default true

setWorldName

public void setWorldName(@NonNull
 @NonNull String worldName)

World name of created world, must be unique, required

setTemplateName

public void setTemplateName(String templateName)

Optional world template to use

setToken

public void setToken(String token)

Optional UUID used as world token, required to enter private worlds, defaults to a random UUID

setPublicWorld

public void setPublicWorld(boolean publicWorld)

Optional flag to create public or private world, default false

setTemporaryWorld

public void setTemporaryWorld(boolean temporaryWorld)

optional flag to create a temporary world, default true

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object