Multiverse-Core

https://multiverse.github.io/Multiverse-Core/javadoc/latest
Admin
Multiverse-Core is a Minecraft plugin that provides core functionalities for managing multiple...
Tokens:436,804
Snippets:6,572
Trust Score:8.3
Update:6 days ago
Show doc for...
Tokens:
Raw
### getSilentStart() - Method in class org.mvplugins.multiverse.core.config.CoreConfig

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/index-all.html

Gets the silent start configuration value.

```APIDOC
## getSilentStart()

### Description
Gets the silent start configuration value.

### Method
getSilentStart()

### Return Type
Not specified in source
```

--------------------------------

### get()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/MultiverseCoreApi.html

Gets the MultiverseCoreApi instance. Throws an exception if Multiverse-Core has not been initialized.

```APIDOC
## get()

### Description
Gets the MultiverseCoreApi. This will throw an exception if the Multiverse-Core has not been initialized. You can check if the MultiverseCoreApi has been initialized with `isLoaded()` before using this method. Alternatively, you can use `whenLoaded(Consumer)` to hook into the MultiverseCoreApi if your plugin may load before Multiverse-Core is fully initialized.

### Method
public static @NotNull MultiverseCoreApi get()

### Returns
The MultiverseCoreApi

### Throws
- **IllegalStateException** - if the MultiverseCoreApi has not been initialized
```

--------------------------------

### MultiverseWorld.isAutoLoad()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/index-all.html

Gets whether or not Multiverse should auto-load this world on server start.

```APIDOC
## MultiverseWorld.isAutoLoad()

### Description
Gets whether or not Multiverse should auto-load this world on server start.

### Method
isAutoLoad

### Signature
`isAutoLoad()`

### Returns
boolean - true if auto-load is enabled, false otherwise.
```

--------------------------------

### get()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/MultiverseCoreApi.html

Gets the MultiverseCoreApi instance. This is the primary access point for the API.

```APIDOC
## get()

### Description
Gets the MultiverseCoreApi instance.

### Method
static @NotNull MultiverseCoreApi get()

### Returns
- **MultiverseCoreApi** - The MultiverseCoreApi instance.

```

--------------------------------

### getAllConfigsLoaded()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/event/MVConfigReloadEvent.html

Gets all loaded configs.

```APIDOC
## Method: getAllConfigsLoaded()

### Description
Gets all loaded configs.

### Returns
- `List<String>` - A list of all loaded configs.

### Example
```java
List<String> configs = event.getAllConfigsLoaded();
```
```

--------------------------------

### whenLoaded(Consumer<MultiverseCoreApi>)

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/MultiverseCoreApi.html

Hook your plugin into the MultiverseCoreApi here to ensure you only start using the API after it has been initialized.

```APIDOC
## whenLoaded(Consumer<MultiverseCoreApi>)

### Description
Hook your plugin into the MultiverseCoreApi here to ensure you only start using the API after it has been initialized.

### Method
static void whenLoaded(@NotNull Consumer<MultiverseCoreApi> consumer)

### Parameters
- **consumer** (Consumer<MultiverseCoreApi>) - Required - The consumer to be called once the API is loaded.

```

--------------------------------

### load()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/config/CoreConfig.html

Loads the core configuration from disk.

```APIDOC
## load()

### Description
Loads the core configuration from disk.

### Method
load

### Signature
public io.vavr.control.Try<Void> load()

### Returns
- `io.vavr.control.Try<Void>` - The result of the load operation.
```

--------------------------------

### build()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/config/handle/BaseConfigurationHandle.Builder.html

Builds the configuration handle.

```APIDOC
## build()

### Description
Builds the configuration handle.

### Method
build

### Returns
The configuration handle.
```

--------------------------------

### NAMESPACED_KEY

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/command/MVCommandCompletionFilters.html

Matches namespaced keys (for example, `minecraft:stone`) using namespace-aware checks. This filter accepts completions that start with the current input, have a namespace starting with the input, or have a key value containing the input.

