Skip to content
flatland

ObjectLayerData

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

Object layer data (for entities, spawn points, etc.).

Properties

Section titled “Properties”

id

Section titled “id”

id: number

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

Layer ID

name

Section titled “name”

name: string

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

Layer name

objects

Section titled “objects”

objects: TileMapObject[]

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

Objects in this layer

offset?

Section titled “offset?”

optional offset?: object

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

Layer offset in pixels

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:118

Custom properties

visible?

Section titled “visible?”

optional visible?: boolean

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

Layer visibility

DocsExamples

Getting Started

IntroductionInstallationQuick Start

Concepts

The Flatland PipelineBatch Rendering2D LightingShadows & OcclusionDevtools Architecture

Guides

SpritesAlpha 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