Epok Engine

EPOK RUNTIME

epok::TileMapLayerComponent

Class

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Class

---- TileMapLayer -----------------------------------------------------------------------

Namespace
epok
Header
world2d_tiles.hpp
Include
#include "world2d_tiles.hpp"
Module
world2d-tiles
Source
runtime/world2d_tiles.hpp:97
Inherits from
ActorComponent

Basic usage

This generated sketch illustrates syntax for reaching the type; adapt it to the actual API contract. Open a member below for an operation-specific example.

C++ example
#include "world2d_tiles.hpp"

epok::TileMapLayerComponent& value = /* obtain a valid instance from your game */;

Fields and constants

Public methods

~TileMapLayerComponentReleases the resources owned by `epok::TileMapLayerComponent`.destructorcellThe value of a cell, runtime edits included.Methodclass_idPerforms `class id` as part of the world2d tiles module.Methodcooked_cellThe cooked value of a cell, ignoring runtime edits.Methoderase_cellPerforms `erase cell` as part of the world2d tiles module.Methodget_cell_atlas_xAtlas column of the cell's tile, or -1 when the cell is empty.Methodget_cell_atlas_yAtlas row of the cell's tile, or -1 when the cell is empty.Methodget_cell_custom_dataCustom data layer `layer` of the cell's tile; 0 for an empty cell or unknown layer.Methodis_cell_emptyReports whether cell empty as part of the world2d tiles module.Methodis_cell_solidWhether the cell's tile blocks bodies (full, rectangle or one-way collision).Methodis_visibleReports whether visible as part of the world2d tiles module.Methodlevel_attachedPerforms `level attached` as part of the world2d tiles module.Methodmap_to_world_xWorld X / Y of a cell's centre.Methodmap_to_world_yPerforms `map to world y` as part of the world2d tiles module.MethodoriginWorld pixels of the grid origin (cell 0, 0's top-left corner).Methodset_cellPlaces the atlas tile (atlas_x, atlas_y) in a cell.Methodset_cell_flippedSame as set_cell, keeping the flip flags: flip_h, flip_v and transpose.Methodset_collision_enabledSets collision enabled as part of the world2d tiles module.Methodset_modulateSets modulate as part of the world2d tiles module.Methodset_visibleSets visible as part of the world2d tiles module.Methodset_z_indexSets z index as part of the world2d tiles module.Methodtile_heightPerforms `tile height` as part of the world2d tiles module.Methodtile_ofPerforms `tile of` as part of the world2d tiles module.Methodtile_widthPerforms `tile width` as part of the world2d tiles module.Methodworld_to_map_xThe cell column containing world X / the cell row containing world Y.Methodworld_to_map_yPerforms `world to map y` as part of the world2d tiles module.Method