```APIDOC
## NAMESPACED_KEY

### Description
Matches namespaced keys (for example, `minecraft:stone`) using namespace-aware checks. This filter accepts completions that:
- start with the current input,
- have a namespace starting with the input, or
- have a key value containing the input.

### Field
`public static final co.aikar.commands.CommandCompletionFilter NAMESPACED_KEY`

### Since
5.7
```

--------------------------------

### load()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/config/CoreConfig.html

Loads the configuration from disk.

```APIDOC
## load()

### Description
Loads the plugin configuration from the config file.

### Method
POST

### Return Type
io.vavr.control.Try<Void>

### Returns
A Try indicating success or failure of the load operation.
```

--------------------------------

### get() - Attempt.Success

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/index-all.html

Gets the value of this attempt.

```APIDOC
## get() - Attempt.Success

### Description
Gets the value of this attempt.

### Method
`get()`

### Return Type
Value (implied)

### Usage
This method is part of the `Attempt.Success` class.
```

--------------------------------

### get() - Attempt

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/index-all.html

Gets the value of this attempt.

```APIDOC
## get() - Attempt

### Description
Gets the value of this attempt.

### Method
`get()`

### Return Type
Value (implied)

### Usage
This method is part of the `Attempt` interface.
```

--------------------------------

### enable()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/inject/PluginServiceLocator.html

Starts and injects the plugin classes. Returns a Try containing the PluginServiceLocator.

```APIDOC
## enable()

### Description
Starts and injects the plugin classes.

### Method
enable()

### Returns
- `io.vavr.control.Try<PluginServiceLocator>` - The plugin service locator

```

--------------------------------

### get() - Attempt.Failure

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/index-all.html

Gets the value of this attempt.

```APIDOC
## get() - Attempt.Failure

### Description
Gets the value of this attempt.

### Method
`get()`

### Return Type
Value (implied)

### Usage
This method is part of the `Attempt.Failure` class.
```

--------------------------------

### build()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/config/handle/MemoryConfigurationHandle.Builder.html

Builds the configuration handle and returns a MemoryConfigurationHandle instance.

```APIDOC
## build()

### Description
Builds the configuration handle.

### Method
build

### Signature
`@NotNull public @NotNull MemoryConfigurationHandle build()`

### Returns
- **MemoryConfigurationHandle** - The configuration handle.

### Overrides
- `build` in class `ConfigurationSectionHandle.Builder<org.bukkit.configuration.ConfigurationSection,B extends MemoryConfigurationHandle.Builder<B>>`
```

--------------------------------

### build()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/config/handle/FileConfigurationHandle.Builder.html

Abstract method to build the configuration handle. Returns a FileConfigurationHandle instance.

```APIDOC
## build()

### Description
Builds the configuration handle.

### Method
Abstract Method

### Signature
`public abstract @NotNull FileConfigurationHandle<C> build()`

### Returns
- `FileConfigurationHandle<C>` - The configuration handle.

```

--------------------------------

### get() - MultiverseModulesRegistry

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/index-all.html

Gets the MultiverseModulesRegistry instance.

```APIDOC
## get() - MultiverseModulesRegistry

### Description
Gets the MultiverseModulesRegistry instance.

### Method
`get()`

### Return Type
MultiverseModulesRegistry

### Usage
This is a static method.
```

--------------------------------

### get(Object) - CaseInsensitiveStringMap

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/index-all.html

Gets a value from the map.

```APIDOC
## get(Object) - CaseInsensitiveStringMap

### Description
Gets a value from the map.

### Method
`get(Object)`

### Parameters
- **key** (Object) - The key to look up.

### Return Type
Value (implied)

### Usage
This method is part of the `CaseInsensitiveStringMap` class.
```

--------------------------------

### build()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/command/flag/CommandFlag.Builder.html

Builds the CommandFlag with the configured key and aliases.

```APIDOC
## build()

### Description
Builds the flag and returns the resulting CommandFlag object.

### Method
`@NotNull public @NotNull CommandFlag build()`

### Returns
- The built CommandFlag.

### Example
```java
CommandFlag flag = builder.build();
```
```

