Reference15 / 15

SDK methods and types

Find a class or type and a lesson that shows how to use it.

Open a module in the list below. For example, scene classes are in scenes and animation classes are in tween. Each module links to a lesson.

import { Engine } from '@gamedevland/engine';
import { BaseTypedCommand } from '@gamedevland/engine/commands';
import { SchemaDecoder } from '@gamedevland/engine/validation';
import type { GameConfig } from '@gamedevland/engine/core';
Open the SDK module list 20
@gamedevland/engine/assets21 Assets and bundles →
  • AssetDescriptortype
  • AssetGlobInputtype
  • AssetGlobRecordtype
  • AssetIdtype
  • AssetIdStrategytype
  • AssetManagerAPI
  • AssetManagerOptionstype
  • AssetManifestBuilderAPI
  • AssetManifestBuilderOptionstype
  • AssetTypetype
  • AudioLoaderAPI
  • BundleBuildPolicytype
  • BundleDescriptortype
  • ConcurrencyConfigtype
  • DefaultBundleBuildPolicyAPI
  • FontLoaderAPI
  • ImageLoaderAPI
  • JsonLoaderAPI
  • Loadertype
  • PathRelativeAssetIdStrategyAPI
  • RetryConfigtype
@gamedevland/engine/audio8 Sound →
  • AudioBackendtype
  • AudioChanneltype
  • AudioHandletype
  • AudioIdtype
  • AudioManagerAPI
  • AudioManagerOptionstype
  • AudioSourceDescriptortype
  • PlayAudioOptionstype
@gamedevland/engine/commands6 Commands →
  • AppCommandContexttype
  • BaseCommandAPI
  • BaseTypedCommandAPI
  • CommandBusAPI
  • CommandEventPayloadReaderAPI
  • CommandPointerPayloadtype
@gamedevland/engine/configs28 Configuration and saves →
  • ConfigDecoderResolvertype
  • ConfigEntryAPI
  • ConfigStoreAPI
  • DecodedConfigStoreAPI
  • IndexedDbStorageAdapterAPI
  • IStateStoretype
  • IStorageAdaptertype
  • JsonConfigPathtype
  • LocaleCatalogAPI
  • LocaleDictionarytype
  • LocaleDictionaryConfigDecoderAPI
  • LocalesServiceAPI
  • LocalStorageAdapterAPI
  • PersistentStorageAdapterAPI
  • PersistentStorageBrowserConfigtype
  • PersistentStorageCoordinatorAPI
  • Settingstype
  • SettingsEntryAPI
  • SettingsServiceAPI
  • StorageNamespaceAPI
  • SupportedLocaleCodetype
  • TextStyleDeftype
  • TextStyleDropShadowDeftype
  • TextStylesConfigtype
  • TextStylesConfigDecoderAPI
  • TextStyleStrokeDeftype
  • TypedStateStoreAPI
  • TypedStateStoreOptionstype
@gamedevland/engine/core14 Engine startup →
  • CommandRuntimetype
  • EngineAPI
  • EngineCompositionRuntimetype
  • EngineOptionstype
  • GameConfigtype
  • InputRuntimetype
  • LayoutRuntimetype
  • PhysicsRuntimetype
  • PrefabRuntimetype
  • RuntimeActivityAPI
  • RuntimeActivitySnapshottype
  • RuntimePauseReasontype
  • SceneConfigtype
  • SceneManagerRuntimetype
@gamedevland/engine/di38 Dependency injection →
  • BuiltSceneDiEntrytype
  • CommandClasstype
  • CommandsGroupAPI
  • CommandTokenClasstype
  • ComponentClasstype
  • ComponentsGroupAPI
  • ComponentTokenClasstype
  • DiBootstrapValidatorAPI
  • DiContainerAPI
  • DiContainerInterfacetype
  • DiTokentype
  • DiTokensAPI
  • ElementFactoriesGroupAPI
  • ElementFactorytype
  • ElementNodeClasstype
  • EngineDiAPI
  • GameDiConfigAPI
  • GameDiConfigOptionstype
  • GameDiDefinitionAPI
  • GlobalDiDefinitionAPI
  • Providertype
  • ProviderBasetype
  • ProviderGroupAPI
  • ProviderUseClasstype
  • ProviderUseFactorytype
  • ProviderUseValuetype
  • registerElementFactoryAPI
  • registerSystemProvidersAPI
  • SceneDiConfigtype
  • SceneDiDefinitionAPI
  • SceneDiEntrytype
  • SceneServiceTokenRegistryAPI
  • SystemServicesAPI
  • Tokentype
  • TokenObjecttype
  • ValueFactorytype
  • ValuesGroupAPI
  • ValuesGroupRegistrarAPI
