Documentation
¶
Overview ¶
Package GridMap provides methods for working with GridMap object instances.
Index ¶
- type Advanced
- type Any
- type CellItem
- type Expanded
- type Extension
- type ID
- type Instance
- func (self Instance) AsGridMap() Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode3D() Node3D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) BakeNavigation() bool
- func (self Instance) CellCenterX() bool
- func (self Instance) CellCenterY() bool
- func (self Instance) CellCenterZ() bool
- func (self Instance) CellOctantSize() int
- func (self Instance) CellScale() Float.X
- func (self Instance) CellSize() Vector3.XYZ
- func (self Instance) Clear()
- func (self Instance) ClearBakedMeshes()
- func (self Instance) CollisionLayer() int
- func (self Instance) CollisionMask() int
- func (self Instance) CollisionPriority() Float.X
- func (self Instance) GetBakeMeshInstance(idx int) RID.Mesh
- func (self Instance) GetBakeMeshes() []any
- func (self Instance) GetBasisWithOrthogonalIndex(index int) Basis.XYZ
- func (self Instance) GetCellItem(position Vector3i.XYZ) CellItem
- func (self Instance) GetCellItemBasis(position Vector3i.XYZ) Basis.XYZ
- func (self Instance) GetCellItemOrientation(position Vector3i.XYZ) CellItem
- func (self Instance) GetCollisionLayerValue(layer_number int) bool
- func (self Instance) GetCollisionMaskValue(layer_number int) bool
- func (self Instance) GetMeshes() []any
- func (self Instance) GetNavigationMap() RID.NavigationMap3D
- func (self Instance) GetOrthogonalIndexFromBasis(basis Basis.XYZ) int
- func (self Instance) GetUsedCells() []Vector3i.XYZ
- func (self Instance) GetUsedCellsByItem(item CellItem) []Vector3i.XYZ
- func (self Instance) ID() ID
- func (self Instance) LocalToMap(local_position Vector3.XYZ) Vector3i.XYZ
- func (self Instance) MakeBakedMeshes()
- func (self Instance) MapToLocal(map_position Vector3i.XYZ) Vector3.XYZ
- func (self Instance) MeshLibrary() MeshLibrary.Instance
- func (self Instance) OnCellSizeChanged(cb func(cell_size Vector3.XYZ), flags ...Signal.Flags)
- func (self Instance) OnChanged(cb func(), flags ...Signal.Flags)
- func (self Instance) PhysicsMaterial() PhysicsMaterial.Instance
- func (self Instance) ResourceChanged(resource Resource.Instance)
- func (self Instance) SetBakeNavigation(value bool)
- func (self Instance) SetCellCenterX(value bool)
- func (self Instance) SetCellCenterY(value bool)
- func (self Instance) SetCellCenterZ(value bool)
- func (self Instance) SetCellItem(position Vector3i.XYZ, item CellItem)
- func (self Instance) SetCellOctantSize(value int)
- func (self Instance) SetCellScale(value Float.X)
- func (self Instance) SetCellSize(value Vector3.XYZ)
- func (self Instance) SetCollisionLayer(value int)
- func (self Instance) SetCollisionLayerValue(layer_number int, value bool)
- func (self Instance) SetCollisionMask(value int)
- func (self Instance) SetCollisionMaskValue(layer_number int, value bool)
- func (self Instance) SetCollisionPriority(value Float.X)
- func (self Instance) SetMeshLibrary(value MeshLibrary.Instance)
- func (self Instance) SetNavigationMap(navigation_map RID.NavigationMap3D)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetPhysicsMaterial(value PhysicsMaterial.Instance)
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type CellItem ¶
type CellItem int
const InvalidCellItem CellItem = -1 //gd:GridMap.INVALID_CELL_ITEM
type Expanded ¶
func (Expanded) MakeBakedMeshes ¶
Bakes lightmap data for all meshes in the assigned [MeshLibrary].
func (Expanded) SetCellItem ¶
Sets the mesh index for the cell referenced by its grid coordinates. A negative item index such as [constant INVALID_CELL_ITEM] will clear the cell. Optionally, the item's orientation can be passed. For valid orientation values, see [method get_orthogonal_index_from_basis].
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
GridMap lets you place meshes on a grid interactively. It works both from the editor and from scripts, which can help you create in-game level editors. GridMaps use a [MeshLibrary] which contains a list of tiles. Each tile is a mesh with materials plus optional collision and navigation shapes. A GridMap contains a collection of cells. Each grid cell refers to a tile in the [MeshLibrary]. All cells in the map have the same dimensions. Internally, a GridMap is split into a sparse collection of octants for efficient rendering and physics processing. Every octant has the same dimensions and can contain several cells. [b]Note:[/b] GridMap doesn't extend [VisualInstance3D] and therefore can't be hidden or cull masked based on [member VisualInstance3D.layers]. If you make a light not affect the first layer, the whole GridMap won't be lit by the light in question.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) BakeNavigation ¶
func (Instance) CellCenterX ¶
func (Instance) CellCenterY ¶
func (Instance) CellCenterZ ¶
func (Instance) CellOctantSize ¶
func (Instance) ClearBakedMeshes ¶
func (self Instance) ClearBakedMeshes()
Clears all baked meshes. See [method make_baked_meshes].
func (Instance) CollisionLayer ¶
func (Instance) CollisionMask ¶
func (Instance) CollisionPriority ¶
func (Instance) GetBakeMeshInstance ¶
Returns [RID] of a baked mesh with the given [param idx].
func (Instance) GetBakeMeshes ¶
Returns an array of [ArrayMesh]es and [Transform3D] references of all bake meshes that exist within the current GridMap.
func (Instance) GetBasisWithOrthogonalIndex ¶
Returns one of 24 possible rotations that lie along the vectors (x,y,z) with each component being either -1, 0, or 1. For further details, refer to the Godot source code.
func (Instance) GetCellItem ¶
The [MeshLibrary] item index located at the given grid coordinates. If the cell is empty, [constant INVALID_CELL_ITEM] will be returned.
func (Instance) GetCellItemBasis ¶
Returns the basis that gives the specified cell its orientation.
func (Instance) GetCellItemOrientation ¶
The orientation of the cell at the given grid coordinates. [code]-1[/code] is returned if the cell is empty.
func (Instance) GetCollisionLayerValue ¶
Returns whether or not the specified layer of the [member collision_layer] is enabled, given a [param layer_number] between 1 and 32.
func (Instance) GetCollisionMaskValue ¶
Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [param layer_number] between 1 and 32.
func (Instance) GetMeshes ¶
Returns an array of [Transform3D] and [Mesh] references corresponding to the non-empty cells in the grid. The transforms are specified in local space.
func (Instance) GetNavigationMap ¶
func (self Instance) GetNavigationMap() RID.NavigationMap3D
Returns the [RID] of the navigation map this GridMap node uses for its cell baked navigation meshes. This function returns always the map set on the GridMap node and not the map on the NavigationServer. If the map is changed directly with the NavigationServer API the GridMap node will not be aware of the map change.
func (Instance) GetOrthogonalIndexFromBasis ¶
This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1, 0, or 1, and returns the index (in the range from 0 to 23) of the point best representing the orientation of the object. For further details, refer to the Godot source code.
func (Instance) GetUsedCells ¶
Returns an array of [Vector3] with the non-empty cell coordinates in the grid map.
func (Instance) GetUsedCellsByItem ¶
Returns an array of all cells with the given item index specified in [param item].
func (Instance) LocalToMap ¶
Returns the map coordinates of the cell containing the given [param local_position]. If [param local_position] is in global coordinates, consider using [method Node3D.to_local] before passing it to this method. See also [method map_to_local].
func (Instance) MakeBakedMeshes ¶
func (self Instance) MakeBakedMeshes()
Bakes lightmap data for all meshes in the assigned [MeshLibrary].
func (Instance) MapToLocal ¶
Returns the position of a grid cell in the GridMap's local coordinate space. To convert the returned value into global coordinates, use [method Node3D.to_global]. See also [method local_to_map].
func (Instance) MeshLibrary ¶
func (self Instance) MeshLibrary() MeshLibrary.Instance
func (Instance) OnCellSizeChanged ¶
func (Instance) PhysicsMaterial ¶
func (self Instance) PhysicsMaterial() PhysicsMaterial.Instance
func (Instance) ResourceChanged ¶
This method does nothing.
func (Instance) SetBakeNavigation ¶
func (Instance) SetCellCenterX ¶
func (Instance) SetCellCenterY ¶
func (Instance) SetCellCenterZ ¶
func (Instance) SetCellItem ¶
Sets the mesh index for the cell referenced by its grid coordinates. A negative item index such as [constant INVALID_CELL_ITEM] will clear the cell. Optionally, the item's orientation can be passed. For valid orientation values, see [method get_orthogonal_index_from_basis].
func (Instance) SetCellOctantSize ¶
func (Instance) SetCellScale ¶
func (Instance) SetCellSize ¶
func (Instance) SetCollisionLayer ¶
func (Instance) SetCollisionLayerValue ¶
Based on [param value], enables or disables the specified layer in the [member collision_layer], given a [param layer_number] between 1 and 32.
func (Instance) SetCollisionMask ¶
func (Instance) SetCollisionMaskValue ¶
Based on [param value], enables or disables the specified layer in the [member collision_mask], given a [param layer_number] between 1 and 32.
func (Instance) SetCollisionPriority ¶
func (Instance) SetMeshLibrary ¶
func (self Instance) SetMeshLibrary(value MeshLibrary.Instance)
func (Instance) SetNavigationMap ¶
func (self Instance) SetNavigationMap(navigation_map RID.NavigationMap3D)
Sets the [RID] of the navigation map this GridMap node should use for its cell baked navigation meshes.
func (Instance) SetPhysicsMaterial ¶
func (self Instance) SetPhysicsMaterial(value PhysicsMaterial.Instance)
Source Files