--------------------------------

### get() - DefaultContentFilter

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/index-all.html

Gets the singleton instance of this class.

```APIDOC
## get() - DefaultContentFilter

### Description
Gets the singleton instance of this class.

### Method
`get()`

### Return Type
DefaultContentFilter

### Usage
This is a static method.
```

--------------------------------

### get(String) - REPatterns

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/index-all.html

Gets a regular expression pattern.

```APIDOC
## get(String) - REPatterns

### Description
Gets a regular expression pattern.

### Method
`get(String)`

### Parameters
- **key** (String) - The key for the pattern.

### Return Type
Pattern (implied)

### Usage
This is a static method.
```

--------------------------------

### build()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/config/node/ConfigHeaderNode.Builder.html

Builds the node and returns the constructed ConfigHeaderNode instance.

```APIDOC
## build()

### Description
Builds the node.

### Method
build

### Returns
The built node.
```

--------------------------------

### get() - NullSpawnLocation

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/index-all.html

Get the default null location instance.

```APIDOC
## get() - NullSpawnLocation

### Description
Get the default null location instance.

### Method
`get()`

### Return Type
NullSpawnLocation

### Usage
This is a static method.
```

--------------------------------

### build()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/config/migration/VersionMigrator.Builder.html

Builds the VersionMigrator with the configured actions and version.

```APIDOC
## build()

### Description
Builds the VersionMigrator.

### Method
`public VersionMigrator build()`

### Returns
The built VersionMigrator.

```

--------------------------------

### get()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/utils/result/Attempt.Success.html

Gets the value of this attempt. Throws an exception if this is a failure attempt.

```APIDOC
## get()

### Description
Gets the value of this attempt. Throws an exception if this is a failure attempt.

### Method
`public T get()`

### Returns
- The value of this attempt.

```

--------------------------------

### applyConfigToWorld()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/index-all.html

Applies the entity spawn configuration to the world.

```APIDOC
## applyConfigToWorld()

### Description
Applies the entity spawn configuration to the world.

### Method
applyConfigToWorld

### Parameters
None

### Returns
void
```

--------------------------------

### get()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/utils/result/Attempt.Failure.html

Gets the value of this attempt. Throws an exception if this is a failure attempt.

```APIDOC
## get()

### Description
Gets the value of this attempt. Throws an exception if this is a failure attempt.

### Method
`public T get()`

### Returns
- **T** - The value.

```

--------------------------------

### whenLoaded(Consumer<MultiverseCoreApi>)

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/MultiverseCoreApi.html

Hooks a callback to be executed when the MultiverseCoreApi has been initialized. If already initialized, the callback is called immediately.

```APIDOC
## whenLoaded(Consumer<MultiverseCoreApi>)

### Description
Hook your plugin into the MultiverseCoreApi here to ensure you only start using the API after it has been initialized. Use this if you know your plugin may load before Multiverse-Core is fully initialized. This handy method removes the need for you to check with plugin manager or listen to plugin enable event. Callback will be called immediately if the MultiverseCoreApi has already been initialized.

### Method
public static void whenLoaded(@NotNull Consumer<MultiverseCoreApi> consumer)

### Parameters
- **consumer** (Consumer<MultiverseCoreApi>) - Required - The callback to execute when the MultiverseCoreApi has been initialized.

### Since
5.1
```

--------------------------------

### save()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/config/CoreConfig.html

Saves the core configuration to disk.

```APIDOC
## save()

### Description
Saves the core configuration to disk.

### Method
save

### Signature
public io.vavr.control.Try<Void> save()

### Returns
- `io.vavr.control.Try<Void>` - The result of the save operation.
```

--------------------------------

### create()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/display/ContentDisplay.html

Creates a new ContentDisplay instance to use.

```APIDOC
## create()

### Description
Makes a new `ContentDisplay` instance to use.

### Method
`public static @NotNull ContentDisplay create()`

### Returns
New `ContentDisplay` instance.
```

--------------------------------

