Skip to content
flatland

TileMapObject

Defined in: packages/three-flatland/src/tilemap/types.ts:124

A map object (entity, trigger, etc.).

Properties

Section titled “Properties”

ellipse?

Section titled “ellipse?”

optional ellipse?: boolean

Defined in: packages/three-flatland/src/tilemap/types.ts:146

Ellipse flag

gid?

Section titled “gid?”

optional gid?: number

Defined in: packages/three-flatland/src/tilemap/types.ts:140

Tile GID (if tile object)

height

Section titled “height”

height: number

Defined in: packages/three-flatland/src/tilemap/types.ts:136

id

Section titled “id”

id: number

Defined in: packages/three-flatland/src/tilemap/types.ts:126

Object ID

name

Section titled “name”

name: string

Defined in: packages/three-flatland/src/tilemap/types.ts:128

Object name

point?

Section titled “point?”

optional point?: boolean

Defined in: packages/three-flatland/src/tilemap/types.ts:148

Point flag

polygon?

Section titled “polygon?”

optional polygon?: object[]

Defined in: packages/three-flatland/src/tilemap/types.ts:142

Polygon points (if polygon)

x

Section titled “x”

x: number

y

Section titled “y”

y: number

polyline?

Section titled “polyline?”

optional polyline?: object[]

Defined in: packages/three-flatland/src/tilemap/types.ts:144

Polyline points (if polyline)

x

Section titled “x”

x: number

y

Section titled “y”

y: number

properties?

Section titled “properties?”

optional properties?: Record<string, unknown>

Defined in: packages/three-flatland/src/tilemap/types.ts:150

Custom properties

rotation?

Section titled “rotation?”

optional rotation?: number

Defined in: packages/three-flatland/src/tilemap/types.ts:138

Rotation in degrees

type

Section titled “type”

type: string

Defined in: packages/three-flatland/src/tilemap/types.ts:130

Object type/class

width

Section titled “width”

width: number

Defined in: packages/three-flatland/src/tilemap/types.ts:135

Size in pixels

x

Section titled “x”

x: number

Defined in: packages/three-flatland/src/tilemap/types.ts:132

Position in pixels

y

Section titled “y”

y: number

Defined in: packages/three-flatland/src/tilemap/types.ts:133

DocsExamples

Getting Started

IntroductionInstallationQuick Start

Concepts

The Flatland PipelineBatch Rendering2D LightingShadows & OcclusionDevtools Architecture

Guides

SpritesSet up a Flatland sceneAlpha API MigrationPixel-Perfect RenderingAnimationLoadersTilemapsHit TestingLightingShadowsBakingTSL NodesPass EffectsSkiaSlug TextDevtools

Resources

BrandingLLMs

API Reference

