Click or drag to resize

Polygon2D Properties

The Polygon2D type exposes the following members.

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

If true, polygon edges will be anti-aliased.

Public propertyBones
Public propertyColor

The polygon's fill color. If texture is defined, it will be multiplied by this color. It will also be the default color for vertices not set in vertex_colors.

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 propertyGlobalPosition

Global position.

(Inherited from Node2D.)
Public propertyGlobalRotation

Global rotation in radians.

(Inherited from Node2D.)
Public propertyGlobalRotationDegrees

Global rotation in degrees.

(Inherited from Node2D.)
Public propertyGlobalScale

Global scale.

(Inherited from Node2D.)
Public propertyGlobalTransform

Global Transform2D.

(Inherited from Node2D.)
Public propertyInternalVertexCount
Public propertyInvertBorder

Added padding applied to the bounding box when using invert. Setting this value too small may result in a "Bad Polygon" error.

Public propertyInvertEnable

If true, polygon will be inverted, containing the area outside the defined points and extending to the invert_border.

Public propertyLightMask

The rendering layers in which this CanvasItem responds to Light2D nodes.

(Inherited from CanvasItem.)
Public propertyMaterial

The material applied to textures on this CanvasItem.

(Inherited from CanvasItem.)
Public propertyModulate

The color applied to textures on this CanvasItem.

(Inherited from CanvasItem.)
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 propertyOffset

The offset applied to each vertex.

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 propertyPolygon

The polygon's list of vertices. The final point will be connected to the first.

Note: This returns a copy of the Vector2 rather than a reference.

Public propertyPolygons
Public propertyPosition

Position, relative to the node's parent.

(Inherited from Node2D.)
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 in radians, relative to the node's parent.

(Inherited from Node2D.)
Public propertyRotationDegrees

Rotation in degrees, relative to the node's parent.

(Inherited from Node2D.)
Public propertyScale

The node's scale. Unscaled value: (1, 1).

(Inherited from Node2D.)
Public propertySelfModulate

The color applied to textures on this CanvasItem. This is not inherited by children CanvasItems.

(Inherited from CanvasItem.)
Public propertyShowBehindParent

If true, the object draws behind its parent.

(Inherited from CanvasItem.)
Public propertyShowOnTop

If true, the object draws on top of its parent.

(Inherited from CanvasItem.)
Public propertySkeleton
Public propertyTexture

The polygon's fill texture. Use uv to set texture coordinates.

Public propertyTextureOffset

Amount to offset the polygon's texture. If (0, 0) the texture's origin (its top-left corner) will be placed at the polygon's position.

Public propertyTextureRotation

The texture's rotation in radians.

Public propertyTextureRotationDegrees

The texture's rotation in degrees.

Public propertyTextureScale

Amount to multiply the uv coordinates when using a texture. Larger values make the texture smaller, and vice versa.

Public propertyTransform (Inherited from Node2D.)
Public propertyUseParentMaterial

If true, the parent CanvasItem's Material property is used as this one's material.

(Inherited from CanvasItem.)
Public propertyUv

Texture coordinates for each vertex of the polygon. There should be one uv per polygon vertex. If there are fewer, undefined vertices will use (0, 0).

Public propertyVertexColors

Color for each vertex. Colors are interpolated between vertices, resulting in smooth gradients. There should be one per polygon vertex. If there are fewer, undefined vertices will use color.

Public propertyVisible

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

Note: For controls that inherit Popup, the correct way to make them visible is to call one of the multiple popup*() functions instead.

(Inherited from CanvasItem.)
Public propertyZAsRelative

If true, the node's Z index is relative to its parent's Z index. If this node's Z index is 2 and its parent's effective Z index is 3, then this node's effective Z index will be 2 + 3 = 5.

(Inherited from Node2D.)
Public propertyZIndex

Z index. Controls the order in which the nodes render. A node with a higher Z index will display in front of others.

(Inherited from Node2D.)
Top
See Also