### get(String) - PlayerFinder

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/index-all.html

Get a `Player` based on an identifier of name UUID or selector.

```APIDOC
## get(String) - PlayerFinder

### Description
Get a `Player` based on an identifier of name UUID or selector.

### Method
`get(String)`

### Parameters
- **identifier** (String) - The identifier (name, UUID, or selector).

### Return Type
Player

### Usage
This is a static method.
```

--------------------------------

### get(String, CommandSender) - PlayerFinder

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/index-all.html

Get a `Player` based on an identifier of name UUID or selector.

```APIDOC
## get(String, CommandSender) - PlayerFinder

### Description
Get a `Player` based on an identifier of name UUID or selector.

### Method
`get(String, CommandSender)`

### Parameters
- **identifier** (String) - The identifier (name, UUID, or selector).
- **sender** (CommandSender) - The command sender for context.

### Return Type
Player

### Usage
This is a static method.
```

--------------------------------

### get(ValueNode<T>) - BaseConfigurationHandle

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/index-all.html

Gets the value of a node, if the node has a default value, it will be returned if the node is not found.

```APIDOC
## get(ValueNode<T>) - BaseConfigurationHandle

### Description
Gets the value of a node, if the node has a default value, it will be returned if the node is not found.

### Method
`get(ValueNode<T>)`

### Parameters
- **node** (ValueNode<T>) - The node to get the value of.

### Return Type
T

### Usage
This method is part of the `BaseConfigurationHandle` class.
```

--------------------------------

### save()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/config/CoreConfig.html

Saves the configuration to disk.

```APIDOC
## save()

### Description
Saves the current configuration to the config file.

### Method
POST

### Return Type
io.vavr.control.Try<Void>

### Returns
A Try indicating success or failure of the save operation.
```

--------------------------------

### get(String playerIdentifier)

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/utils/PlayerFinder.html

Gets a Player based on an identifier of name, UUID, or selector. Returns null if not found.

```APIDOC
## get(String playerIdentifier)

### Description
Gets a `Player` based on an identifier of name, UUID, or selector.

### Method
`public static @Nullable org.bukkit.entity.Player get(@Nullable String playerIdentifier)`

### Parameters
- `playerIdentifier` (String) - Required - An identifier of name, UUID, or selector.

### Returns
- `org.bukkit.entity.Player` - The player if found, else null.

```

--------------------------------

### build()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/config/migration/ConfigMigrator.Builder.html

Builds the ConfigMigrator. Returns the built ConfigMigrator instance.

```APIDOC
## build()

### Description
Builds the ConfigMigrator.

### Method
Instance Method

### Signature
`public ConfigMigrator build()`

### Returns
The built ConfigMigrator.

```

--------------------------------

### load() - Method in BaseConfigurationHandle

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/index-all.html

Loads the configuration.

```APIDOC
## load()

### Description
Loads the configuration.

### Method
`void load()`

### Class
`org.mvplugins.multiverse.core.config.handle.BaseConfigurationHandle`
```

--------------------------------

### get(@Nullable String playerIdentifier)

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/utils/PlayerFinder.html

Gets a Player based on an identifier of name, UUID, or selector. Returns null if no player is found.

```APIDOC
## get(@Nullable String playerIdentifier)

### Description
Gets a `Player` based on an identifier of name, UUID, or selector. Returns `null` if no player is found.

### Method
`static @Nullable org.bukkit.entity.Player get(@Nullable String playerIdentifier)`

### Parameters
- **playerIdentifier** (String) - Required - The player identifier (name, UUID, or selector).

### Returns
- `@Nullable org.bukkit.entity.Player` - The found player, or `null` if not found.

```

--------------------------------

### BaseConfigurationHandle Methods

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/config/handle/BaseConfigurationHandle.html

Methods for interacting with configuration nodes.

```APIDOC
## add(ListValueNode<I>, I)

### Description
Adds an item to a list node.

### Method
add

### Parameters
- `node` (ListValueNode<I>) - Required - The list node to add the item to.
- `itemValue` (I) - Required - The item to add.

### Returns
- `io.vavr.control.Try<Void>` - A Try indicating success or failure.
```

