CreativeHubPlugin

public class CreativeHubPlugin extends JavaPlugin

The main plugin class for Creativehub. This plugin provides gameplay features for the Hytale server. Extend this class to create a plugin.

java.lang.Object > JavaPlugin > CreativeHubPlugin

Field Summary

parentUuid

final UUID parentUuid

Field parentUuid.

hubInstance

final World hubInstance

Field hubInstance.

universe

final Universe universe

Field universe.

existingWorld

final World existingWorld

Field existingWorld.

assetPath

final Path assetPath

Field assetPath.

worldPath

final Path worldPath

Field worldPath.

start

final long start

Field start.

rel

final Path rel

Field rel.

toPath

final Path toPath

Field toPath.

world

final World world

Field world.

worldUuid

final UUID worldUuid

Field worldUuid.

holder

final Holder holder

Field holder.

existingHubConfig

final CreativeHubEntityConfig existingHubConfig

Field existingHubConfig.

parentWorld

final World parentWorld

Field parentWorld.

parentHubConfig

final CreativeHubWorldConfig parentHubConfig

Field parentHubConfig.

worldConfig

final WorldConfig worldConfig

Field worldConfig.

hubConfig

final CreativeHubWorldConfig hubConfig

Field hubConfig.

playerRef

final PlayerRef playerRef

Field playerRef.

spawnProvider

final ISpawnProvider spawnProvider

Field spawnProvider.

returnPoint

final Transform returnPoint

Field returnPoint.

instanceConfig

final InstanceEntityConfig instanceConfig

Field instanceConfig.

hubEntityConfig

final CreativeHubEntityConfig hubEntityConfig

Field hubEntityConfig.

Method Detail

get

static CreativeHubPlugin get ()

Method get.

CreativeHubPlugin

public public CreativeHubPlugin (@Nonnull final JavaPluginInit init)

Method CreativeHubPlugin.

Parameters:
@Nonnull final JavaPluginInit init

getOrSpawnHubInstance

public World getOrSpawnHubInstance (@Nonnull final World parentWorld, @Nonnull final CreativeHubWorldConfig hubConfig, @Nonnull final Transform returnPoint)

Method getOrSpawnHubInstance.

Parameters:
@Nonnull final World parentWorld
@Nonnull final CreativeHubWorldConfig hubConfig
@Nonnull final Transform returnPoint

getActiveHubInstance

public World getActiveHubInstance (@Nonnull final World parentWorld)

Method getActiveHubInstance.

Parameters:
@Nonnull final World parentWorld

clearHubInstance

public void clearHubInstance (@Nonnull final UUID parentWorldUuid)

Method clearHubInstance.

Parameters:
@Nonnull final UUID parentWorldUuid

spawnPermanentWorldFromTemplate

public CompletableFuture spawnPermanentWorldFromTemplate (@Nonnull final String instanceAssetName, @Nonnull final String permanentWorldName)

Method spawnPermanentWorldFromTemplate.

Parameters:
@Nonnull final String instanceAssetName
@Nonnull final String permanentWorldName

getCreativeHubEntityConfigComponentType

public CreativeHubEntityConfig> getCreativeHubEntityConfigComponentType ()

Method getCreativeHubEntityConfigComponentType.

setup

protected void setup ()

Method setup.

HubCommand

public new HubCommand ()

Method HubCommand.

onWorldRemove

static void onWorldRemove (@Nonnull final RemoveWorldEvent event)

Method onWorldRemove.

Parameters:
@Nonnull final RemoveWorldEvent event

onPlayerConnect

static void onPlayerConnect (@Nonnull final PlayerConnectEvent event)

Method onPlayerConnect.

Parameters:
@Nonnull final PlayerConnectEvent event

WorldReturnPoint

public new WorldReturnPoint (targetWorld.getWorldConfig()

Method WorldReturnPoint.

Parameters:
targetWorld.getWorldConfig( targetWorld.getWorldConfig(

onPlayerAddToWorld

static void onPlayerAddToWorld (@Nonnull final AddPlayerToWorldEvent event)

Method onPlayerAddToWorld.

Parameters:
@Nonnull final AddPlayerToWorldEvent event