@gamedevland/engine/errors11 Diagnostics →
  • EngineErrorAPI
  • EngineErrorCodeAPI
  • EngineErrorCodeValuetype
  • EngineErrorDetailstype
  • EngineErrorDetailValuetype
  • EngineErrorFactoryAPI
  • EngineErrorFormatterAPI
  • EngineErrorGuardAPI
  • EngineErrorInputtype
  • EngineSubsystemAPI
  • EngineSubsystemValuetype
@gamedevland/engine/events5 Events →
  • AppEventtype
  • EventBusAPI
  • EventBusEmitInputtype
  • EventHandlertype
  • IEventBustype
@gamedevland/engine/fsm9 Finite state machine →
  • DefaultEventNormalizerAPI
  • EventNormalizertype
  • FSMConfigtype
  • FSMContexttype
  • FSMStateConfigtype
  • RawEventtype
  • SceneEventtype
  • SceneFSMAPI
  • TransitionRuletype
@gamedevland/engine/input14 Input →
  • BrowserInputGuardAPI
  • BrowserInputGuardConfigtype
  • defaultInputConfigAPI
  • DragEndReasontype
  • EngineInputEventInittype
  • HitTargettype
  • InputChannelAPI
  • InputConfigtype
  • InputEventBasetype
  • InputHandlertype
  • InputManagerAPI
  • InputRouterAPI
  • InputTypetype
  • PointerTypetype
@gamedevland/engine/interactions13 Dragging →
  • BeginDragCoreCommandBaseAPI
  • DragCoreRuntimeContexttype
  • DragCoreSessionAccessortype
  • DragCoreSessionServiceAPI
  • DragInputBridgeComponentAPI
  • DragInputPhasetype
  • DragInputRequestedPayloadtype
  • DragPointerPayloadtype
  • EndDragCoreCommandBaseAPI
  • HandleDragInputCommandBaseAPI
  • PointerOwnedEndDragCoreCommandBaseAPI
  • PointerOwnedUpdateDragCoreCommandBaseAPI
  • UpdateDragCoreCommandBaseAPI
@gamedevland/engine/layouts45 Layouts and nodes →
  • ActionConfigtype
  • ActionRegistryAPI
  • BaseActionAPI
  • BaseComponentAPI
  • BaseTypedActionAPI
  • BaseTypedComponentAPI
  • BuildContexttype
  • BuildOptionstype
  • BuildResulttype
  • BuiltElementtype
  • ComponentConfigtype
  • ComponentRegistryAPI
  • ContainerAPI
  • ContainerNodetype
  • CreatedElementtype
  • DisplacementFilterComponentAPI
  • DisplayConfigtype
  • DisplayNodetype
  • ElementConfigtype
  • ElementFactoryContexttype
  • EmptyAPI
  • GraphicsAPI
  • GraphicsNodetype
  • LayoutFiletype
  • LayoutValidationIssuetype
  • LayoutValidationResulttype
  • NodeBaseAPI
  • ParticleEmitterComponentAPI
  • PlayParticlesActionAPI
  • ResponsiveLayoutComponentAPI
  • ResponsiveLayoutRecttype
  • ResponsiveLayoutSnapshottype
  • RopePointOffsettype
  • SceneLayoutAPI
  • SpriteAPI
  • SpriteNodetype
  • SpriteTextureSizetype
  • TextAPI
  • TextNodetype
  • TextureAssetResolverAPI
  • TexturedRopeAPI
  • TexturedRopeNodetype
  • TexturedRopeTextureSizetype
  • TilingSpriteAPI
  • TilingSpriteNodetype