```APIDOC
## get(ValueNode<T>)

### Description
Gets the value of a node. If the node has a default value, it will be returned if the node is not found.

### Method
get

### Parameters
- `node` (ValueNode<T>) - Required - The node to get the value from.

### Returns
- `T` - The value of the node.
```

```APIDOC
## getConfig()

### Description
Gets the configuration.

### Method
getConfig

### Returns
- `C` - The configuration object.
```

```APIDOC
## isLoaded()

### Description
Gets whether the configuration is loaded.

### Method
isLoaded

### Returns
- `boolean` - True if the configuration is loaded, false otherwise.
```

```APIDOC
## load()

### Description
Loads the configuration.

### Method
load

### Returns
- `io.vavr.control.Try<Void>` - A Try indicating success or failure.
```

```APIDOC
## remove(ListValueNode<I>, I)

### Description
Removes an item from a list node.

### Method
remove

### Parameters
- `node` (ListValueNode<I>) - Required - The list node to remove the item from.
- `itemValue` (I) - Required - The item to remove.

### Returns
- `io.vavr.control.Try<Void>` - A Try indicating success or failure.
```

```APIDOC
## remove(MapValueNode<K,V>, K)

### Description
Removes a key from a map node.

### Method
remove

### Parameters
- `node` (MapValueNode<K,V>) - Required - The map node to remove the key from.
- `key` (K) - Required - The key to remove.

### Returns
- `io.vavr.control.Try<Void>` - A Try indicating success or failure.
```

```APIDOC
## reset(ValueNode<T>)

### Description
Sets the default value of a node.

### Method
reset

### Parameters
- `node` (ValueNode<T>) - Required - The node to reset.

### Returns
- `io.vavr.control.Try<Void>` - A Try indicating success or failure.
```

```APIDOC
## save()

### Description
Saves the configuration.

### Method
save

### Returns
- `io.vavr.control.Try<Void>` - A Try indicating success or failure.
```

```APIDOC
## set(CommandSender, ValueNode<T>, T)

### Description
Sets the value of a node. If the validator is not null, it will be tested first.

### Method
set

### Parameters
- `sender` (CommandSender) - Required - The command sender performing the set.
- `node` (ValueNode<T>) - Required - The node to set.
- `value` (T) - Required - The value to set.

### Returns
- `io.vavr.control.Try<Void>` - A Try indicating success or failure.
```

```APIDOC
## set(MapValueNode<K,V>, K, V)

### Description
Sets a key-value pair in a map node.

### Method
set

### Parameters
- `node` (MapValueNode<K,V>) - Required - The map node to set.
- `key` (K) - Required - The key to set.
- `value` (V) - Required - The value to set.

### Returns
- `io.vavr.control.Try<Void>` - A Try indicating success or failure.
```

```APIDOC
## set(ValueNode<T>, T)

### Description
Sets the value of a node. If the validator is not null, it will be tested first.

### Method
set

### Parameters
- `node` (ValueNode<T>) - Required - The node to set.
- `value` (T) - Required - The value to set.

### Returns
- `io.vavr.control.Try<Void>` - A Try indicating success or failure.
```

--------------------------------

### getWorlds

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/world/WorldManager.html

Get a list of all worlds that may or may not be loaded. It will return an LoadedMultiverseWorld if the world is loaded, otherwise you will get an MultiverseWorld instance. Note that this is an unmodifiable copy of the current worlds.

```APIDOC
## getWorlds

### Description
Get a list of all worlds that may or may not be loaded. It will an `LoadedMultiverseWorld` if the world is loaded, otherwise you will get an `MultiverseWorld` instance. If you want only unloaded worlds, use `getUnloadedWorlds()`. If you want only loaded worlds, use `getLoadedWorlds()`. Note that this is an unmodifiable copy of the current worlds. It will not update as worlds are added/removed. Call it everytime you need the most updated list of worlds.

### Method
@NotNull public @Unmodifiable @NotNull Collection<MultiverseWorld> getWorlds()

### Returns
- A list of all worlds that may or may not be loaded.
```

