Class TCastleTiledMapData.TLayer

Unit

Declaration

type TLayer = class(TObject)

Description

This item has no description.

Source: src/scene/castletiledmap_data.inc (line 123).

Hierarchy

  • TObject
  • TCastleTiledMapData.TLayer

Enclosing Class

Overview

Fields

Public Id: Cardinal;
Public Name: String;
Public Class: String;
Public Opacity: Single;
Public Locked: Boolean;
Public OffsetX: Single;
Public OffsetY: Single;
Public Properties: TPropertyList;
Public Data: TData;
Public Color: TCastleColorRGB;
Public Width: Integer;
Public Height: Integer;
Public SwitchNode: TSwitchNode;

Methods

Public constructor Create;
Public destructor Destroy; override;
Public function Offset: TVector2;

Properties

Public property Exists: Boolean read FVisible write SetExists;
Public property Visible: Boolean read FVisible;

Description

Fields

Public Id: Cardinal;

Unique ID of the layer. Defaults to 0.

Source: src/scene/castletiledmap_data.inc (line 139).

Public Name: String;

The name of the layer.

Source: src/scene/castletiledmap_data.inc (line 141).

Public Class: String;

The class of the layer (since 1.9, defaults to '').

Source: src/scene/castletiledmap_data.inc (line 143).

Public Opacity: Single;

The opacity of the layer as a value from 0 to 1. Defaults to 1.

Source: src/scene/castletiledmap_data.inc (line 145).

Public Locked: Boolean;

Whether the layer is locked or unlocked. Defaults to false.

Source: src/scene/castletiledmap_data.inc (line 147).

Public OffsetX: Single;

Rendering offset for this layer in pixels. Defaults to 0. (since 0.14).

Source: src/scene/castletiledmap_data.inc (line 149).

Public OffsetY: Single;

Rendering offset for this layer in pixels. Defaults to 0. (since 0.14).

Source: src/scene/castletiledmap_data.inc (line 151).

Public Properties: TPropertyList;

This item has no description.

Source: src/scene/castletiledmap_data.inc (line 152).

Public Data: TData;

This item has no description.

Source: src/scene/castletiledmap_data.inc (line 153).

Public Color: TCastleColorRGB;

The color used to display the objects in this group.

Source: src/scene/castletiledmap_data.inc (line 155).

Public Width: Integer;

The width of the object group in tiles. Meaningless.

Source: src/scene/castletiledmap_data.inc (line 157).

Public Height: Integer;

The height of the object group in tiles. Meaningless.

Source: src/scene/castletiledmap_data.inc (line 159).

Public SwitchNode: TSwitchNode;

Used by the Exists-property to show/hide the layer. Not a part of the file format.

TODO: Maybe rename this to RenderData, consistent with other such data in this file. Possibly do this at new Tiled layers API work: https://castle-engine.io/roadmap#tiled_layers .

Source: src/scene/castletiledmap_data.inc (line 167).

Methods

Public constructor Create;

This item has no description.

Source: src/scene/castletiledmap_data.inc (line 168).

Public destructor Destroy; override;

This item has no description.

Source: src/scene/castletiledmap_data.inc (line 169).

Public function Offset: TVector2;

OffsetX and OffsetY packed in a vector.

Source: src/scene/castletiledmap_data.inc (line 171).

Properties

Public property Exists: Boolean read FVisible write SetExists;

Hides or shows the layer. Not a part of the file format.

TODO: This property should move to a different class, TCastleTiledMap.TLayer. See https://castle-engine.io/roadmap#tiled_layers

Source: src/scene/castletiledmap_data.inc (line 177).

Public property Visible: Boolean read FVisible;

Whether the layer is shown or hidden. Defaults to true. Use the Exists-property to change the visibility during runtime.

Source: src/scene/castletiledmap_data.inc (line 180).


Generated by PasDoc 0.17.0.snapshot.