Click or drag to resize

GridMap Properties

The GridMap type exposes the following members.

Properties
  NameDescription
Public property_ImportPath (Inherited from Node.)
Public propertyCellCenterX

If true, grid items are centered on the X axis.

Public propertyCellCenterY

If true, grid items are centered on the Y axis.

Public propertyCellCenterZ

If true, grid items are centered on the Z axis.

Public propertyCellOctantSize

The size of each octant measured in number of cells. This applies to all three axis.

Public propertyCellScale

The scale of the cell items.

This does not affect the size of the grid cells themselves, only the items in them. This can be used to make cell items overlap their neighbors.

Public propertyCellSize

The dimensions of the grid's cells.

This does not affect the size of the meshes. See CellScale.

Public propertyCollisionLayer

The physics layers this GridMap is in.

GridMaps act as static bodies, meaning they aren't affected by gravity or other forces. They only affect other physics bodies that collide with them.

Public propertyCollisionMask

The physics layers this GridMap detects collisions in. See Collision layers and masks in the documentation for more information.

Public propertyCustomMultiplayer

The override to the default MultiplayerAPI. Set to null to use the default SceneTree one.

(Inherited from Node.)
Public propertyDynamicObject
Gets a new DynamicGodotObject associated with this instance.
(Inherited from Object.)
Public propertyEditorDescription (Inherited from Node.)
Public propertyFilename

When a scene is instanced from a file, its topmost node contains the filename from which it was loaded.

(Inherited from Node.)
Public propertyGizmo

The SpatialGizmo for this node. Used for example in [!:Godot.EditorSpatialGizmo] as custom visualization and editing handles in Editor.

(Inherited from Spatial.)
Public propertyGlobalTransform

World space (global) Transform of this node.

(Inherited from Spatial.)
Public propertyMeshLibrary

The assigned MeshLibrary.

Public propertyMultiplayer

The MultiplayerAPI instance associated with this node. Either the CustomMultiplayer, or the default SceneTree one (if inside tree).

(Inherited from Node.)
Public propertyName

The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed.

Note: Auto-generated names might include the @ character, which is reserved for unique names when using AddChild(Node, Boolean). When setting the name manually, any @ will be removed.

(Inherited from Node.)
Public propertyNativeInstance (Inherited from Object.)
Public propertyOwner

The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using PackedScene), all the nodes it owns will be saved with it. This allows for the creation of complex SceneTrees, with instancing and subinstancing.

(Inherited from Node.)
Public propertyPauseMode

Pause mode. How the node will behave if the SceneTree is paused.

(Inherited from Node.)
Public propertyProcessPriority

The node's priority in the execution order of the enabled processing callbacks (i.e. , and their internal counterparts). Nodes whose process priority value is lower will have their processing callbacks executed first.

(Inherited from Node.)
Public propertyRotation

Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).

Note: In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a Vector3 data structure not because the rotation is a vector, but only because Vector3 exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful.

(Inherited from Spatial.)
Public propertyRotationDegrees

Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).

(Inherited from Spatial.)
Public propertyScale

Scale part of the local transformation.

(Inherited from Spatial.)
Public propertyTransform

Local space Transform of this node, with respect to the parent node.

(Inherited from Spatial.)
Public propertyTranslation

Local translation of this node.

(Inherited from Spatial.)
Public propertyUseInBakedLight

Controls whether this GridMap will be baked in a BakedLightmap or not.

Public propertyVisible

If true, this node is drawn. The node is only visible if all of its antecedents are visible as well (in other words, IsVisibleInTree must return true).

(Inherited from Spatial.)
Top
See Also