--------------------------------

### getAllAnchors()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/anchor/AnchorManager.html

Gets all anchors.

```APIDOC
## getAllAnchors()

### Description
Gets all anchors.

### Method
getAllAnchors()

### Return Type
List<MultiverseAnchor>

### Returns
An unmodifiable `List` containing all anchors.
```

--------------------------------

### applyConfigToWorld()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/world/entity/EntitySpawnConfig.html

Applies the configuration to the associated world.

```APIDOC
## applyConfigToWorld()

### Description
Applies the entity spawn configuration to the world.

### Method
`applyConfigToWorld`

### Signature
`public void applyConfigToWorld()`

### Returns
- **void** - This method does not return a value.
```

--------------------------------

### worldType()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/world/options/CreateWorldOptions.html

Gets the world type.

```APIDOC
## worldType()

### Description
Gets the world type.

### Method
`worldType`

### Returns
The world type.
```

--------------------------------

### setSilentStart(boolean silentStart)

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/config/CoreConfig.html

Sets whether to start silently.

```APIDOC
## setSilentStart(boolean silentStart)

### Description
Sets whether to start silently.

### Method
setSilentStart

### Parameters
- **silentStart** (boolean) - Required - Whether to start silently.

### Returns
- **io.vavr.control.Try<Void>** - A Try indicating success or failure.
```

--------------------------------

### SpawnLocation Methods

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/world/location/SpawnLocation.html

Methods for cloning, serialization, deserialization, world access, and conversion to Bukkit Location.

```APIDOC
## SpawnLocation Methods

### Description
Provides methods for cloning, serialization, deserialization, world access, and conversion to Bukkit Location.

### Methods

#### clone()
- **Return Type:** `@NotNull SpawnLocation`
- **Description:** Returns a clone of this SpawnLocation.

#### deserialize(Map<String,Object> args)
- **Parameters:**
  - `args` (Map<String,Object>) - Map of serialized data
- **Return Type:** `static @NotNull SpawnLocation`
- **Description:** Let Bukkit be able to deserialize this.

#### getBlock()
- **Return Type:** `@NotNull org.bukkit.block.Block`
- **Description:** Gets the block at this location.

#### getChunk()
- **Return Type:** `@NotNull org.bukkit.Chunk`
- **Description:** Gets the chunk at this location.

#### getWorld()
- **Return Type:** `org.bukkit.World`
- **Description:** Gets the world of this location.

#### serialize()
- **Return Type:** `@NotNull Map<String,Object>`
- **Description:** Serializes this SpawnLocation to a map.

#### setWorld(org.bukkit.World world)
- **Parameters:**
  - `world` (org.bukkit.World) - The world to set
- **Return Type:** `void`
- **Description:** Sets the world of this location.

#### toBukkitLocation()
- **Return Type:** `org.bukkit.Location`
- **Description:** Makes a bukkit `Location` copy from this SpawnLocation.

#### toString()
- **Return Type:** `String`
- **Description:** Returns a string representation of this SpawnLocation.

```

--------------------------------

### world()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/world/options/RegenWorldOptions.html

Gets the world to regenerate.

```APIDOC
## world()

### Description
Gets the world to regenerate.

### Method
`LoadedMultiverseWorld world()`

### Returns
The world to regenerate.
```

--------------------------------

### getBlock()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/world/location/SpawnLocation.html

Gets the block at this location.

```APIDOC
## getBlock()

### Description
Gets the block at this location.

### Method
`@NotNull public @NotNull org.bukkit.block.Block getBlock()`

### Overrides
- `getBlock` in class `org.bukkit.Location`

### Returns
- **org.bukkit.block.Block** - The block at this location

```

--------------------------------

### build()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/config/node/ListConfigNode.Builder.html

Builds the ListConfigNode instance.

