ScriptModuleMinecraft::ScriptDimension Class Reference

Classes
struct	Key

Public Types
using	GetBlocksResult
using	SpawnEntityResult
using	SpawnEntityResult_Internal

Public Member Functions
MCAPI ::nonstd::expected< ::std::vector<::Vec3 >, ::std::variant<::ScriptModuleMinecraft::ScriptUnloadedChunksError, ::Scripting::Error > >	_getBlockPositions (::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptBlockVolumeBase > const &blockVolumeBase, ::ScriptModuleMinecraft::ScriptBlockFilter const &filter, bool allowUnloadedChunks) const
MCAPI ::Scripting::Result< ::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptActor >, ::ScriptModuleMinecraft::ScriptInvalidActorError, ::Scripting::InvalidArgumentError, ::ScriptModuleMinecraft::ScriptActorSpawnError >	_spawnEntity (::std::variant<::ScriptModuleMinecraft::ScriptActorType, ::std::string > const &identifier, ::std::variant<::BlockPos, ::Vec3 > const &pos, ::Vec2 const &rotation, bool initialPersistence, bool allowActorDefinitionSpawnEvent, ::std::string const &spawnEvent) const
MCAPI ::Scripting::Result< ::std::optional<::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptBlock > >, ::ScriptModuleMinecraft::ScriptLocationInUnloadedChunkError, ::ScriptModuleMinecraft::ScriptLocationOutOfWorldBoundsError >	getBlock (::Scripting::WeakLifetimeScope scope, ::Vec3 const &position) const
MCAPI ::Scripting::Result_deprecated< ::std::optional<::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptBlock > > >	getBlockAbove (::Scripting::WeakLifetimeScope scope, ::Vec3 const &pos, ::std::optional<::ScriptModuleMinecraft::ScriptBlockRaycastOptions > const &options) const
MCAPI ::Scripting::Result_deprecated< ::std::optional<::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptBlock > > >	getBlockBelow (::Scripting::WeakLifetimeScope scope, ::Vec3 const &pos, ::std::optional<::ScriptModuleMinecraft::ScriptBlockRaycastOptions > const &options) const
MCAPI ::std::vector<::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptActor > >	getEntitiesAtBlockLocation_V010 (::BlockPos const &pos) const
MCAPI ::Scripting::Result< int, ::Scripting::InvalidArgumentError, ::ScriptModuleMinecraft::ScriptLocationInUnloadedChunkError >	getLightLevel (::Vec3 const &location) const
MCAPI ::Scripting::Result< int, ::Scripting::InvalidArgumentError, ::ScriptModuleMinecraft::ScriptLocationInUnloadedChunkError >	getSkyLightLevel (::Vec3 const &location) const
MCAPI ::Scripting::Result< ::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptSoundInstance >, ::Scripting::PropertyOutOfBoundsError, ::Scripting::EngineError >	playSound (::Scripting::WeakLifetimeScope const &scope, ::std::string const &soundID, ::Vec3 const &location, ::std::optional<::ScriptModuleMinecraft::ScriptWorldSoundOptions > soundOptions)
MCAPI ::Scripting::Result_deprecated<::Scripting::Promise< ::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptCommandResult >, ::ScriptModuleMinecraft::ScriptCommandError > >	runCommandAsync (::Scripting::DependencyLocator &locator, ::Scripting::ContextConfig const &contextConfig, ::Scripting::ScriptObjectFactory &factory, ::std::string const &commandString)
MCAPI ::Scripting::Result_deprecated<::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptActor > >	spawnItem_V010 (::ScriptModuleMinecraft::ScriptItemStack const &scriptItemStack, ::std::variant<::BlockPos, ::Vec3 > const &pos) const

Static Public Member Functions
static MCAPI ::Scripting::ClassBinding	bind ()
static MCAPI ::Scripting::EnumBinding	bindScriptWeatherType ()
static MCAPI ::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptDimension >	getOrCreateHandle (::DimensionType id, ::Level &level, ::Scripting::WeakLifetimeScope const &scope)
static MCAPI void **	$vftable ()

Public Attributes
::ll::TypedStorage< 8, 16, ::Scripting::WeakLifetimeScope >	mScope
::ll::TypedStorage< 8, 8, ::gsl::not_null<::Dimension * > >	mDimension

Member Typedef Documentation

GetBlocksResult

using ScriptModuleMinecraft::ScriptDimension::GetBlocksResult

Initial value:

::Scripting::Result<
       ::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptListBlockVolume>,
       ::ScriptModuleMinecraft::ScriptUnloadedChunksError,
       ::Scripting::InvalidArgumentError,
       ::Scripting::ArgumentOutOfBoundsError,
       ::Scripting::Error>

SpawnEntityResult

using ScriptModuleMinecraft::ScriptDimension::SpawnEntityResult

Initial value:

::Scripting::Result<
       ::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptActor>,
       ::ScriptModuleMinecraft::ScriptInvalidActorError,
       ::ScriptModuleMinecraft::ScriptLocationInUnloadedChunkError,
       ::ScriptModuleMinecraft::ScriptLocationOutOfWorldBoundsError,
       ::Scripting::InvalidArgumentError,
       ::ScriptModuleMinecraft::ScriptActorSpawnError>

SpawnEntityResult_Internal

using ScriptModuleMinecraft::ScriptDimension::SpawnEntityResult_Internal

Initial value:

::Scripting::Result<
       ::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptActor>,
       ::ScriptModuleMinecraft::ScriptInvalidActorError,
       ::Scripting::InvalidArgumentError,
       ::ScriptModuleMinecraft::ScriptActorSpawnError>

Member Function Documentation

$vftable()

MCAPI void ** ScriptModuleMinecraft::ScriptDimension::$vftable ( )

static

Attention

This function is not yet publicly available. To request access: reference this function in your code and attempt to link. The linker will report the exact symbol name. Submit a access request at https://github.com/LiteLDev/mcapi-requests/issues/new including the full symbol name.

---

The documentation for this class was generated from the following file:

• src/mc/scripting/modules/minecraft/ScriptDimension.h