@gamedevland/engine/physics24 Physics →
  • PhysicsBodyForcetype
  • PhysicsBodyHandletype
  • PhysicsBodyImpulsetype
  • PhysicsBodyMaterialtype
  • PhysicsBodyMotiontype
  • PhysicsBodySnapshottype
  • PhysicsBodyVelocitytype
  • PhysicsBoundstype
  • PhysicsCircleBodyParamstype
  • PhysicsCollisionEventTypetype
  • PhysicsCollisionHandlertype
  • PhysicsCollisionPairtype
  • PhysicsCompoundPolygonBodyParamstype
  • PhysicsConfigDecoderAPI
  • PhysicsCreateWorldParamstype
  • PhysicsErrorsAPI
  • PhysicsManagerAPI
  • PhysicsPointtype
  • PhysicsPolygonBodyParamstype
  • PhysicsRectangleBodyParamstype
  • PhysicsSceneServiceAPI
  • PhysicsSceneServiceConfigtype
  • PhysicsWorldAPI
  • PhysicsWorldConfigtype
@gamedevland/engine/particles11 Particles →
  • ParticleEmitterOptionstype
  • ParticleHandletype
  • ParticlePresettype
  • ParticlePresetIdtype
  • ParticlePresetManifesttype
  • ParticlePresetResolverAPI
  • ParticlesFactoryAPI
  • ParticlesManagerAPI
  • ParticleSpawnFromAssetParamstype
  • ParticleSpawnParamstype
  • ParticleVec2type
@gamedevland/engine/platforms14 Platforms →
  • GameDistributionBootstrapContractAPI
  • GameDistributionPlatformConfigtype
  • NullPlatformAdapterAPI
  • PlatformAdaptertype
  • PlatformAdBreakHookstype
  • PlatformCatalogAPI
  • PlatformDataStorageBackendtype
  • PlatformIdtype
  • PlatformIntegrationsConfigtype
  • PlatformIntegrationsConfigContractAPI
  • PlatformManagerAPI
  • PlatformManagerOptionstype
  • PlatformRewardResulttype
  • PlatformRuntimeHookstype
@gamedevland/engine/prefabs6 Prefabs →
  • EnsuredPrefabChildtype
  • PrefabDefinitiontype
  • PrefabManagerAPI
  • PrefabRepositoryAPI
  • PrefabSpawnParamstype
  • SpawnedPrefabtype
@gamedevland/engine/scenes18 Scenes →
  • BaseSceneAPI
  • BaseSceneServiceAPI
  • FsmDrivenSceneAPI
  • FsmDrivenSceneLifecycleEventsAPI
  • Scenetype
  • SceneContexttype
  • SceneManagerAPI
  • SceneManagerOptionstype
  • SceneRuntimetype
  • SceneServicetype
  • SceneServiceContexttype
  • SceneServiceHostAPI
  • SceneServiceTickContexttype
  • SceneServiceTickPhasetype
  • SceneServiceTickPhaseResolverAPI
  • SceneTransitionOperationtype
  • SceneTransitionOptionstype
  • SceneTransitionPhasetype
@gamedevland/engine/screen11 Responsive layouts →
  • FitModetype
  • Orientationtype
  • ResizeSchedulerAPI
  • ScalerAPI
  • ScreenConfigtype
  • ScreenManagerAPI
  • ScreenProfiletype
  • ScreenRenderConfigtype
  • ScreenStateSnapshottype
  • ViewportSizetype
  • VirtualSizetype
@gamedevland/engine/tween10 Animations →
  • GsapTimelineBuilderAPI
  • GsapTweenHandleAPI
  • GsapTweenManagerAPI
  • TimelineBuildertype
  • TweenHandletype
  • TweenManagertype
  • TweenOptionstype
  • TweenPathOptionstype
  • TweenPointtype
  • TweenTargettype
@gamedevland/engine/validation12 Data validation →
  • DecodeContexttype
  • Decodertype
  • InferDecodedtype
  • InferObjecttype
  • Ruletype
  • RuleBasedValidatorAPI
  • SchemaDecoderAPI
  • ValidationContexttype
  • ValidationIssuetype
  • ValidationResulttype
  • Validatortype
  • ValidatorRegistryAPI

Vite tools

createGameViteConfig, GameViteConfig, GameViteConfigFactory, GameViteConfigFactoryOptions

Building a ZIP for Poki · Uploading to Poki

Course curriculum →