ScriptModuleMinecraft::ScriptDimension Class Reference

Classes
struct	Key

Public Types
using	GetBlocksResult
using	SpawnEntityResult
using	SpawnEntityResult_Internal

Public Member Functions
ScriptDimension &	operator= (ScriptDimension const &)
	ScriptDimension (ScriptDimension const &)
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::std::string	getId () const
MCAPI ::Scripting::Result< int, ::Scripting::InvalidArgumentError, ::ScriptModuleMinecraft::ScriptLocationInUnloadedChunkError >	getLightLevel (::Vec3 const &location) const
MCAPI::std::string	getLocalizationKey () const
MCAPI ::Scripting::Result< int, ::Scripting::InvalidArgumentError, ::ScriptModuleMinecraft::ScriptLocationInUnloadedChunkError >	getSkyLightLevel (::Vec3 const &location) const
MCAPI::ScriptModuleMinecraft::ScriptDimension &	operator= (::ScriptModuleMinecraft::ScriptDimension &&rhs)
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, 40, ::std::optional<::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::Poi::ScriptManager > > >	mPoiManager
::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

_getBlockPositions()

MCAPI ::nonstd::expected< ::std::vector<::Vec3 >, ::std::variant<::ScriptModuleMinecraft::ScriptUnloadedChunksError, ::Scripting::Error > > ScriptModuleMinecraft::ScriptDimension::_getBlockPositions	(	::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptBlockVolumeBase > const &	blockVolumeBase,
		::ScriptModuleMinecraft::ScriptBlockFilter const &	filter,
		bool	allowUnloadedChunks ) const

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.

_spawnEntity()

MCAPI ::Scripting::Result< ::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptActor >, ::ScriptModuleMinecraft::ScriptInvalidActorError, ::Scripting::InvalidArgumentError, ::ScriptModuleMinecraft::ScriptActorSpawnError > ScriptModuleMinecraft::ScriptDimension::_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

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.

getBlock()

MCAPI ::Scripting::Result< ::std::optional<::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptBlock > >, ::ScriptModuleMinecraft::ScriptLocationInUnloadedChunkError, ::ScriptModuleMinecraft::ScriptLocationOutOfWorldBoundsError > ScriptModuleMinecraft::ScriptDimension::getBlock	(	::Scripting::WeakLifetimeScope	scope,
		::Vec3 const &	position ) const

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.

getBlockAbove()

MCAPI ::Scripting::Result_deprecated< ::std::optional<::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptBlock > > > ScriptModuleMinecraft::ScriptDimension::getBlockAbove	(	::Scripting::WeakLifetimeScope	scope,
		::Vec3 const &	pos,
		::std::optional<::ScriptModuleMinecraft::ScriptBlockRaycastOptions > const &	options ) const

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.

getBlockBelow()

MCAPI ::Scripting::Result_deprecated< ::std::optional<::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptBlock > > > ScriptModuleMinecraft::ScriptDimension::getBlockBelow	(	::Scripting::WeakLifetimeScope	scope,
		::Vec3 const &	pos,
		::std::optional<::ScriptModuleMinecraft::ScriptBlockRaycastOptions > const &	options ) const

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.

getEntitiesAtBlockLocation_V010()

MCAPI ::std::vector<::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptActor > > ScriptModuleMinecraft::ScriptDimension::getEntitiesAtBlockLocation_V010

(

::BlockPos const &

pos

)

const

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.

getId()

MCAPI::std::string ScriptModuleMinecraft::ScriptDimension::getId

(

)

const

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.

getLightLevel()

MCAPI ::Scripting::Result< int, ::Scripting::InvalidArgumentError, ::ScriptModuleMinecraft::ScriptLocationInUnloadedChunkError > ScriptModuleMinecraft::ScriptDimension::getLightLevel

(

::Vec3 const &

location

)

const

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.

getLocalizationKey()

MCAPI::std::string ScriptModuleMinecraft::ScriptDimension::getLocalizationKey

(

)

const

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.

getSkyLightLevel()

MCAPI ::Scripting::Result< int, ::Scripting::InvalidArgumentError, ::ScriptModuleMinecraft::ScriptLocationInUnloadedChunkError > ScriptModuleMinecraft::ScriptDimension::getSkyLightLevel

(

::Vec3 const &

location

)

const

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.

operator=()

MCAPI::ScriptModuleMinecraft::ScriptDimension & ScriptModuleMinecraft::ScriptDimension::operator=

(

::ScriptModuleMinecraft::ScriptDimension &&

rhs

)

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.

playSound()

MCAPI ::Scripting::Result< ::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptSoundInstance >, ::Scripting::PropertyOutOfBoundsError, ::Scripting::EngineError > ScriptModuleMinecraft::ScriptDimension::playSound	(	::Scripting::WeakLifetimeScope const &	scope,
		::std::string const &	soundID,
		::Vec3 const &	location,
		::std::optional<::ScriptModuleMinecraft::ScriptWorldSoundOptions >	soundOptions )

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.

runCommandAsync()

MCAPI ::Scripting::Result_deprecated<::Scripting::Promise< ::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptCommandResult >, ::ScriptModuleMinecraft::ScriptCommandError > > ScriptModuleMinecraft::ScriptDimension::runCommandAsync	(	::Scripting::DependencyLocator &	locator,
		::Scripting::ContextConfig const &	contextConfig,
		::Scripting::ScriptObjectFactory &	factory,
		::std::string const &	commandString )

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.

spawnItem_V010()

MCAPI ::Scripting::Result_deprecated<::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptActor > > ScriptModuleMinecraft::ScriptDimension::spawnItem_V010	(	::ScriptModuleMinecraft::ScriptItemStack const &	scriptItemStack,
		::std::variant<::BlockPos, ::Vec3 > const &	pos ) const

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.

bind()

MCAPI ::Scripting::ClassBinding ScriptModuleMinecraft::ScriptDimension::bind ( )

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.

bindScriptWeatherType()

MCAPI ::Scripting::EnumBinding ScriptModuleMinecraft::ScriptDimension::bindScriptWeatherType ( )

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.

getOrCreateHandle()

MCAPI ::Scripting::StrongTypedObjectHandle<::ScriptModuleMinecraft::ScriptDimension > ScriptModuleMinecraft::ScriptDimension::getOrCreateHandle ( ::DimensionType id, ::Level & level, ::Scripting::WeakLifetimeScope const & scope )

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.

$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