```APIDOC
## build()

### Description
Builds the ListConfigNode.

### Method
`@NotNull ListConfigNode<I> build()`

### Returns
- **ListConfigNode<I>** - The built node.

```

--------------------------------

### load() - Method in FileConfigurationHandle

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/index-all.html

Loads the configuration.

```APIDOC
## load()

### Description
Loads the configuration.

### Method
`void load()`

### Class
`org.mvplugins.multiverse.core.config.handle.FileConfigurationHandle`
```

--------------------------------

### getWorld()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/world/location/SpawnLocation.html

Gets the world of this location.

```APIDOC
## getWorld()

### Description
Gets the world of this location.

### Method
`public org.bukkit.World getWorld()`

### Overrides
- `getWorld` in class `org.bukkit.Location`

### Returns
- **org.bukkit.World** - The world of this location

```

--------------------------------

### getUnloadedWorld

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/world/WorldManager.html

Get a world that is not loaded.

```APIDOC
## getUnloadedWorld

### Description
Get a world that is not loaded.

### Method
public io.vavr.control.Option<MultiverseWorld> getUnloadedWorld(@Nullable String worldName)

### Parameters
- **worldName** (String) - Required - The name of the world to get.

### Returns
- The world if it exists.
```

--------------------------------

### getDifficulty

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/world/MultiverseWorld.html

Gets the difficulty of this world.

```APIDOC
## getDifficulty

### Description
Gets the difficulty of this world.

### Method
GET

### Endpoint
MultiverseWorld#getDifficulty()

### Returns
- **org.bukkit.Difficulty** - The difficulty of this world.

```

--------------------------------

### build() Method

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/config/handle/CommentedConfigurationHandle.Builder.html

Builds and returns a new CommentedConfigurationHandle instance. This method is called to finalize the builder and create the configuration handle.

```APIDOC
## build() Method

### Description
Builds the configuration handle and returns the resulting `CommentedConfigurationHandle`.

### Method
build

### Signature
`@NotNull public @NotNull CommentedConfigurationHandle build()`

### Returns
- **CommentedConfigurationHandle** - The built configuration handle.

```

--------------------------------

### withPrefix(String)

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/display/handlers/InlineSendHandler.html

Sets the prefix for the content.

```APIDOC
## withPrefix(String)

### Description
Sets the prefix.

### Method
`public InlineSendHandler withPrefix(String prefix)`

### Parameters
- **prefix** (String) - Required - The prefix to use.

### Returns
Same `InlineSendHandler` for method chaining.
```

--------------------------------

### getAlias

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/world/MultiverseWorld.html

Gets the alias of the world.

```APIDOC
## getAlias

### Description
Gets the alias of the world.

### Method
`public String getAlias()`

### Returns
- **String** - The alias of the world.
```

--------------------------------

### isLoaded()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/MultiverseCoreApi.html

Checks if the MultiverseCoreApi has been initialized.

```APIDOC
## isLoaded()

### Description
Checks if the MultiverseCoreApi has been initialized.

### Method
static boolean isLoaded()

### Returns
- **boolean** - True if the API has been initialized, false otherwise.

```

--------------------------------

### getWorldType()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/world/LoadedMultiverseWorld.html

Gets the type of this world.

```APIDOC
## getWorldType()

### Description
Gets the type of this world.

### Method
`public io.vavr.control.Option<org.bukkit.WorldType> getWorldType()`

### Returns
- `io.vavr.control.Option<org.bukkit.WorldType>` - Type of this world.
```

--------------------------------

### isLoaded()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/MultiverseCoreApi.html

Checks if the MultiverseCoreApi has been initialized.

```APIDOC
## isLoaded()

### Description
Checks if the MultiverseCoreApi has been initialized.

### Method
public static boolean isLoaded()

### Returns
True if the MultiverseCoreApi has been initialized, false otherwise.

### Since
5.1
```

--------------------------------

### Message.getRawReplacements()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/locale/message/Message.html

Gets the replacements for this message.

```APIDOC
## Message.getRawReplacements()

### Description
Gets the replacements for this message.

### Method
Instance method

### Signature
`@NotNull String[] getRawReplacements()`

### Returns
An array of raw replacement strings.
```

