Back to index...

NameTypeDeprecatedSecureDescription
Command.Dimension.Layout.PickupfunctionPick up the specified dimension item from the world to your inventory.
Command.Dimension.Layout.PlacefunctionPlaces the item (dimension or inventory) in your current dimension and modifies the details speci...
Command.Dimension.Layout.SelectfunctionSelects or deselects the specified dimension item.
Event.Dimension.Layout.AddSignals that a dimension item has been added.
Event.Dimension.Layout.RemoveSignals that a dimension item has been removed.
Event.Dimension.Layout.UpdateSignals that a dimension item has been updated.
Inspect.Dimension.Layout.DetailfunctionReturns details about the specified dimension item.
Inspect.Dimension.Layout.ListfunctionReturns a list of dimension items in the dimension you're currently in, and whether or not they a...

Command.Dimension.Layout.Pickup

Pick up the specified dimension item from the world to your inventory.

Usage:

Command.Dimension.Layout.Pickup(dimensionItem)
ParameterTypeDatatypeDescription
dimensionItemparameterdimensionitemThe ID of the dimension item to operate on.

Command.Dimension.Layout.Place

Places the item (dimension or inventory) in your current dimension and modifies the details specified by the values parameter.

Usage:

Command.Dimension.Layout.Place(item, values)
Command.Dimension.Layout.Place(dimensionItem, values)
ParameterTypeDatatypeDescription
dimensionItemparameterdimensionitemThe ID of the dimension item to operate on.
itemparameteritemThe inventory item to operate on.
valuesparametertableTable containing data to set on the dimension item. All parameters are optional and will default to current or default values.
coordX: The X coordinate of the item.
coordY: The Y coordinate of the item.
coordZ: The Z coordinate of the item.
pitch: The pitch rotation of the item.
roll: The roll rotation of the item.
scale: The scale of the item.
yaw: The yaw rotation of the item.

Command.Dimension.Layout.Select

Selects or deselects the specified dimension item.

Usage:

Command.Dimension.Layout.Select(dimensionItem, selected)
ParameterTypeDatatypeDescription
dimensionItemparameterdimensionitemThe ID of the dimension item to operate on.
selectedparameterbooleanIndicates if the dimension item should be selected or deselected.

Event.Dimension.Layout.Add

Signals that a dimension item has been added.

Usage:

Event.Dimension.Layout.Add(addedItem)
ParameterTypeDatatypeDescription
addedItemparametervariantThe dimension item that has been added.

Event.Dimension.Layout.Remove

Signals that a dimension item has been removed.

Usage:

Event.Dimension.Layout.Remove(removedItem)
ParameterTypeDatatypeDescription
removedItemparametervariantThe dimension item that has been removed.

Event.Dimension.Layout.Update

Signals that a dimension item has been updated.

Usage:

Event.Dimension.Layout.Update(updatedItem)
ParameterTypeDatatypeDescription
updatedItemparametervariantThe dimension item that has been updated.

Inspect.Dimension.Layout.Detail

Returns details about the specified dimension item.

Usage:

detail = Inspect.Dimension.Layout.Details(dimensionitem)
details = Inspect.Dimension.Layout.Details(dimensionitems)
ParameterTypeDatatypeDescription
dimensionitemparameterdimensionitemThe identifier of the dimension item to retrieve detail for.
dimensionitemsparametertableA table of identifiers of dimension items to retrieve detail for.
detailresulttableTable of details about the dimension item specified.
detailsresulttableDetail table for all requsted dimension items. The key is the dimension item ID, the value is the dimension item's detail table.
members
coordX The X coordinate of the item.
coordY The Y coordinate of the item.
coordZ The Z coordinate of the item.
crated Indicates that the item is crated.
icon Resource filename of the item's icon.
id The item's id.
name The name of the item.
pitch The pitch of the item.
roll The roll of the item.
scale The scale of the item.
selected Indicates that the item is selected.
type The type of the item.
yaw The yaw of the item.

Inspect.Dimension.Layout.List

Returns a list of dimension items in the dimension you're currently in, and whether or not they are crated.

Usage:

list = Inspect.Dimension.Layout.List()
ParameterTypeDatatypeDescription
listresulttableThe list of detail results.

Back to index...