nodes/src
Interfaces
CRTOptionsDissolveOptionsLight2DResultLitSpriteOptionsOutlineOptions
Type Aliases
ColorInputFloatInputVec2InputVec3InputVec4Input
Functions
afterimageafterimageGlowafterimageTintedalphaMaskalphaMaskInvertalphaMaskValuealphaTestalphaTestOpaqueambientLight2DanalogGlitchbayerDitherbayerDither2x2bayerDither4x4bayerDither8x8bloombloomAnamorphicbloomSimplebloomThresholdblurBoxblurBox3x3blurBoxDirectionalblurBoxSmoothblurFocusblurGaussianblurGaussian2PassblurGaussian9blurKawaseblurKawaseDownblurKawaseMultiblurKawaseSimpleblurKawaseUpblurMotionblurMotionObjectblurMotionVelocityblurRadialblurRadialDistanceblurShakeblurSpinbrightnessbrightnessClampedbrightnessMultiplyc64PalettecgaPalettechromaticAberrationchromaticAberrationCustomchromaticAberrationPulsechromaticAberrationRadialcolorBleedingcolorRemapcolorRemapCustomcolorReplacecolorReplaceHardcolorReplaceMultiplecontrastcontrastSCurvecrtBloomcrtColorBleedcrtCompletecrtConvergencecrtCurvaturecrtCurvatureWithCornerscrtVignettedirectionalLight2DdissolvedissolveDirectionaldissolvePixelateddissolveSimpledistortBarreldistortBulgedistortDisplacedistortNoisedistortPerlindistortPinchdistortPixelatedistortPixelateCountdistortShatterdistortSimplexdistortSpherizedistortTurbulencedistortTwirldmgPalettedotMatrixeaglefadeEdgefadeEdgeHorizontalfadeEdgeRadialfadeEdgeVerticalfilmGrainflashflashAdditiveflashAlphaflashDamageflashHealflashPowerUpflashSmoothgbcPaletteghostghostSpeedghostTrailglowSelectivegrayscalehq2xhq3xhq4xhueShifthueShiftNormalizedinterlacinglcdBacklightBleedlcdGBClcdGhostinglcdGridlcdMotionGhostlcdPocketlinearRgbToOklablinearRgbToOklchlitCelShadedlitDiffuselitRimlitSpecularlitSpritelitSpriteMultimd9bitPalettenormalFromHeightnormalFromHeightSmoothntscCompositeoklabLerpoklabToLinearRgboklabToRgboklchHueShiftoklchLerpoklchLightnessoklchSaturateoklchToLinearRgboklchToRgboutlineoutline8palettizepalettizeDitheredpalettizeNearestphosphorApertureGrillephosphorMaskphosphorShadowMaskphosphorSimplephosphorSlotMaskpixelatepixelateBySizepocketPalettepointLight2DposterizeposterizeGammappuPalettepulsepulseGlowpulseHeartbeatpulseRadialpulseRainbowquantizequantizeRGBrgbToOklabrgbToOklchsai2xsampleSpritesaturatescale2xscale3xscanlinesscanlinesGlowscanlinesGridscanlinesInterlacedscanlinesSmoothshadow2DshadowDropshadowDropSoftshadowSDF2DshadowSoft2DshimmershimmerHolographicshimmerMetallicshimmerWavesignalInterferencesnesPalettesparklesparkleRainbowsparkleStarspeedLinesspotLight2DspriteUVstaticNoisesuperEagletinttintAdditivetrailtrailAdditivetrailBlurtrailVelocityuvFlipuvOffsetuvRotateuvScalevbPalettevhsDistortionvignettewaveHorizontalwaveRadialwaveRipplewaveVerticalwaveWater
presets/src
Variables
DefaultLightEffectNormalMapProvider
three-flatland/src
Classes
AlphaMapAnimatedSprite2DAnimationControllerBatchQueryViewEffectMaterialFlatlandFlatlandConfigForwardPlusLightingGlobalUniformsLDtkLoaderLight2DLightEffectMaterialEffectPassEffectPixelPerfectCameraRenderingConfigSortLayerSortLayerGroupSprite2DSprite2DMaterialSpriteGroupSpriteSheetLoaderTextureConfigTextureLoaderTiledLoaderTileLayerTileMap2DTileset
Interfaces
AnimatedSprite2DOptionsAnimationAnimationFrameAnimationSetDefinitionAnimationStateAtlasJsonBatchKeyBatchQueryTagChannelNodeContextChannelNodeMapChunkCoordColorTransformContextDevtoolsProviderHandleEffectFieldEffectMaterialOptionsEffectNodeContextFlatlandConfigOptionsFlatlandOptionsInstanceAttributeConfigLDtkLoaderOptionsLight2DOptionsLight2DUniformsLightEffectBuildContextLightEffectRuntimeContextNormalRegionNormalSourceDescriptorObjectLayerDataOcclusionPassOptionsOklabOklchPassEffectContextPixelPerfectCameraOptionsPlayOptionsRayPlaneHitRemoteBridgeHandleRenderingOptionsRenderStatsResolveAlphaMapOptionsSortLayerConfigSortLayerDescriptorSortLayerRegistrySprite2DMaterialOptionsSprite2DOptionsSpriteFrameSpriteFrameRectSpriteGroupOptionsSpriteSheetSpriteSheetJSONArraySpriteSheetJSONHashSpriteSheetLoaderOptionsTextureLoaderOptionsTextureOptionsTileAnimationFrameTileDefinitionTiledLoaderOptionsTileInstanceTileLayerDataTileLayerOptionsTileMap2DOptionsTileMapDataTileMapObjectTileNormalCustomDataTilesetCellTilesetDataTilesetGridTilesetGridOptionsWebSocketLike
Type Aliases
BlendModeBuiltInSortLayerChannelNameClipRectCollisionShapeColorTransformFnEffectConstantsEffectSchemaEffectSchemaValueEffectValuesFlatlandPresetFlatlandSettingHitTestModeInstanceAttributeTypeLight2DTypeLightEffectClassMaterialEffectClassNormalBumpNormalDirectionObservableStrategyPassEffectClassPassEffectFnPixelScaleRenderingPresetRenderingSettingSnapshotSortLayerNameSortLayerValueSortModeSpriteSortFunctionTexturePresetTileLookupFnUniformKeysWithRequiredChannels
Variables
ALL_HIT_TEST_MODESALPHA_SIDECAR_DESCRIPTORchannelDefaultsEFFECT_BIT_OFFSETFLATLAND_PRESETSIsAlphaBlendedBatchIsAlphaTestedBatchIsLitBatchIsUnlitBatchLIT_FLAG_MASKMAX_LIGHTS_PER_TILEobservableRECEIVE_SHADOWS_MASKRENDERING_PRESETSSortLayersTEXTURE_PRESETSTILE_SIZEVERSION
Functions
analogousapplyHierarchicalPresetsapplyTextureOptionsbuildTilesetGridclampOklchcolorToOklabcolorToOklchcomplementarycomputeTierconcatAnimationscontrastRatiocreateAnimationcreateAnimationFromPatterncreateAnimationsFromNamingcreateConsumerRemoteBridgecreateDevtoolsProvidercreateIntersectioncreateLightEffectcreateMaterialEffectcreatePassEffectcreateProviderRemoteBridgedeclareSortLayerdecodeAlphaPngdecodeDebugMessagedecodeSortKeydeltaEOklabencodeDebugMessageencodeSortKeyequallySpacedHuesframesToRegionsgamutMapOklchgetPackedComponentgetSortLayergradientOklchisDevtoolsActiveisInGamutisLight2DlerpOklablerpOklchlinearRgbToOklablinearToSrgbmonochromaticPaletteoklabToColoroklabToLinearRgboklabToOklchoklchToColoroklchToOklabrayPlaneZ0readCastShadowFlagreadEnableBitsreadFlipreadLitFlagreadReceiveShadowsFlagreadShadowRadiusreadSystemFlagsregisterDebugArrayregisterDebugTexturerelativeLuminanceresolveAlphaMapresolveHitTestModeresolvePixelPerfectresolveRenderingOptionsresolveSortLayerresolveTextureOptionsreverseAnimationshallowEqualsplitComplementarysrgbToLineartetradictilesetCellAttilesetToRegionstileToRegionstouchDebugArraytouchDebugTexturetriadicunregisterDebugArrayunregisterDebugTextureuvToWorldwcagLevelwholeTextureRegionworldToUVwrapWithLightFlags
three-flatland/src/react
Interfaces
UsePixelPerfectCameraBindingOptionsUsePixelPerfectCameraOptions
Type Aliases
EffectElementLightEffectElement
Functions
attachEffectattachLightingcreateFlatlandComputeusePixelPerfectCamerausePixelPerfectCameraBinding