--------------------------------

### createConfigFile() - FileConfigurationHandle

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/index-all.html

Creates a new config file if the file does not exist.

```APIDOC
## createConfigFile()

### Description
Create a new config file if file does not exist.

### Method
createConfigFile

### Class
org.mvplugins.multiverse.core.config.handle.FileConfigurationHandle

### Parameters
None

### Returns
void
```

--------------------------------

### Message.formatted()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/locale/message/Message.html

Gets the formatted message.

```APIDOC
## Message.formatted()

### Description
Gets the formatted message.

### Method
Instance method

### Signature
`@NotNull String formatted()`

### Returns
The formatted message.
```

--------------------------------

### CreateWorldOptions.key(WorldKey)

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/world/options/CreateWorldOptions.html

Creates a new CreateWorldOptions instance with the given namespaced key for the world to create.

```APIDOC
## CreateWorldOptions.key(WorldKey)

### Description
Creates a new `CreateWorldOptions` instance with the given namespaced key for the world to create.

### Method
`public static CreateWorldOptions key(WorldKey key)`

### Parameters
- `key` (WorldKey) - Required - The namespaced key for the world to create.

### Returns
A new `CreateWorldOptions` instance.

### Since
5.7
```

--------------------------------

### getWorld()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/event/world/MVWorldClonedEvent.html

Gets the world that has been cloned.

```APIDOC
## getWorld()

### Description
Gets the world that has been cloned.

### Method
`public LoadedMultiverseWorld getWorld()`

### Returns
- **LoadedMultiverseWorld** - The cloned world.
```

--------------------------------

### setSilentStart(boolean)

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/config/CoreConfig.html

Sets the silentStart configuration option.

```APIDOC
## setSilentStart(boolean silentStart)

### Description
Sets whether silent start is enabled.

### Method
POST

### Parameters
- **silentStart** (boolean) - Required - The new value.

### Return Type
io.vavr.control.Try<Void>

### Returns
A Try indicating success or failure of the set operation.
```

--------------------------------

### CreateWorldOptions.worldType()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/index-all.html

Gets the world type.

```APIDOC
## CreateWorldOptions.worldType()

### Description
Gets the world type.

### Method
Instance method

### Signature
`public WorldType worldType()`

### Returns
- **WorldType** - The world type.
```

--------------------------------

### onLoad() - MultiverseCore

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/index-all.html

Called when the plugin is loaded.

```APIDOC
## onLoad()

### Description
Called when the plugin is loaded.

### Method
onLoad

### Parameters
None

### Return Type
void
```

--------------------------------

### getRegexString

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/display/filters/RegexContentFilter.html

Get the regex string.

```APIDOC
## getRegexString

### Description
Get the regex string.

### Method
Instance method

### Signature
`public String getRegexString()`

### Returns
The regex string.
```

--------------------------------

### CreateWorldOptions.environment()

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/world/options/CreateWorldOptions.html

Gets the environment of the world to create.

```APIDOC
## CreateWorldOptions.environment()

### Description
Gets the environment of the world to create.

### Method
`public org.bukkit.World.Environment environment()`

### Returns
The environment of the world to create.
```

--------------------------------

### Constructor: CloneWorldOptions(MultiverseWorld fromWorld, String keyOrName)

Source: https://multiverse.github.io/Multiverse-Core/javadoc/latest/org/mvplugins/multiverse/core/world/options/CloneWorldOptions.html

Creates a new CloneWorldOptions instance with the specified source world and new world key or name.

```APIDOC
## Constructor: CloneWorldOptions(MultiverseWorld fromWorld, String keyOrName)

### Description
Creates a new CloneWorldOptions instance with the specified source world and new world key or name.

### Parameters
- `fromWorld` (MultiverseWorld) - Required - The world to clone.
- `keyOrName` (String) - Required - The key or name for the new world.

### Returns
A new `CloneWorldOptions` instance.

### Since
5.7
```
Tokens:
Raw