unreal.PaperTileLayer

class unreal.PaperTileLayer(outer=None, name='None')

Bases: unreal.Object

This class represents a single layer in a tile map. All layers in the map must have the size dimensions.

C++ Source:

  • Plugin: Paper2D

  • Module: Paper2D

  • File: PaperTileLayer.h

Editor Properties: (see get_editor_property/set_editor_property)

  • collision_offset_override (float): [Read-Write] Collision Offset Override: The override offset of the collision for this layer (when bOverrideCollisionOffset is set) Note: This is measured in Unreal Units (cm) from the center of the tile map component, not from the previous layer.

  • collision_thickness_override (float): [Read-Write] Collision Thickness Override: The override thickness of the collision for this layer (when bOverrideCollisionThickness is set)

  • hidden_in_editor (bool): [Read-Write] Hidden in Editor: Is this layer currently hidden in the editor?

  • hidden_in_game (bool): [Read-Write] Hidden in Game: Should this layer be hidden in the game?

  • layer_collides (bool): [Read-Write] Layer Collides: Should this layer generate collision? Note: This only has an effect if the owning tile map has collision enabled

  • layer_color (LinearColor): [Read-Write] Layer Color: The color of this layer (multiplied with the tile map color and passed to the material as a vertex color)

  • layer_height (int32): [Read-Write] Layer Height: Height of the layer (in tiles)

  • layer_name (Text): [Read-Write] Layer Name: Name of the layer

  • layer_width (int32): [Read-Write] Layer Width: Width of the layer (in tiles)

  • override_collision_offset (bool): [Read-Write] Override Collision Offset: Should this layer use a custom offset for generated collision instead of the layer drawing offset?

  • override_collision_thickness (bool): [Read-Write] Override Collision Thickness: Should this layer use a custom thickness for generated collision instead of the thickness setting in the tile map?

property collision_offset_override

[Read-Only] Collision Offset Override: The override offset of the collision for this layer (when bOverrideCollisionOffset is set) Note: This is measured in Unreal Units (cm) from the center of the tile map component, not from the previous layer.

Type

(float)

property collision_thickness_override

[Read-Only] Collision Thickness Override: The override thickness of the collision for this layer (when bOverrideCollisionThickness is set)

Type

(float)

property hidden_in_game

[Read-Only] Hidden in Game: Should this layer be hidden in the game?

Type

(bool)

property layer_collides

[Read-Only] Layer Collides: Should this layer generate collision? Note: This only has an effect if the owning tile map has collision enabled

Type

(bool)

property layer_color

[Read-Only] Layer Color: The color of this layer (multiplied with the tile map color and passed to the material as a vertex color)

Type

(LinearColor)

property layer_height

[Read-Only] Layer Height: Height of the layer (in tiles)

Type

(int32)

property layer_name

[Read-Only] Layer Name: Name of the layer

Type

(Text)

property layer_width

[Read-Only] Layer Width: Width of the layer (in tiles)

Type

(int32)

property override_collision_offset

[Read-Only] Override Collision Offset: Should this layer use a custom offset for generated collision instead of the layer drawing offset?

Type

(bool)

property override_collision_thickness

[Read-Only] Override Collision Thickness: Should this layer use a custom thickness for generated collision instead of the thickness setting in the tile map?

Type

(bool)