From 661b6165c0c632e3fee70aa80062b6d76b3af9dc Mon Sep 17 00:00:00 2001 From: thepaperpilot Date: Mon, 10 Apr 2023 13:04:12 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20profectu?= =?UTF-8?q?s-engine/profectus-docs@b7c4cefa4f8bdf55294b5404606346765189898?= =?UTF-8?q?b=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 404.html | 2 +- api/classes/game/formulas/formulas.default.html | 2 +- api/classes/lib/break_eternity.default.html | 2 +- api/classes/lib/lru-cache.LRUCache.html | 2 +- api/components/ContextComponent.html | 2 +- api/components/HotkeyComponent.html | 2 +- api/components/InfoComponent.html | 2 +- api/components/LayerComponent.html | 2 +- api/components/MarkNodeComponent.html | 2 +- api/components/ModalComponent.html | 2 +- api/components/NodeComponent.html | 2 +- api/components/SaveComponent.html | 2 +- api/components/fields/DangerButtonComponent.html | 2 +- api/components/fields/FeedbackButtonComponent.html | 2 +- api/components/fields/SelectComponent.html | 2 +- api/components/fields/SliderComponent.html | 2 +- api/components/fields/TextComponent.html | 2 +- api/components/fields/ToggleComponent.html | 2 +- api/components/layout/CollapsibleComponent.html | 2 +- api/components/layout/ColumnComponent.html | 2 +- api/components/layout/RowComponent.html | 2 +- api/components/layout/SpacerComponent.html | 2 +- api/components/layout/StickyComponent.html | 2 +- api/components/layout/VerticalRuleComponent.html | 2 +- api/components/math/FloorComponent.html | 2 +- api/components/math/SqrtComponent.html | 2 +- api/enums/data/themes.Themes.html | 2 +- .../achievement.AchievementDisplay.html | 2 +- .../features/boards/board.ProgressDisplay.html | 2 +- api/enums/features/boards/board.Shape.html | 2 +- api/enums/features/feature.Visibility.html | 2 +- api/enums/util/common.Direction.html | 2 +- .../data/common.LayerTreeNodeOptions.html | 2 +- api/interfaces/data/common.ResetButtonOptions.html | 2 +- api/interfaces/data/common.Section.html | 2 +- api/interfaces/data/themes.Theme.html | 2 +- api/interfaces/data/themes.ThemeVars.html | 2 +- .../achievement.AchievementOptions.html | 2 +- .../achievements/achievement.BaseAchievement.html | 2 +- api/interfaces/features/action.ActionOptions.html | 2 +- api/interfaces/features/action.BaseAction.html | 2 +- api/interfaces/features/bars/bar.BarOptions.html | 2 +- api/interfaces/features/bars/bar.BaseBar.html | 2 +- .../features/boards/board.BaseBoard.html | 2 +- .../features/boards/board.BaseBoardNodeAction.html | 2 +- .../features/boards/board.BaseNodeType.html | 2 +- .../features/boards/board.BoardNode.html | 2 +- .../boards/board.BoardNodeActionOptions.html | 2 +- .../features/boards/board.BoardNodeLink.html | 2 +- .../features/boards/board.BoardOptions.html | 2 +- .../features/boards/board.NodeLabel.html | 2 +- .../features/boards/board.NodeTypeOptions.html | 2 +- .../challenges/challenge.BaseChallenge.html | 2 +- .../challenges/challenge.ChallengeOptions.html | 2 +- .../clickables/clickable.BaseClickable.html | 2 +- .../clickables/clickable.ClickableOptions.html | 2 +- .../features/conversion.BaseConversion.html | 2 +- .../features/conversion.ConversionOptions.html | 2 +- api/interfaces/features/grids/grid.BaseGrid.html | 2 +- api/interfaces/features/grids/grid.GridCell.html | 2 +- .../features/grids/grid.GridOptions.html | 2 +- api/interfaces/features/hotkey.BaseHotkey.html | 2 +- api/interfaces/features/hotkey.HotkeyOptions.html | 2 +- .../features/infoboxes/infobox.BaseInfobox.html | 2 +- .../features/infoboxes/infobox.InfoboxOptions.html | 2 +- api/interfaces/features/links/links.BaseLinks.html | 2 +- api/interfaces/features/links/links.Link.html | 2 +- .../features/links/links.LinksOptions.html | 2 +- .../particles/particles.BaseParticles.html | 2 +- .../particles/particles.ParticlesOptions.html | 2 +- .../features/repeatable.BaseRepeatable.html | 2 +- .../features/repeatable.RepeatableOptions.html | 2 +- api/interfaces/features/reset.BaseReset.html | 2 +- api/interfaces/features/reset.ResetOptions.html | 2 +- .../features/resources/resource.Resource.html | 2 +- api/interfaces/features/tabs/tab.BaseTab.html | 2 +- api/interfaces/features/tabs/tab.TabOptions.html | 2 +- .../features/tabs/tabFamily.BaseTabButton.html | 2 +- .../features/tabs/tabFamily.BaseTabFamily.html | 2 +- .../features/tabs/tabFamily.TabButtonOptions.html | 2 +- .../features/tabs/tabFamily.TabFamilyOptions.html | 2 +- .../features/tooltips/tooltip.BaseTooltip.html | 2 +- .../features/tooltips/tooltip.TooltipOptions.html | 2 +- api/interfaces/features/trees/tree.BaseTree.html | 2 +- .../features/trees/tree.BaseTreeNode.html | 2 +- api/interfaces/features/trees/tree.TreeBranch.html | 2 +- .../features/trees/tree.TreeNodeOptions.html | 2 +- .../features/trees/tree.TreeOptions.html | 2 +- .../features/upgrades/upgrade.BaseUpgrade.html | 2 +- .../features/upgrades/upgrade.UpgradeOptions.html | 2 +- api/interfaces/game/events.GlobalEvents.html | 2 +- api/interfaces/game/layers.BaseLayer.html | 2 +- api/interfaces/game/layers.FeatureNode.html | 2 +- api/interfaces/game/layers.LayerEvents.html | 2 +- api/interfaces/game/layers.LayerOptions.html | 2 +- api/interfaces/game/layers.Position.html | 2 +- .../game/modifiers.AdditiveModifierOptions.html | 2 +- .../game/modifiers.ExponentialModifierOptions.html | 2 +- api/interfaces/game/modifiers.Modifier.html | 2 +- .../game/modifiers.ModifierSectionOptions.html | 2 +- .../modifiers.MultiplicativeModifierOptions.html | 2 +- api/interfaces/game/player.Player.html | 2 +- .../game/requirements.CostRequirementOptions.html | 2 +- api/interfaces/game/requirements.Requirement.html | 2 +- api/interfaces/game/settings.Settings.html | 2 +- api/interfaces/game/state.Transient.html | 2 +- .../lib/pwa-register.RegisterSWOptions.html | 2 +- api/interfaces/util/vue.VueFeature.html | 2 +- api/modules/data/common.html | 2 +- api/modules/data/projEntry.html | 2 +- api/modules/data/themes.html | 2 +- .../achievements/AchievementComponent.html | 2 +- api/modules/features/achievements/achievement.html | 2 +- api/modules/features/action.html | 2 +- api/modules/features/bars/BarComponent.html | 2 +- api/modules/features/bars/bar.html | 2 +- api/modules/features/boards/BoardComponent.html | 2 +- .../features/boards/BoardLinkComponent.html | 2 +- .../features/boards/BoardNodeComponent.html | 2 +- api/modules/features/boards/board.html | 2 +- .../features/challenges/ChallengeComponent.html | 2 +- api/modules/features/challenges/challenge.html | 2 +- .../features/clickables/ClickableComponent.html | 2 +- api/modules/features/clickables/clickable.html | 2 +- api/modules/features/conversion.html | 2 +- api/modules/features/feature.html | 2 +- api/modules/features/grids/GridCellComponent.html | 2 +- api/modules/features/grids/GridComponent.html | 2 +- api/modules/features/grids/grid.html | 2 +- api/modules/features/hotkey.html | 2 +- .../features/infoboxes/InfoboxComponent.html | 2 +- api/modules/features/infoboxes/infobox.html | 2 +- api/modules/features/links/LinkComponent.html | 2 +- api/modules/features/links/LinksComponent.html | 2 +- api/modules/features/links/links.html | 2 +- .../features/particles/ParticlesComponent.html | 2 +- api/modules/features/particles/particles.html | 2 +- api/modules/features/repeatable.html | 2 +- api/modules/features/reset.html | 2 +- .../features/resources/MainDisplayComponent.html | 2 +- .../features/resources/ResourceComponent.html | 2 +- api/modules/features/resources/resource.html | 2 +- api/modules/features/tabs/TabButtonComponent.html | 2 +- api/modules/features/tabs/TabComponent.html | 2 +- api/modules/features/tabs/TabFamilyComponent.html | 2 +- api/modules/features/tabs/tab.html | 2 +- api/modules/features/tabs/tabFamily.html | 2 +- .../features/tooltips/TooltipComponent.html | 2 +- api/modules/features/tooltips/tooltip.html | 2 +- api/modules/features/trees/TreeComponent.html | 2 +- api/modules/features/trees/TreeNodeComponent.html | 2 +- api/modules/features/trees/tree.html | 2 +- .../features/upgrades/UpgradeComponent.html | 2 +- api/modules/features/upgrades/upgrade.html | 2 +- api/modules/game/events.html | 2 +- api/modules/game/formulas/formulas.html | 2 +- api/modules/game/formulas/operations.html | 2 +- api/modules/game/formulas/types.html | 2 +- api/modules/game/gameLoop.html | 2 +- api/modules/game/layers.html | 2 +- api/modules/game/modifiers.html | 2 +- api/modules/game/notifications.html | 2 +- api/modules/game/persistence.html | 2 +- api/modules/game/player.html | 2 +- api/modules/game/requirements.html | 2 +- api/modules/game/settings.html | 2 +- api/modules/game/state.html | 2 +- api/modules/lib/break_eternity.html | 2 +- api/modules/lib/collapseTransition.html | 2 +- api/modules/lib/lru-cache.html | 2 +- api/modules/lib/pixi.html | 2 +- api/modules/lib/pwa-register.html | 2 +- api/modules/lib/vue-panzoom.html | 2 +- api/modules/lib/vue-textarea-autosize.html | 2 +- api/modules/util/bignum.html | 2 +- api/modules/util/break_eternity.html | 2 +- api/modules/util/common.html | 2 +- api/modules/util/computed.html | 2 +- api/modules/util/proxies.html | 2 +- api/modules/util/save.html | 2 +- api/modules/util/vue.html | 2 +- api/overview.html | 2 +- ...nced-concepts_creating-features.md.4c37639d.js} | 2 +- ...concepts_creating-features.md.4c37639d.lean.js} | 2 +- ...dvanced-concepts_dynamic-layers.md.f71d038a.js} | 2 +- ...ed-concepts_dynamic-layers.md.f71d038a.lean.js} | 2 +- ...> guide_advanced-concepts_nodes.md.7a309ab5.js} | 2 +- ...de_advanced-concepts_nodes.md.7a309ab5.lean.js} | 2 +- ...creating-your-project_changelog.md.d1bc7baa.js} | 2 +- ...ing-your-project_changelog.md.d1bc7baa.lean.js} | 2 +- ...ting-your-project_project-entry.md.99e6dee7.js} | 2 +- ...your-project_project-entry.md.99e6dee7.lean.js} | 2 +- ...ating-your-project_project-info.md.4c371e5e.js} | 2 +- ...-your-project_project-info.md.4c371e5e.lean.js} | 2 +- ...de_creating-your-project_themes.md.ad0d91c8.js} | 2 +- ...eating-your-project_themes.md.ad0d91c8.lean.js} | 2 +- ...ide_creating-your-project_utils.md.b7441a18.js} | 2 +- ...reating-your-project_utils.md.b7441a18.lean.js} | 2 +- ... guide_getting-started_examples.md.9aa0f345.js} | 2 +- ...e_getting-started_examples.md.9aa0f345.lean.js} | 2 +- ... => guide_getting-started_setup.md.b8a9be2d.js} | 2 +- ...uide_getting-started_setup.md.b8a9be2d.lean.js} | 2 +- ... guide_getting-started_updating.md.0e2b10bd.js} | 2 +- ...e_getting-started_updating.md.0e2b10bd.lean.js} | 2 +- ...de_important-concepts_coercable.md.d6377a4d.js} | 2 +- ...portant-concepts_coercable.md.d6377a4d.lean.js} | 2 +- ...ide_important-concepts_features.md.09bfe05c.js} | 2 +- ...mportant-concepts_features.md.09bfe05c.lean.js} | 2 +- ...ide_important-concepts_formulas.md.92a97105.js} | 2 +- ...mportant-concepts_formulas.md.92a97105.lean.js} | 2 +- ...guide_important-concepts_layers.md.5ce0f121.js} | 2 +- ..._important-concepts_layers.md.5ce0f121.lean.js} | 2 +- ..._important-concepts_persistence.md.5574dcf4.js} | 2 +- ...rtant-concepts_persistence.md.5574dcf4.lean.js} | 2 +- ...e_important-concepts_reactivity.md.ef52d055.js} | 2 +- ...ortant-concepts_reactivity.md.ef52d055.lean.js} | 2 +- ...important-concepts_requirements.md.fb6512c2.js} | 2 +- ...tant-concepts_requirements.md.fb6512c2.lean.js} | 2 +- ...x.md.02afca62.js => guide_index.md.463f69d1.js} | 2 +- ...a62.lean.js => guide_index.md.463f69d1.lean.js} | 2 +- ...1.js => guide_recipes_particles.md.d4df0645.js} | 8 ++++---- ...=> guide_recipes_particles.md.d4df0645.lean.js} | 2 +- ... => guide_recipes_save-progress.md.77ef05d3.js} | 2 +- ...uide_recipes_save-progress.md.77ef05d3.lean.js} | 2 +- .../{index.md.6970eb14.js => index.md.a72140fb.js} | 2 +- ....6970eb14.lean.js => index.md.a72140fb.lean.js} | 2 +- guide/advanced-concepts/creating-features.html | 6 +++--- guide/advanced-concepts/dynamic-layers.html | 6 +++--- guide/advanced-concepts/nodes.html | 6 +++--- guide/creating-your-project/changelog.html | 6 +++--- guide/creating-your-project/project-entry.html | 6 +++--- guide/creating-your-project/project-info.html | 6 +++--- guide/creating-your-project/themes.html | 6 +++--- guide/creating-your-project/utils.html | 6 +++--- guide/getting-started/examples.html | 6 +++--- guide/getting-started/setup.html | 6 +++--- guide/getting-started/updating.html | 6 +++--- guide/important-concepts/coercable.html | 6 +++--- guide/important-concepts/features.html | 6 +++--- guide/important-concepts/formulas.html | 6 +++--- guide/important-concepts/layers.html | 6 +++--- guide/important-concepts/persistence.html | 6 +++--- guide/important-concepts/reactivity.html | 6 +++--- guide/important-concepts/requirements.html | 6 +++--- guide/index.html | 6 +++--- guide/recipes/particles.html | 14 +++++++------- guide/recipes/save-progress.html | 6 +++--- hashmap.json | 2 +- index.html | 4 ++-- 249 files changed, 299 insertions(+), 299 deletions(-) rename assets/{guide_advanced-concepts_creating-features.md.426efab2.js => guide_advanced-concepts_creating-features.md.4c37639d.js} (99%) rename assets/{guide_advanced-concepts_creating-features.md.426efab2.lean.js => guide_advanced-concepts_creating-features.md.4c37639d.lean.js} (85%) rename assets/{guide_advanced-concepts_dynamic-layers.md.a5b2ad1d.js => guide_advanced-concepts_dynamic-layers.md.f71d038a.js} (98%) rename assets/{guide_advanced-concepts_dynamic-layers.md.a5b2ad1d.lean.js => guide_advanced-concepts_dynamic-layers.md.f71d038a.lean.js} (85%) rename assets/{guide_advanced-concepts_nodes.md.f29b361a.js => guide_advanced-concepts_nodes.md.7a309ab5.js} (99%) rename assets/{guide_advanced-concepts_nodes.md.f29b361a.lean.js => guide_advanced-concepts_nodes.md.7a309ab5.lean.js} (84%) rename assets/{guide_creating-your-project_changelog.md.2ba9cb27.js => guide_creating-your-project_changelog.md.d1bc7baa.js} (98%) rename assets/{guide_creating-your-project_changelog.md.2ba9cb27.lean.js => guide_creating-your-project_changelog.md.d1bc7baa.lean.js} (85%) rename assets/{guide_creating-your-project_project-entry.md.56be55a7.js => guide_creating-your-project_project-entry.md.99e6dee7.js} (98%) rename assets/{guide_creating-your-project_project-entry.md.56be55a7.lean.js => guide_creating-your-project_project-entry.md.99e6dee7.lean.js} (85%) rename assets/{guide_creating-your-project_project-info.md.9bccc4b8.js => guide_creating-your-project_project-info.md.4c371e5e.js} (99%) rename assets/{guide_creating-your-project_project-info.md.9bccc4b8.lean.js => guide_creating-your-project_project-info.md.4c371e5e.lean.js} (85%) rename assets/{guide_creating-your-project_themes.md.5c750649.js => guide_creating-your-project_themes.md.ad0d91c8.js} (97%) rename assets/{guide_creating-your-project_themes.md.5c750649.lean.js => guide_creating-your-project_themes.md.ad0d91c8.lean.js} (84%) rename assets/{guide_creating-your-project_utils.md.264c40cd.js => guide_creating-your-project_utils.md.b7441a18.js} (95%) rename assets/{guide_creating-your-project_utils.md.264c40cd.lean.js => guide_creating-your-project_utils.md.b7441a18.lean.js} (95%) rename assets/{guide_getting-started_examples.md.305530d8.js => guide_getting-started_examples.md.9aa0f345.js} (97%) rename assets/{guide_getting-started_examples.md.305530d8.lean.js => guide_getting-started_examples.md.9aa0f345.lean.js} (97%) rename assets/{guide_getting-started_setup.md.036f5e9e.js => guide_getting-started_setup.md.b8a9be2d.js} (99%) rename assets/{guide_getting-started_setup.md.036f5e9e.lean.js => guide_getting-started_setup.md.b8a9be2d.lean.js} (87%) rename assets/{guide_getting-started_updating.md.6193ab7a.js => guide_getting-started_updating.md.0e2b10bd.js} (98%) rename assets/{guide_getting-started_updating.md.6193ab7a.lean.js => guide_getting-started_updating.md.0e2b10bd.lean.js} (85%) rename assets/{guide_important-concepts_coercable.md.025d8a15.js => guide_important-concepts_coercable.md.d6377a4d.js} (99%) rename assets/{guide_important-concepts_coercable.md.025d8a15.lean.js => guide_important-concepts_coercable.md.d6377a4d.lean.js} (85%) rename assets/{guide_important-concepts_features.md.1957772b.js => guide_important-concepts_features.md.09bfe05c.js} (99%) rename assets/{guide_important-concepts_features.md.1957772b.lean.js => guide_important-concepts_features.md.09bfe05c.lean.js} (84%) rename assets/{guide_important-concepts_formulas.md.592f0311.js => guide_important-concepts_formulas.md.92a97105.js} (99%) rename assets/{guide_important-concepts_formulas.md.592f0311.lean.js => guide_important-concepts_formulas.md.92a97105.lean.js} (84%) rename assets/{guide_important-concepts_layers.md.12789b41.js => guide_important-concepts_layers.md.5ce0f121.js} (96%) rename assets/{guide_important-concepts_layers.md.12789b41.lean.js => guide_important-concepts_layers.md.5ce0f121.lean.js} (84%) rename assets/{guide_important-concepts_persistence.md.e64f98b0.js => guide_important-concepts_persistence.md.5574dcf4.js} (97%) rename assets/{guide_important-concepts_persistence.md.e64f98b0.lean.js => guide_important-concepts_persistence.md.5574dcf4.lean.js} (85%) rename assets/{guide_important-concepts_reactivity.md.bcec6c75.js => guide_important-concepts_reactivity.md.ef52d055.js} (97%) rename assets/{guide_important-concepts_reactivity.md.bcec6c75.lean.js => guide_important-concepts_reactivity.md.ef52d055.lean.js} (85%) rename assets/{guide_important-concepts_requirements.md.856b4ffd.js => guide_important-concepts_requirements.md.fb6512c2.js} (98%) rename assets/{guide_important-concepts_requirements.md.856b4ffd.lean.js => guide_important-concepts_requirements.md.fb6512c2.lean.js} (85%) rename assets/{guide_index.md.02afca62.js => guide_index.md.463f69d1.js} (98%) rename assets/{guide_index.md.02afca62.lean.js => guide_index.md.463f69d1.lean.js} (84%) rename assets/{guide_recipes_particles.md.30664cc1.js => guide_recipes_particles.md.d4df0645.js} (79%) rename assets/{guide_recipes_particles.md.30664cc1.lean.js => guide_recipes_particles.md.d4df0645.lean.js} (84%) rename assets/{guide_recipes_save-progress.md.300c07f4.js => guide_recipes_save-progress.md.77ef05d3.js} (99%) rename assets/{guide_recipes_save-progress.md.300c07f4.lean.js => guide_recipes_save-progress.md.77ef05d3.lean.js} (86%) rename assets/{index.md.6970eb14.js => index.md.a72140fb.js} (94%) rename assets/{index.md.6970eb14.lean.js => index.md.a72140fb.lean.js} (94%) diff --git a/404.html b/404.html index ea73a308..ec6465d8 100644 --- a/404.html +++ b/404.html @@ -19,7 +19,7 @@
Profectus

404

PAGE NOT FOUND

But if you don't change your direction, and if you keep looking, you may end up where you are heading.
Take me home
- diff --git a/api/classes/game/formulas/formulas.default.html b/api/classes/game/formulas/formulas.default.html index 0f5c1596..3211f58e 100644 --- a/api/classes/game/formulas/formulas.default.html +++ b/api/classes/game/formulas/formulas.default.html @@ -22,7 +22,7 @@
Profectus
On this page

Class: default<T> ​

game/formulas/formulas.default

A class that can be used for cost/goal functions. It can be evaluated similar to a cost function, but also provides extra features for supported formulas. For example, a lot of math functions can be inverted. Typically, the use of these extra features is to support cost/goal functions that have multiple levels purchased/completed at once efficiently.

See

Type parameters ​

NameType
Textends [FormulaSource] | FormulaSource[]

Constructors ​

constructor ​

• new default<T>(options)

Type parameters ​

NameType
Textends [FormulaSource] | FormulaSource[]

Parameters ​

NameType
optionsFormulaOptions<T>

Defined in ​

profectus/src/game/formulas/formulas.ts:59

Properties ​

applySubstitution ​

• Private Readonly applySubstitution: undefined | SubstitutionFunction<T>

Defined in ​

profectus/src/game/formulas/formulas.ts:52

divide ​

• divide: <T>(this: T, value: FormulaSource) => T<T>(this: GenericFormula, value: T) => T(this: GenericFormula, value: FormulaSource) => GenericFormula

Type declaration ​

â–¸ <T>(this, value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisT
valueFormulaSource
Returns ​

T

â–¸ <T>(this, value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisGenericFormula
valueT
Returns ​

T

â–¸ (this, value): GenericFormula

Parameters ​
NameType
thisGenericFormula
valueFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1025

divideBy ​

• divideBy: <T>(this: T, value: FormulaSource) => T<T>(this: GenericFormula, value: T) => T(this: GenericFormula, value: FormulaSource) => GenericFormula

Type declaration ​

â–¸ <T>(this, value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisT
valueFormulaSource
Returns ​

T

â–¸ <T>(this, value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisGenericFormula
valueT
Returns ​

T

â–¸ (this, value): GenericFormula

Parameters ​
NameType
thisGenericFormula
valueFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1026

dividedBy ​

• dividedBy: <T>(this: T, value: FormulaSource) => T<T>(this: GenericFormula, value: T) => T(this: GenericFormula, value: FormulaSource) => GenericFormula

Type declaration ​

â–¸ <T>(this, value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisT
valueFormulaSource
Returns ​

T

â–¸ <T>(this, value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisGenericFormula
valueT
Returns ​

T

â–¸ (this, value): GenericFormula

Parameters ​
NameType
thisGenericFormula
valueFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1027

innermostVariable ​

• Readonly innermostVariable: undefined | ProcessedComputable<DecimalSource>

Defined in ​

profectus/src/game/formulas/formulas.ts:55

inputs ​

• Readonly inputs: T

Defined in ​

profectus/src/game/formulas/formulas.ts:46

integralFormula ​

• Private integralFormula: undefined | GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:57

internalEvaluate ​

• Private Readonly internalEvaluate: undefined | EvaluateFunction<T>

Defined in ​

profectus/src/game/formulas/formulas.ts:48

internalIntegrate ​

• Private Readonly internalIntegrate: undefined | IntegrateFunction<T>

Defined in ​

profectus/src/game/formulas/formulas.ts:50

internalIntegrateInner ​

• Private Readonly internalIntegrateInner: undefined | IntegrateFunction<T>

Defined in ​

profectus/src/game/formulas/formulas.ts:51

internalInvert ​

• Private Readonly internalInvert: undefined | InvertFunction<T>

Defined in ​

profectus/src/game/formulas/formulas.ts:49

internalVariables ​

• Private Readonly internalVariables: number

Defined in ​

profectus/src/game/formulas/formulas.ts:53

logarithm ​

• logarithm: <T>(this: T, value: FormulaSource) => T<T>(this: FormulaSource, value: T) => T(this: FormulaSource, value: FormulaSource) => GenericFormula

Type declaration ​

â–¸ <T>(this, value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisT
valueFormulaSource
Returns ​

T

â–¸ <T>(this, value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisFormulaSource
valueT
Returns ​

T

â–¸ (this, value): GenericFormula

Parameters ​
NameType
thisFormulaSource
valueFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1085

minus ​

• minus: <T>(this: T, value: FormulaSource) => T<T>(this: GenericFormula, value: T) => T(this: GenericFormula, value: FormulaSource) => GenericFormula

Type declaration ​

â–¸ <T>(this, value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisT
valueFormulaSource
Returns ​

T

â–¸ <T>(this, value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisGenericFormula
valueT
Returns ​

T

â–¸ (this, value): GenericFormula

Parameters ​
NameType
thisGenericFormula
valueFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1008

multiply ​

• multiply: <T>(this: T, value: FormulaSource) => T<T>(this: GenericFormula, value: T) => T(this: GenericFormula, value: FormulaSource) => GenericFormula

Type declaration ​

â–¸ <T>(this, value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisT
valueFormulaSource
Returns ​

T

â–¸ <T>(this, value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisGenericFormula
valueT
Returns ​

T

â–¸ (this, value): GenericFormula

Parameters ​
NameType
thisGenericFormula
valueFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1016

negate ​

• negate: <T>(this: T) => T(this: GenericFormula) => GenericFormula

Type declaration ​

â–¸ <T>(this): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisT
Returns ​

T

â–¸ (this): GenericFormula

Parameters ​
NameType
thisGenericFormula
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:969

negated ​

• negated: <T>(this: T) => T(this: GenericFormula) => GenericFormula

Type declaration ​

â–¸ <T>(this): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisT
Returns ​

T

â–¸ (this): GenericFormula

Parameters ​
NameType
thisGenericFormula
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:970

plus ​

• plus: <T>(this: T, value: FormulaSource) => T<T>(this: GenericFormula, value: T) => T(this: GenericFormula, value: FormulaSource) => GenericFormula

Type declaration ​

â–¸ <T>(this, value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisT
valueFormulaSource
Returns ​

T

â–¸ <T>(this, value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisGenericFormula
valueT
Returns ​

T

â–¸ (this, value): GenericFormula

Parameters ​
NameType
thisGenericFormula
valueFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:999

reciprocal ​

• reciprocal: <T>(this: T) => T(this: FormulaSource) => GenericFormula

Type declaration ​

â–¸ <T>(this): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisT
Returns ​

T

â–¸ (this): GenericFormula

Parameters ​
NameType
thisFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1034

reciprocate ​

• reciprocate: <T>(this: T) => T(this: FormulaSource) => GenericFormula

Type declaration ​

â–¸ <T>(this): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisT
Returns ​

T

â–¸ (this): GenericFormula

Parameters ​
NameType
thisFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1035

sgn ​

• sgn: () => GenericFormula

Type declaration ​

â–¸ (): GenericFormula

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:975

subtract ​

• subtract: <T>(this: T, value: FormulaSource) => T<T>(this: GenericFormula, value: T) => T(this: GenericFormula, value: FormulaSource) => GenericFormula

Type declaration ​

â–¸ <T>(this, value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisT
valueFormulaSource
Returns ​

T

â–¸ <T>(this, value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisGenericFormula
valueT
Returns ​

T

â–¸ (this, value): GenericFormula

Parameters ​
NameType
thisGenericFormula
valueFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1007

times ​

• times: <T>(this: T, value: FormulaSource) => T<T>(this: GenericFormula, value: T) => T(this: GenericFormula, value: FormulaSource) => GenericFormula

Type declaration ​

â–¸ <T>(this, value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisT
valueFormulaSource
Returns ​

T

â–¸ <T>(this, value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
thisGenericFormula
valueT
Returns ​

T

â–¸ (this, value): GenericFormula

Parameters ​
NameType
thisGenericFormula
valueFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1017

clampMax ​

â–ª Static clampMax: (value: FormulaSource, other: FormulaSource) => default<[FormulaSource, FormulaSource]>

Type declaration ​

â–¸ (value, other): default<[FormulaSource, FormulaSource]>

Parameters ​
NameType
valueFormulaSource
otherFormulaSource
Returns ​

default<[FormulaSource, FormulaSource]>

Defined in ​

profectus/src/game/formulas/formulas.ts:533

clampMin ​

â–ª Static clampMin: (value: FormulaSource, other: FormulaSource) => default<[FormulaSource, FormulaSource]>

Type declaration ​

â–¸ (value, other): default<[FormulaSource, FormulaSource]>

Parameters ​
NameType
valueFormulaSource
otherFormulaSource
Returns ​

default<[FormulaSource, FormulaSource]>

Defined in ​

profectus/src/game/formulas/formulas.ts:532

divide ​

â–ª Static divide: <T>(value: T, other: FormulaSource) => T<T>(value: FormulaSource, other: T) => T(value: FormulaSource, other: FormulaSource) => GenericFormula = Formula.div

Type declaration ​

â–¸ <T>(value, other): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueT
otherFormulaSource
Returns ​

T

â–¸ <T>(value, other): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueFormulaSource
otherT
Returns ​

T

â–¸ (value, other): GenericFormula

Parameters ​
NameType
valueFormulaSource
otherFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:510

divideBy ​

â–ª Static divideBy: <T>(value: T, other: FormulaSource) => T<T>(value: FormulaSource, other: T) => T(value: FormulaSource, other: FormulaSource) => GenericFormula = Formula.div

Type declaration ​

â–¸ <T>(value, other): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueT
otherFormulaSource
Returns ​

T

â–¸ <T>(value, other): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueFormulaSource
otherT
Returns ​

T

â–¸ (value, other): GenericFormula

Parameters ​
NameType
valueFormulaSource
otherFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:511

dividedBy ​

â–ª Static dividedBy: <T>(value: T, other: FormulaSource) => T<T>(value: FormulaSource, other: T) => T(value: FormulaSource, other: FormulaSource) => GenericFormula = Formula.div

Type declaration ​

â–¸ <T>(value, other): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueT
otherFormulaSource
Returns ​

T

â–¸ <T>(value, other): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueFormulaSource
otherT
Returns ​

T

â–¸ (value, other): GenericFormula

Parameters ​
NameType
valueFormulaSource
otherFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:512

logarithm ​

â–ª Static logarithm: <T>(value: T, base: FormulaSource) => T<T>(value: FormulaSource, base: T) => T(value: FormulaSource, base: FormulaSource) => GenericFormula = Formula.log

Type declaration ​

â–¸ <T>(value, base): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueT
baseFormulaSource
Returns ​

T

â–¸ <T>(value, base): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueFormulaSource
baseT
Returns ​

T

â–¸ (value, base): GenericFormula

Parameters ​
NameType
valueFormulaSource
baseFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:577

max ​

â–ª Static max: (value: FormulaSource, other: FormulaSource) => default<[FormulaSource, FormulaSource]>

Type declaration ​

â–¸ (value, other): default<[FormulaSource, FormulaSource]>

Parameters ​
NameType
valueFormulaSource
otherFormulaSource
Returns ​

default<[FormulaSource, FormulaSource]>

Defined in ​

profectus/src/game/formulas/formulas.ts:528

maxabs ​

â–ª Static maxabs: (value: FormulaSource, other: FormulaSource) => default<[FormulaSource, FormulaSource]>

Type declaration ​

â–¸ (value, other): default<[FormulaSource, FormulaSource]>

Parameters ​
NameType
valueFormulaSource
otherFormulaSource
Returns ​

default<[FormulaSource, FormulaSource]>

Defined in ​

profectus/src/game/formulas/formulas.ts:531

min ​

â–ª Static min: (value: FormulaSource, other: FormulaSource) => default<[FormulaSource, FormulaSource]>

Type declaration ​

â–¸ (value, other): default<[FormulaSource, FormulaSource]>

Parameters ​
NameType
valueFormulaSource
otherFormulaSource
Returns ​

default<[FormulaSource, FormulaSource]>

Defined in ​

profectus/src/game/formulas/formulas.ts:529

minabs ​

â–ª Static minabs: (value: FormulaSource, other: FormulaSource) => default<[FormulaSource, FormulaSource]>

Type declaration ​

â–¸ (value, other): default<[FormulaSource, FormulaSource]>

Parameters ​
NameType
valueFormulaSource
otherFormulaSource
Returns ​

default<[FormulaSource, FormulaSource]>

Defined in ​

profectus/src/game/formulas/formulas.ts:530

minus ​

â–ª Static minus: <T>(value: T, other: FormulaSource) => T<T>(value: FormulaSource, other: T) => T(value: FormulaSource, other: FormulaSource) => GenericFormula = Formula.sub

Type declaration ​

â–¸ <T>(value, other): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueT
otherFormulaSource
Returns ​

T

â–¸ <T>(value, other): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueFormulaSource
otherT
Returns ​

T

â–¸ (value, other): GenericFormula

Parameters ​
NameType
valueFormulaSource
otherFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:481

multiply ​

â–ª Static multiply: <T>(value: T, other: FormulaSource) => T<T>(value: FormulaSource, other: T) => T(value: FormulaSource, other: FormulaSource) => GenericFormula = Formula.mul

Type declaration ​

â–¸ <T>(value, other): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueT
otherFormulaSource
Returns ​

T

â–¸ <T>(value, other): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueFormulaSource
otherT
Returns ​

T

â–¸ (value, other): GenericFormula

Parameters ​
NameType
valueFormulaSource
otherFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:495

negate ​

â–ª Static negate: <T>(value: T) => T(value: FormulaSource) => GenericFormula = Formula.neg

Type declaration ​

â–¸ <T>(value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueT
Returns ​

T

â–¸ (value): GenericFormula

Parameters ​
NameType
valueFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:428

negated ​

â–ª Static negated: <T>(value: T) => T(value: FormulaSource) => GenericFormula = Formula.neg

Type declaration ​

â–¸ <T>(value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueT
Returns ​

T

â–¸ (value): GenericFormula

Parameters ​
NameType
valueFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:429

plus ​

â–ª Static plus: <T>(value: T, other: FormulaSource) => T<T>(value: FormulaSource, other: T) => T(value: FormulaSource, other: FormulaSource) => GenericFormula = Formula.add

Type declaration ​

â–¸ <T>(value, other): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueT
otherFormulaSource
Returns ​

T

â–¸ <T>(value, other): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueFormulaSource
otherT
Returns ​

T

â–¸ (value, other): GenericFormula

Parameters ​
NameType
valueFormulaSource
otherFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:465

reciprocal ​

â–ª Static reciprocal: <T>(value: T) => T(value: FormulaSource) => GenericFormula = Formula.recip

Type declaration ​

â–¸ <T>(value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueT
Returns ​

T

â–¸ (value): GenericFormula

Parameters ​
NameType
valueFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:524

reciprocate ​

â–ª Static reciprocate: <T>(value: T) => T(value: FormulaSource) => GenericFormula = Formula.recip

Type declaration ​

â–¸ <T>(value): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueT
Returns ​

T

â–¸ (value): GenericFormula

Parameters ​
NameType
valueFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:525

sgn ​

â–ª Static sgn: (value: FormulaSource) => GenericFormula = Formula.sign

Type declaration ​

â–¸ (value): GenericFormula

Parameters ​
NameType
valueFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:434

subtract ​

â–ª Static subtract: <T>(value: T, other: FormulaSource) => T<T>(value: FormulaSource, other: T) => T(value: FormulaSource, other: FormulaSource) => GenericFormula = Formula.sub

Type declaration ​

â–¸ <T>(value, other): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueT
otherFormulaSource
Returns ​

T

â–¸ <T>(value, other): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueFormulaSource
otherT
Returns ​

T

â–¸ (value, other): GenericFormula

Parameters ​
NameType
valueFormulaSource
otherFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:480

times ​

â–ª Static times: <T>(value: T, other: FormulaSource) => T<T>(value: FormulaSource, other: T) => T(value: FormulaSource, other: FormulaSource) => GenericFormula = Formula.mul

Type declaration ​

â–¸ <T>(value, other): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueT
otherFormulaSource
Returns ​

T

â–¸ <T>(value, other): T

Type parameters ​
NameType
Textends default<any, T>
Parameters ​
NameType
valueFormulaSource
otherT
Returns ​

T

â–¸ (value, other): GenericFormula

Parameters ​
NameType
valueFormulaSource
otherFormulaSource
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:496

Methods ​

abs ​

â–¸ abs(): GenericFormula

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:960

absLog10 ​

â–¸ absLog10(): GenericFormula

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1069

acos ​

â–¸ acos<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1269

â–¸ acos(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1270

acosh ​

â–¸ acosh<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1305

â–¸ acosh(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1306

add ​

â–¸ add<T>(this, value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT
valueFormulaSource

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:993

â–¸ add<T>(this, value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisGenericFormula
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:994

â–¸ add(this, value): GenericFormula

Parameters ​

NameType
thisGenericFormula
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:995

asin ​

â–¸ asin<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1263

â–¸ asin(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1264

asinh ​

â–¸ asinh<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1299

â–¸ asinh(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1300

atan ​

â–¸ atan<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1275

â–¸ atan(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1276

atanh ​

â–¸ atanh<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1311

â–¸ atanh(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1312

calculateConstantOfIntegration ​

â–¸ calculateConstantOfIntegration(): default

Calculates C for the implementation of the integral formula for this formula.

Returns ​

default

Defined in ​

profectus/src/game/formulas/formulas.ts:128

cbrt ​

â–¸ cbrt<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1160

â–¸ cbrt(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1161

ceil ​

â–¸ ceil(): GenericFormula

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:985

clamp ​

â–¸ clamp(min, max): GenericFormula

Parameters ​

NameType
minFormulaSource
maxFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1053

clampMax ​

â–¸ clampMax(value): default<[FormulaSource, FormulaSource]>

Parameters ​

NameType
valueFormulaSource

Returns ​

default<[FormulaSource, FormulaSource]>

Defined in ​

profectus/src/game/formulas/formulas.ts:1061

clampMin ​

â–¸ clampMin(value): default<[FormulaSource, FormulaSource]>

Parameters ​

NameType
valueFormulaSource

Returns ​

default<[FormulaSource, FormulaSource]>

Defined in ​

profectus/src/game/formulas/formulas.ts:1057

conditional ​

â–¸ conditional(condition, formulaModifier): GenericFormula

Parameters ​

NameType
conditionComputable<boolean>
formulaModifier(value: GenericFormula & { invert: (value: DecimalSource) => DecimalSource } & { evaluateIntegral: (variable?: DecimalSource) => DecimalSource } & { invertIntegral: (value: DecimalSource) => DecimalSource }) => GenericFormula

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:951

cos ​

â–¸ cos<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1251

â–¸ cos(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1252

cosh ​

â–¸ cosh<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1287

â–¸ cosh(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1288

cube ​

â–¸ cube<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1154

â–¸ cube(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1155

div ​

â–¸ div<T>(this, value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT
valueFormulaSource

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1019

â–¸ div<T>(this, value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisGenericFormula
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1020

â–¸ div(this, value): GenericFormula

Parameters ​

NameType
thisGenericFormula
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1021

equals ​

â–¸ equals(other): boolean

Compares if two formulas are equivalent to each other. Note that function contexts can lead to false negatives.

Parameters ​

NameTypeDescription
otherGenericFormulaThe formula to compare to this one.

Returns ​

boolean

Defined in ​

profectus/src/game/formulas/formulas.ts:281

evaluate ​

â–¸ evaluate(variable?): DecimalSource

Evaluate the current result of the formula

Parameters ​

NameTypeDescription
variable?DecimalSourceOptionally override the value of the variable while evaluating. Ignored if there is not variable

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/formulas.ts:162

evaluateIntegral ​

â–¸ evaluateIntegral(variable?): DecimalSource

Evaluate the result of the indefinite integral (sans the constant of integration). Only works if there's a single variable and the formula is integrable. The formula can only have one "complex" operation (anything besides +,-,*,/).

See

isIntegrable

Parameters ​

NameTypeDescription
variable?DecimalSourceOptionally override the value of the variable while evaluating

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/formulas.ts:194

exp ​

â–¸ exp<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1137

â–¸ exp(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1138

factorial ​

â–¸ factorial(): default<[FormulaSource]>

Returns ​

default<[FormulaSource]>

Defined in ​

profectus/src/game/formulas/formulas.ts:1126

floor ​

â–¸ floor(): GenericFormula

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:981

gamma ​

â–¸ gamma(): default<[FormulaSource]>

Returns ​

default<[FormulaSource]>

Defined in ​

profectus/src/game/formulas/formulas.ts:1130

getIntegralFormula ​

â–¸ getIntegralFormula(stack?): GenericFormula

Get a formula that will evaluate to the integral of this formula. May also be invertible.

Parameters ​

NameTypeDescription
stack?SubstitutionStackFor nested formulas, a stack of operations that occur outside the complex operation.

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:217

hasVariable ​

â–¸ hasVariable(): boolean

Whether or not this formula has a singular variable inside it, which can be accessed via innermostVariable.

Returns ​

boolean

Defined in ​

profectus/src/game/formulas/formulas.ts:154

if ​

â–¸ if(condition, formulaModifier): GenericFormula

Parameters ​

NameType
conditionComputable<boolean>
formulaModifier(value: GenericFormula & { invert: (value: DecimalSource) => DecimalSource } & { evaluateIntegral: (variable?: DecimalSource) => DecimalSource } & { invertIntegral: (value: DecimalSource) => DecimalSource }) => GenericFormula

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:943

invert ​

â–¸ invert(value): DecimalSource

Takes a potential result of the formula, and calculates what value the variable inside the formula would have to be for that result to occur. Only works if there's a single variable and if the formula is invertible.

See

isInvertible

Parameters ​

NameTypeDescription
valueDecimalSourceThe result of the formula

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/formulas.ts:180

invertIntegral ​

â–¸ invertIntegral(value): DecimalSource

Given the potential result of the formula's integral (and the constant of integration), calculate what value the variable inside the formula would have to be for that result to occur. Only works if there's a single variable and if the formula's integral is invertible.

See

isIntegralInvertible

Parameters ​

NameTypeDescription
valueDecimalSourceThe result of the integral.

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/formulas.ts:206

isIntegrable ​

â–¸ isIntegrable(): this is IntegrableFormula

Type predicate that this formula can be integrated.

Returns ​

this is IntegrableFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:141

isIntegralInvertible ​

â–¸ isIntegralInvertible(): this is InvertibleIntegralFormula

Type predicate that this formula has an integral function that can be inverted.

Returns ​

this is InvertibleIntegralFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:146

isInvertible ​

â–¸ isInvertible(): this is InvertibleFormula

Type predicate that this formula can be inverted.

Returns ​

this is InvertibleFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:136

iteratedexp ​

â–¸ iteratedexp<T>(this, height?, payload?): Omit<T, "integrate">

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT
height?FormulaSource
payload?FormulaSource

Returns ​

Omit<T, "integrate">

Defined in ​

profectus/src/game/formulas/formulas.ts:1184

â–¸ iteratedexp(this, height?, payload?): GenericFormula

Parameters ​

NameType
thisFormulaSource
height?FormulaSource
payload?FormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1189

iteratedlog ​

â–¸ iteratedlog(base?, times?): GenericFormula

Parameters ​

NameTypeDefault value
baseFormulaSource10
timesFormulaSource1

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1202

lambertw ​

â–¸ lambertw<T>(this): Omit<T, "integrate">

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

Omit<T, "integrate">

Defined in ​

profectus/src/game/formulas/formulas.ts:1226

â–¸ lambertw(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1227

layeradd ​

â–¸ layeradd<T>(this, diff, base?): Omit<T, "integrate">

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT
diffFormulaSource
base?FormulaSource

Returns ​

Omit<T, "integrate">

Defined in ​

profectus/src/game/formulas/formulas.ts:1216

â–¸ layeradd(this, diff, base?): GenericFormula

Parameters ​

NameType
thisFormulaSource
diffFormulaSource
base?FormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1221

layeradd10 ​

â–¸ layeradd10(diff): default<[FormulaSource, FormulaSource]>

Parameters ​

NameType
diffFormulaSource

Returns ​

default<[FormulaSource, FormulaSource]>

Defined in ​

profectus/src/game/formulas/formulas.ts:1212

ln ​

â–¸ ln<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1093

â–¸ ln(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1094

lngamma ​

â–¸ lngamma(): default<[FormulaSource]>

Returns ​

default<[FormulaSource]>

Defined in ​

profectus/src/game/formulas/formulas.ts:1133

log ​

â–¸ log<T>(this, value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT
valueFormulaSource

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1079

â–¸ log<T>(this, value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisFormulaSource
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1080

â–¸ log(this, value): GenericFormula

Parameters ​

NameType
thisFormulaSource
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1081

log10 ​

â–¸ log10<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1073

â–¸ log10(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1074

log2 ​

â–¸ log2<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1087

â–¸ log2(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1088

max ​

â–¸ max(value): default<[FormulaSource, FormulaSource]>

Parameters ​

NameType
valueFormulaSource

Returns ​

default<[FormulaSource, FormulaSource]>

Defined in ​

profectus/src/game/formulas/formulas.ts:1037

maxabs ​

â–¸ maxabs(value): default<[FormulaSource, FormulaSource]>

Parameters ​

NameType
valueFormulaSource

Returns ​

default<[FormulaSource, FormulaSource]>

Defined in ​

profectus/src/game/formulas/formulas.ts:1045

min ​

â–¸ min(value): default<[FormulaSource, FormulaSource]>

Parameters ​

NameType
valueFormulaSource

Returns ​

default<[FormulaSource, FormulaSource]>

Defined in ​

profectus/src/game/formulas/formulas.ts:1041

minabs ​

â–¸ minabs(value): default<[FormulaSource, FormulaSource]>

Parameters ​

NameType
valueFormulaSource

Returns ​

default<[FormulaSource, FormulaSource]>

Defined in ​

profectus/src/game/formulas/formulas.ts:1049

mul ​

â–¸ mul<T>(this, value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT
valueFormulaSource

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1010

â–¸ mul<T>(this, value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisGenericFormula
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1011

â–¸ mul(this, value): GenericFormula

Parameters ​

NameType
thisGenericFormula
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1012

neg ​

â–¸ neg<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:964

â–¸ neg(this): GenericFormula

Parameters ​

NameType
thisGenericFormula

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:965

pLog10 ​

â–¸ pLog10(): GenericFormula

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1065

pentate ​

â–¸ pentate(height?, payload?): GenericFormula

Parameters ​

NameTypeDefault value
heightFormulaSource2
payloadFormulaSourceundefined

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1238

pow ​

â–¸ pow<T>(this, value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT
valueFormulaSource

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1099

â–¸ pow<T>(this, value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisFormulaSource
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1100

â–¸ pow(this, value): GenericFormula

Parameters ​

NameType
thisFormulaSource
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1101

pow10 ​

â–¸ pow10<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1106

â–¸ pow10(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1107

pow_base ​

â–¸ pow_base<T>(this, value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT
valueFormulaSource

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1112

â–¸ pow_base<T>(this, value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisFormulaSource
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1113

â–¸ pow_base(this, value): GenericFormula

Parameters ​

NameType
thisFormulaSource
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1114

recip ​

â–¸ recip<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1029

â–¸ recip(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1030

root ​

â–¸ root<T>(this, value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT
valueFormulaSource

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1119

â–¸ root<T>(this, value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisFormulaSource
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1120

â–¸ root(this, value): GenericFormula

Parameters ​

NameType
thisFormulaSource
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1121

round ​

â–¸ round(): GenericFormula

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:977

setupConstant ​

▸ Private setupConstant(«destructured»): InternalFormulaProperties<T>

Parameters ​

NameType
«destructured»Object
› inputs[FormulaSource]

Returns ​

InternalFormulaProperties<T>

Defined in ​

profectus/src/game/formulas/formulas.ts:93

setupFormula ​

â–¸ Private setupFormula(options): InternalFormulaProperties<T>

Parameters ​

NameType
optionsGeneralFormulaOptions<T>

Returns ​

InternalFormulaProperties<T>

Defined in ​

profectus/src/game/formulas/formulas.ts:103

setupVariable ​

▸ Private setupVariable(«destructured»): InternalFormulaProperties<T>

Parameters ​

NameType
«destructured»Object
› variableProcessedComputable<DecimalSource>

Returns ​

InternalFormulaProperties<T>

Defined in ​

profectus/src/game/formulas/formulas.ts:78

sign ​

â–¸ sign(): GenericFormula

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:972

sin ​

â–¸ sin<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1245

â–¸ sin(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1246

sinh ​

â–¸ sinh<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1281

â–¸ sinh(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1282

slog ​

â–¸ slog<T>(this, base?): Omit<T, "integrate">

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT
base?FormulaSource

Returns ​

Omit<T, "integrate">

Defined in ​

profectus/src/game/formulas/formulas.ts:1206

â–¸ slog(this, base?): GenericFormula

Parameters ​

NameType
thisFormulaSource
base?FormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1207

sqr ​

â–¸ sqr<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1143

â–¸ sqr(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1144

sqrt ​

â–¸ sqrt<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1149

â–¸ sqrt(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1150

ssqrt ​

â–¸ ssqrt<T>(this): Omit<T, "integrate">

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

Omit<T, "integrate">

Defined in ​

profectus/src/game/formulas/formulas.ts:1232

â–¸ ssqrt(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1233

step ​

â–¸ step(start, formulaModifier): GenericFormula

Parameters ​

NameType
startComputable<DecimalSource>
formulaModifier(value: GenericFormula & { invert: (value: DecimalSource) => DecimalSource } & { evaluateIntegral: (variable?: DecimalSource) => DecimalSource } & { invertIntegral: (value: DecimalSource) => DecimalSource }) => GenericFormula

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:934

sub ​

â–¸ sub<T>(this, value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT
valueFormulaSource

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1001

â–¸ sub<T>(this, value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisGenericFormula
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1002

â–¸ sub(this, value): GenericFormula

Parameters ​

NameType
thisGenericFormula
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1003

tan ​

â–¸ tan<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1257

â–¸ tan(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1258

tanh ​

â–¸ tanh<T>(this): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:1293

â–¸ tanh(this): GenericFormula

Parameters ​

NameType
thisFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1294

tetrate ​

â–¸ tetrate<T>(this, height?, payload?): Omit<T, "integrate">

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
thisT
height?FormulaSource
payload?FormulaSource

Returns ​

Omit<T, "integrate">

Defined in ​

profectus/src/game/formulas/formulas.ts:1166

â–¸ tetrate(this, height?, payload?): GenericFormula

Parameters ​

NameType
thisFormulaSource
height?FormulaSource
payload?FormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:1171

trunc ​

â–¸ trunc(): GenericFormula

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:989

abs ​

â–¸ Static abs(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:413

absLog10 ​

â–¸ Static absLog10(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:551

acos ​

â–¸ Static acos<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:846

â–¸ Static acos(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:847

acosh ​

â–¸ Static acosh<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:912

â–¸ Static acosh(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:913

add ​

â–¸ Static add<T>(value, other): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT
otherFormulaSource

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:452

â–¸ Static add<T>(value, other): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueFormulaSource
otherT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:453

â–¸ Static add(value, other): GenericFormula

Parameters ​

NameType
valueFormulaSource
otherFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:454

asin ​

â–¸ Static asin<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:835

â–¸ Static asin(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:836

asinh ​

â–¸ Static asinh<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:901

â–¸ Static asinh(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:902

atan ​

â–¸ Static atan<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:857

â–¸ Static atan(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:858

atanh ​

â–¸ Static atanh<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:923

â–¸ Static atanh(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:924

cbrt ​

â–¸ Static cbrt<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:689

â–¸ Static cbrt(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:690

ceil ​

â–¸ Static ceil(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:444

clamp ​

â–¸ Static clamp(value, min, max): GenericFormula

Parameters ​

NameType
valueFormulaSource
minFormulaSource
maxFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:535

conditional ​

â–¸ Static conditional(value, condition, formulaModifier): GenericFormula

See

if

Parameters ​

NameType
valueFormulaSource
conditionComputable<boolean>
formulaModifier(value: GenericFormula & { invert: (value: DecimalSource) => DecimalSource } & { evaluateIntegral: (variable?: DecimalSource) => DecimalSource } & { invertIntegral: (value: DecimalSource) => DecimalSource }) => GenericFormula

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:403

constant ​

â–¸ Static constant(value): GenericFormula & { invert: (value: DecimalSource) => DecimalSource } & { evaluateIntegral: (variable?: DecimalSource) => DecimalSource } & { invertIntegral: (value: DecimalSource) => DecimalSource }

Creates a formula that evaluates to a constant value.

Parameters ​

NameTypeDescription
valueProcessedComputable<DecimalSource>The constant value for this formula.

Returns ​

GenericFormula & { invert: (value: DecimalSource) => DecimalSource } & { evaluateIntegral: (variable?: DecimalSource) => DecimalSource } & { invertIntegral: (value: DecimalSource) => DecimalSource }

Defined in ​

profectus/src/game/formulas/formulas.ts:302

cos ​

â–¸ Static cos<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:813

â–¸ Static cos(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:814

cosh ​

â–¸ Static cosh<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:879

â–¸ Static cosh(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:880

cube ​

â–¸ Static cube<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:683

â–¸ Static cube(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:684

div ​

â–¸ Static div<T>(value, other): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT
otherFormulaSource

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:498

â–¸ Static div<T>(value, other): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueFormulaSource
otherT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:499

â–¸ Static div(value, other): GenericFormula

Parameters ​

NameType
valueFormulaSource
otherFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:500

exp ​

â–¸ Static exp<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:660

â–¸ Static exp(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:661

factorial ​

â–¸ Static factorial(value): default<[FormulaSource]>

Parameters ​

NameType
valueFormulaSource

Returns ​

default<[FormulaSource]>

Defined in ​

profectus/src/game/formulas/formulas.ts:648

floor ​

â–¸ Static floor(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:440

gamma ​

â–¸ Static gamma(value): default<[FormulaSource]>

Parameters ​

NameType
valueFormulaSource

Returns ​

default<[FormulaSource]>

Defined in ​

profectus/src/game/formulas/formulas.ts:652

if ​

â–¸ Static if(value, condition, formulaModifier): GenericFormula

Applies a modifier to a formula under a given condition.

Parameters ​

NameTypeDescription
valueFormulaSourceThe incoming formula value
conditionComputable<boolean>Whether or not to apply the modifier
formulaModifier(value: GenericFormula & { invert: (value: DecimalSource) => DecimalSource } & { evaluateIntegral: (variable?: DecimalSource) => DecimalSource } & { invertIntegral: (value: DecimalSource) => DecimalSource }) => GenericFormulaThe modifier to apply to the incoming formula if the condition is true

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:368

iteratedexp ​

â–¸ Static iteratedexp<T>(value, height?, payload?): Omit<T, "integrate">

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT
height?FormulaSource
payload?FormulaSource

Returns ​

Omit<T, "integrate">

Defined in ​

profectus/src/game/formulas/formulas.ts:717

â–¸ Static iteratedexp(value, height?, payload?): GenericFormula

Parameters ​

NameType
valueFormulaSource
height?FormulaSource
payload?FormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:722

iteratedlog ​

â–¸ Static iteratedlog(value, base?, times?): GenericFormula

Parameters ​

NameTypeDefault value
valueFormulaSourceundefined
baseFormulaSource10
timesFormulaSource1

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:739

lambertw ​

â–¸ Static lambertw<T>(value): Omit<T, "integrate">

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

Omit<T, "integrate">

Defined in ​

profectus/src/game/formulas/formulas.ts:778

â–¸ Static lambertw(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:779

layeradd ​

â–¸ Static layeradd<T>(value, diff, base?): Omit<T, "integrate">

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT
diffFormulaSource
base?FormulaSource

Returns ​

Omit<T, "integrate">

Defined in ​

profectus/src/game/formulas/formulas.ts:760

â–¸ Static layeradd(value, diff, base?): GenericFormula

Parameters ​

NameType
valueFormulaSource
diffFormulaSource
base?FormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:765

layeradd10 ​

â–¸ Static layeradd10(value, diff): default<[FormulaSource, FormulaSource]>

Parameters ​

NameType
valueFormulaSource
diffFormulaSource

Returns ​

default<[FormulaSource, FormulaSource]>

Defined in ​

profectus/src/game/formulas/formulas.ts:756

ln ​

â–¸ Static ln<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:590

â–¸ Static ln(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:591

lngamma ​

â–¸ Static lngamma(value): default<[FormulaSource]>

Parameters ​

NameType
valueFormulaSource

Returns ​

default<[FormulaSource]>

Defined in ​

profectus/src/game/formulas/formulas.ts:656

log ​

â–¸ Static log<T>(value, base): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT
baseFormulaSource

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:566

â–¸ Static log<T>(value, base): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueFormulaSource
baseT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:567

â–¸ Static log(value, base): GenericFormula

Parameters ​

NameType
valueFormulaSource
baseFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:568

log10 ​

â–¸ Static log10<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:555

â–¸ Static log10(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:556

log2 ​

â–¸ Static log2<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:579

â–¸ Static log2(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:580

mul ​

â–¸ Static mul<T>(value, other): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT
otherFormulaSource

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:483

â–¸ Static mul<T>(value, other): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueFormulaSource
otherT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:484

â–¸ Static mul(value, other): GenericFormula

Parameters ​

NameType
valueFormulaSource
otherFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:485

neg ​

â–¸ Static neg<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:417

â–¸ Static neg(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:418

pLog10 ​

â–¸ Static pLog10(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:547

pentate ​

â–¸ Static pentate(value, height?, payload?): GenericFormula

Parameters ​

NameTypeDefault value
valueFormulaSourceundefined
heightFormulaSource2
payloadFormulaSourceundefined

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:794

pow ​

â–¸ Static pow<T>(value, other): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT
otherFormulaSource

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:601

â–¸ Static pow<T>(value, other): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueFormulaSource
otherT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:602

â–¸ Static pow(value, other): GenericFormula

Parameters ​

NameType
valueFormulaSource
otherFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:603

pow10 ​

â–¸ Static pow10<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:613

â–¸ Static pow10(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:614

pow_base ​

â–¸ Static pow_base<T>(value, other): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT
otherFormulaSource

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:624

â–¸ Static pow_base<T>(value, other): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueFormulaSource
otherT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:625

â–¸ Static pow_base(value, other): GenericFormula

Parameters ​

NameType
valueFormulaSource
otherFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:626

recip ​

â–¸ Static recip<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:514

â–¸ Static recip(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:515

root ​

â–¸ Static root<T>(value, other): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT
otherFormulaSource

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:636

â–¸ Static root<T>(value, other): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueFormulaSource
otherT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:637

â–¸ Static root(value, other): GenericFormula

Parameters ​

NameType
valueFormulaSource
otherFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:638

round ​

â–¸ Static round(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:436

sign ​

â–¸ Static sign(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:431

sin ​

â–¸ Static sin<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:802

â–¸ Static sin(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:803

sinh ​

â–¸ Static sinh<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:868

â–¸ Static sinh(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:869

slog ​

â–¸ Static slog<T>(value, base?): Omit<T, "integrate">

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT
base?FormulaSource

Returns ​

Omit<T, "integrate">

Defined in ​

profectus/src/game/formulas/formulas.ts:747

â–¸ Static slog(value, base?): GenericFormula

Parameters ​

NameType
valueFormulaSource
base?FormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:751

sqr ​

â–¸ Static sqr<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:671

â–¸ Static sqr(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:672

sqrt ​

â–¸ Static sqrt<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:677

â–¸ Static sqrt(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:678

ssqrt ​

â–¸ Static ssqrt<T>(value): Omit<T, "integrate">

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

Omit<T, "integrate">

Defined in ​

profectus/src/game/formulas/formulas.ts:788

â–¸ Static ssqrt(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:789

step ​

â–¸ Static step(value, start, formulaModifier): GenericFormula

Creates a step-wise formula. After start the formula will have an additional modifier. This function assumes the incoming value will be continuous and monotonically increasing.

Parameters ​

NameTypeDescription
valueFormulaSourceThe value before applying the step
startComputable<DecimalSource>The value at which to start applying the step
formulaModifier(value: GenericFormula & { invert: (value: DecimalSource) => DecimalSource } & { evaluateIntegral: (variable?: DecimalSource) => DecimalSource } & { invertIntegral: (value: DecimalSource) => DecimalSource }) => GenericFormulaHow this step should modify the formula. The incoming value will be the unmodified formula value minus the start value. So for example if an incoming formula evaluates to 200 and has a step that starts at 150, the formulaModifier would be given 50 as the parameter

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:326

sub ​

â–¸ Static sub<T>(value, other): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT
otherFormulaSource

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:467

â–¸ Static sub<T>(value, other): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueFormulaSource
otherT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:468

â–¸ Static sub(value, other): GenericFormula

Parameters ​

NameType
valueFormulaSource
otherFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:469

tan ​

â–¸ Static tan<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:824

â–¸ Static tan(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:825

tanh ​

â–¸ Static tanh<T>(value): T

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/formulas.ts:890

â–¸ Static tanh(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:891

tetrate ​

â–¸ Static tetrate<T>(value, height?, payload?): Omit<T, "integrate">

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameType
valueT
height?FormulaSource
payload?FormulaSource

Returns ​

Omit<T, "integrate">

Defined in ​

profectus/src/game/formulas/formulas.ts:695

â–¸ Static tetrate(value, height?, payload?): GenericFormula

Parameters ​

NameType
valueFormulaSource
height?FormulaSource
payload?FormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:700

trunc ​

â–¸ Static trunc(value): GenericFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:448

variable ​

â–¸ Static variable(value): GenericFormula & { invert: (value: DecimalSource) => DecimalSource } & { evaluateIntegral: (variable?: DecimalSource) => DecimalSource } & { invertIntegral: (value: DecimalSource) => DecimalSource }

Creates a formula that is marked as the variable for an outer formula. Typically used for inverting and integrating.

Parameters ​

NameTypeDescription
valueProcessedComputable<DecimalSource>The variable for this formula.

Returns ​

GenericFormula & { invert: (value: DecimalSource) => DecimalSource } & { evaluateIntegral: (variable?: DecimalSource) => DecimalSource } & { invertIntegral: (value: DecimalSource) => DecimalSource }

Defined in ​

profectus/src/game/formulas/formulas.ts:312

- diff --git a/api/classes/lib/break_eternity.default.html b/api/classes/lib/break_eternity.default.html index b761eb57..480bc6ad 100644 --- a/api/classes/lib/break_eternity.default.html +++ b/api/classes/lib/break_eternity.default.html @@ -22,7 +22,7 @@
Profectus
On this page

Class: default ​

lib/break_eternity.default

The Decimal's value is simply mantissa * 10^exponent.

Constructors ​

constructor ​

• new default(value?)

Parameters ​

NameType
value?DecimalSource

Defined in ​

profectus/src/lib/break_eternity.ts:364

Properties ​

layer ​

• layer: number = 0

Defined in ​

profectus/src/lib/break_eternity.ts:362

mag ​

• mag: number = 0

Defined in ​

profectus/src/lib/break_eternity.ts:361

sign ​

• sign: number = 0

Defined in ​

profectus/src/lib/break_eternity.ts:360

dInf ​

â–ª Static dInf: default

Defined in ​

profectus/src/lib/break_eternity.ts:353

dNaN ​

â–ª Static dNaN: default

Defined in ​

profectus/src/lib/break_eternity.ts:352

dNegInf ​

â–ª Static dNegInf: default

Defined in ​

profectus/src/lib/break_eternity.ts:354

dNegOne ​

â–ª Static dNegOne: default

Defined in ​

profectus/src/lib/break_eternity.ts:349

dNumberMax ​

â–ª Static dNumberMax: default

Defined in ​

profectus/src/lib/break_eternity.ts:355

dNumberMin ​

â–ª Static dNumberMin: default

Defined in ​

profectus/src/lib/break_eternity.ts:356

dOne ​

â–ª Static dOne: default

Defined in ​

profectus/src/lib/break_eternity.ts:348

dTen ​

â–ª Static dTen: default

Defined in ​

profectus/src/lib/break_eternity.ts:351

dTwo ​

â–ª Static dTwo: default

Defined in ​

profectus/src/lib/break_eternity.ts:350

dZero ​

â–ª Static dZero: default

Defined in ​

profectus/src/lib/break_eternity.ts:347

fromStringCache ​

â–ª Static Private fromStringCache: LRUCache<string, default>

Defined in ​

profectus/src/lib/break_eternity.ts:358

Accessors ​

e ​

• get e(): number

Returns ​

number

Defined in ​

profectus/src/lib/break_eternity.ts:409

• set e(value): void

Parameters ​

NameType
valuenumber

Returns ​

void

Defined in ​

profectus/src/lib/break_eternity.ts:422

exponent ​

• get exponent(): number

Returns ​

number

Defined in ​

profectus/src/lib/break_eternity.ts:448

• set exponent(value): void

Parameters ​

NameType
valuenumber

Returns ​

void

Defined in ​

profectus/src/lib/break_eternity.ts:451

m ​

• get m(): number

Returns ​

number

Defined in ​

profectus/src/lib/break_eternity.ts:374

• set m(value): void

Parameters ​

NameType
valuenumber

Returns ​

void

Defined in ​

profectus/src/lib/break_eternity.ts:396

mantissa ​

• get mantissa(): number

Returns ​

number

Defined in ​

profectus/src/lib/break_eternity.ts:440

• set mantissa(value): void

Parameters ​

NameType
valuenumber

Returns ​

void

Defined in ​

profectus/src/lib/break_eternity.ts:444

s ​

• get s(): number

Returns ​

number

Defined in ​

profectus/src/lib/break_eternity.ts:426

• set s(value): void

Parameters ​

NameType
valuenumber

Returns ​

void

Defined in ​

profectus/src/lib/break_eternity.ts:429

Methods ​

abs ​

â–¸ abs(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1634

absLog10 ​

â–¸ absLog10(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2107

acos ​

â–¸ acos(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2883

acosh ​

â–¸ acosh(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2919

add ​

â–¸ add(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1698

ascensionPenalty ​

â–¸ ascensionPenalty(ascensions): default

Joke function from Realm Grinder

Parameters ​

NameType
ascensionsDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2934

asin ​

â–¸ asin(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2873

asinh ​

â–¸ asinh(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2915

atan ​

â–¸ atan(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2893

atanh ​

â–¸ atanh(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2923

cbrt ​

â–¸ cbrt(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2361

ceil ​

â–¸ ceil(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1678

clamp ​

â–¸ clamp(min, max): default

Parameters ​

NameType
minDecimalSource
maxDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2018

clampMax ​

â–¸ clampMax(max): default

Parameters ​

NameType
maxDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2026

clampMin ​

â–¸ clampMin(min): default

Parameters ​

NameType
minDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2022

cmp ​

â–¸ cmp(value): CompareResult

-1 for less than value, 0 for equals value, 1 for greater than value

Parameters ​

NameType
valueDecimalSource

Returns ​

CompareResult

Defined in ​

profectus/src/lib/break_eternity.ts:1921

cmp_tolerance ​

â–¸ cmp_tolerance(value, tolerance): CompareResult

Parameters ​

NameType
valueDecimalSource
tolerancenumber

Returns ​

CompareResult

Defined in ​

profectus/src/lib/break_eternity.ts:2030

cmpabs ​

â–¸ cmpabs(value): CompareResult

Parameters ​

NameType
valueDecimalSource

Returns ​

CompareResult

Defined in ​

profectus/src/lib/break_eternity.ts:1932

compare ​

â–¸ compare(value): CompareResult

Parameters ​

NameType
valueDecimalSource

Returns ​

CompareResult

Defined in ​

profectus/src/lib/break_eternity.ts:1951

compare_tolerance ​

â–¸ compare_tolerance(value, tolerance): CompareResult

Parameters ​

NameType
valueDecimalSource
tolerancenumber

Returns ​

CompareResult

Defined in ​

profectus/src/lib/break_eternity.ts:2035

cos ​

â–¸ cos(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2853

cosh ​

â–¸ cosh(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2907

cube ​

â–¸ cube(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2357

div ​

â–¸ div(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1883

divide ​

â–¸ divide(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1888

divideBy ​

â–¸ divideBy(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1892

dividedBy ​

â–¸ dividedBy(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1896

egg ​

â–¸ egg(): default

Joke function from Cookie Clicker. It's 'egg'

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2945

eq ​

â–¸ eq(value): boolean

Parameters ​

NameType
valueDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:1963

eq_tolerance ​

â–¸ eq_tolerance(value, tolerance?): boolean

Tolerance is a relative tolerance, multiplied by the greater of the magnitudes of the two arguments. For example, if you put in 1e-9, then any number closer to the larger number than (larger number)*1e-9 will be considered equal.

Parameters ​

NameType
valueDecimalSource
tolerance?number

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:2044

equals ​

â–¸ equals(value): boolean

Parameters ​

NameType
valueDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:1970

equals_tolerance ​

â–¸ equals_tolerance(value, tolerance): boolean

Parameters ​

NameType
valueDecimalSource
tolerancenumber

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:2068

exp ​

â–¸ exp(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2325

factorial ​

â–¸ factorial(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2261

floor ​

â–¸ floor(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1668

fromComponents ​

â–¸ fromComponents(sign, layer, mag): default

Parameters ​

NameType
signnumber
layernumber
magnumber

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1188

fromComponents_noNormalize ​

â–¸ fromComponents_noNormalize(sign, layer, mag): default

Parameters ​

NameType
signnumber
layernumber
magnumber

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1197

fromDecimal ​

â–¸ fromDecimal(value): default

Parameters ​

NameType
valuedefault

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1220

fromMantissaExponent ​

â–¸ fromMantissaExponent(mantissa, exponent): default

Parameters ​

NameType
mantissanumber
exponentnumber

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1204

fromMantissaExponent_noNormalize ​

â–¸ fromMantissaExponent_noNormalize(mantissa, exponent): default

Parameters ​

NameType
mantissanumber
exponentnumber

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1214

fromNumber ​

â–¸ fromNumber(value): default

Parameters ​

NameType
valuenumber

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1227

fromString ​

â–¸ fromString(value): default

Parameters ​

NameType
valuestring

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1235

fromValue ​

â–¸ fromValue(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1484

gamma ​

â–¸ gamma(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2274

greaterThan ​

â–¸ greaterThan(other): boolean

Parameters ​

NameType
otherDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:2961

greaterThanOrEqualTo ​

â–¸ greaterThanOrEqualTo(other): boolean

Parameters ​

NameType
otherDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:2957

gt ​

â–¸ gt(value): boolean

Parameters ​

NameType
valueDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:1990

gt_tolerance ​

â–¸ gt_tolerance(value, tolerance): boolean

Parameters ​

NameType
valueDecimalSource
tolerancenumber

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:2090

gte ​

â–¸ gte(value): boolean

Parameters ​

NameType
valueDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:1994

gte_tolerance ​

â–¸ gte_tolerance(value, tolerance): boolean

Parameters ​

NameType
valueDecimalSource
tolerancenumber

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:2095

isFinite ​

â–¸ isFinite(): boolean

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:1959

isNan ​

â–¸ isNan(): boolean

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:1955

iteratedexp ​

â–¸ iteratedexp(height?, payload?): default

Parameters ​

NameTypeDefault value
heightnumber2
payloaddefaultundefined

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2489

iteratedlog ​

â–¸ iteratedlog(base?, times?): default

Parameters ​

NameTypeDefault value
baseDecimalSource10
timesnumber1

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2495

lambertw ​

â–¸ lambertw(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2775

layeradd ​

â–¸ layeradd(diff, base): default

Parameters ​

NameType
diffnumber
baseDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2758

layeradd10 ​

â–¸ layeradd10(diff): default

Parameters ​

NameType
diffDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2691

lessThan ​

â–¸ lessThan(other): boolean

Parameters ​

NameType
otherDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:2953

lessThanOrEqualTo ​

â–¸ lessThanOrEqualTo(other): boolean

Parameters ​

NameType
otherDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:2949

ln ​

â–¸ ln(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2158

lngamma ​

â–¸ lngamma(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2321

log ​

â–¸ log(base): default

Parameters ​

NameType
baseDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2127

log10 ​

â–¸ log10(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2117

log2 ​

â–¸ log2(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2144

logarithm ​

â–¸ logarithm(base): default

Parameters ​

NameType
baseDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2172

lt ​

â–¸ lt(value): boolean

Parameters ​

NameType
valueDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:1982

lt_tolerance ​

â–¸ lt_tolerance(value, tolerance): boolean

Parameters ​

NameType
valueDecimalSource
tolerancenumber

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:2080

lte ​

â–¸ lte(value): boolean

Parameters ​

NameType
valueDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:1986

lte_tolerance ​

â–¸ lte_tolerance(value, tolerance): boolean

Parameters ​

NameType
valueDecimalSource
tolerancenumber

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:2085

magnitudeWithDecimalPlaces ​

â–¸ magnitudeWithDecimalPlaces(places): number

Parameters ​

NameType
placesnumber

Returns ​

number

Defined in ​

profectus/src/lib/break_eternity.ts:1534

mantissaWithDecimalPlaces ​

â–¸ mantissaWithDecimalPlaces(places): number

Parameters ​

NameType
placesnumber

Returns ​

number

Defined in ​

profectus/src/lib/break_eternity.ts:1521

max ​

â–¸ max(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1998

maxabs ​

â–¸ maxabs(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2008

min ​

â–¸ min(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2003

minabs ​

â–¸ minabs(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2013

minus ​

â–¸ minus(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1801

mul ​

â–¸ mul(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1805

multiply ​

â–¸ multiply(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1875

neg ​

â–¸ neg(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1638

negate ​

â–¸ negate(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1642

negated ​

â–¸ negated(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1646

neq ​

â–¸ neq(value): boolean

Parameters ​

NameType
valueDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:1974

neq_tolerance ​

â–¸ neq_tolerance(value, tolerance): boolean

Parameters ​

NameType
valueDecimalSource
tolerancenumber

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:2072

normalize ​

â–¸ normalize(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1120

notEquals ​

â–¸ notEquals(value): boolean

Parameters ​

NameType
valueDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:1978

notEquals_tolerance ​

â–¸ notEquals_tolerance(value, tolerance): boolean

Parameters ​

NameType
valueDecimalSource
tolerancenumber

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:2076

pLog10 ​

â–¸ pLog10(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2100

pentate ​

â–¸ pentate(height?, payload?): default

Parameters ​

NameTypeDefault value
heightnumber2
payloadDecimalSourceundefined

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2807

plus ​

â–¸ plus(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1789

pow ​

â–¸ pow(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2176

pow10 ​

â–¸ pow10(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2212

pow_base ​

â–¸ pow_base(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2252

recip ​

â–¸ recip(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1900

reciprocal ​

â–¸ reciprocal(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1910

reciprocate ​

â–¸ reciprocate(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1914

root ​

â–¸ root(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2256

round ​

â–¸ round(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1658

sgn ​

â–¸ sgn(): number

Returns ​

number

Defined in ​

profectus/src/lib/break_eternity.ts:1654

sin ​

â–¸ sin(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2843

sinh ​

â–¸ sinh(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2903

slog ​

â–¸ slog(base?, iterations?): default

Parameters ​

NameTypeDefault value
baseDecimalSource10
iterationsnumber100

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2538

slog_internal ​

â–¸ slog_internal(base?): default

Parameters ​

NameTypeDefault value
baseDecimalSource10

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2566

sqr ​

â–¸ sqr(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2340

sqrt ​

â–¸ sqrt(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2344

ssqrt ​

â–¸ ssqrt(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2797

sub ​

â–¸ sub(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1793

subtract ​

â–¸ subtract(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1797

tan ​

â–¸ tan(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2863

tanh ​

â–¸ tanh(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2911

tetrate ​

â–¸ tetrate(height?, payload?): default

Parameters ​

NameTypeDefault value
heightnumber2
payloadDecimalSourceundefined

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:2368

times ​

â–¸ times(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1879

toExponential ​

â–¸ toExponential(places): string

Parameters ​

NameType
placesnumber

Returns ​

string

Defined in ​

profectus/src/lib/break_eternity.ts:1572

toFixed ​

â–¸ toFixed(places): string

Parameters ​

NameType
placesnumber

Returns ​

string

Defined in ​

profectus/src/lib/break_eternity.ts:1579

toJSON ​

â–¸ toJSON(): string

Returns ​

string

Defined in ​

profectus/src/lib/break_eternity.ts:1602

toNumber ​

â–¸ toNumber(): number

Returns ​

number

Defined in ​

profectus/src/lib/break_eternity.ts:1503

toPrecision ​

â–¸ toPrecision(places): string

Parameters ​

NameType
placesnumber

Returns ​

string

Defined in ​

profectus/src/lib/break_eternity.ts:1586

toString ​

â–¸ toString(): string

Returns ​

string

Defined in ​

profectus/src/lib/break_eternity.ts:1547

toStringWithDecimalPlaces ​

â–¸ toStringWithDecimalPlaces(places): string

Parameters ​

NameType
placesnumber

Returns ​

string

Defined in ​

profectus/src/lib/break_eternity.ts:1606

trunc ​

â–¸ trunc(): default

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1688

valueOf ​

â–¸ valueOf(): string

Returns ​

string

Defined in ​

profectus/src/lib/break_eternity.ts:1598

abs ​

â–¸ Static abs(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:515

absLog10 ​

â–¸ Static absLog10(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:773

acos ​

â–¸ Static acos(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:905

acosh ​

â–¸ Static acosh(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:929

add ​

â–¸ Static add(value, other): default

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:555

affordArithmeticSeries ​

â–¸ Static affordArithmeticSeries(resourcesAvailable, priceStart, priceAdd, currentOwned): default

If you're willing to spend 'resourcesAvailable' and want to buy something with additively increasing cost each purchase (start at priceStart, add by priceAdd, already own currentOwned), how much of it can you buy?

Parameters ​

NameType
resourcesAvailableDecimalSource
priceStartDecimalSource
priceAddDecimalSource
currentOwnedDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:976

affordArithmeticSeries_core ​

â–¸ Static affordArithmeticSeries_core(resourcesAvailable, priceStart, priceAdd, currentOwned): default

Parameters ​

NameType
resourcesAvailabledefault
priceStartdefault
priceAdddefault
currentOwneddefault

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1082

affordGeometricSeries ​

â–¸ Static affordGeometricSeries(resourcesAvailable, priceStart, priceRatio, currentOwned): default

If you're willing to spend 'resourcesAvailable' and want to buy something with exponentially increasing cost each purchase (start at priceStart, multiply by priceRatio, already own currentOwned), how much of it can you buy? Adapted from Trimps source code.

Parameters ​

NameType
resourcesAvailableDecimalSource
priceStartDecimalSource
priceRatioDecimalSource
currentOwnedDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:944

affordGeometricSeries_core ​

â–¸ Static affordGeometricSeries_core(resourcesAvailable, priceStart, priceRatio, currentOwned): default

Parameters ​

NameType
resourcesAvailabledefault
priceStartdefault
priceRatiodefault
currentOwnedDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1053

asin ​

â–¸ Static asin(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:901

asinh ​

â–¸ Static asinh(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:925

atan ​

â–¸ Static atan(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:909

atanh ​

â–¸ Static atanh(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:933

cbrt ​

â–¸ Static cbrt(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:841

ceil ​

â–¸ Static ceil(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:547

clamp ​

â–¸ Static clamp(value, min, max): default

Parameters ​

NameType
valueDecimalSource
minDecimalSource
maxDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:677

clampMax ​

â–¸ Static clampMax(value, max): default

Parameters ​

NameType
valueDecimalSource
maxDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:685

clampMin ​

â–¸ Static clampMin(value, min): default

Parameters ​

NameType
valueDecimalSource
minDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:681

cmp ​

â–¸ Static cmp(value, other): CompareResult

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

CompareResult

Defined in ​

profectus/src/lib/break_eternity.ts:607

cmp_tolerance ​

â–¸ Static cmp_tolerance(value, other, tolerance): CompareResult

Parameters ​

NameType
valueDecimalSource
otherDecimalSource
tolerancenumber

Returns ​

CompareResult

Defined in ​

profectus/src/lib/break_eternity.ts:689

cmpabs ​

â–¸ Static cmpabs(value, other): CompareResult

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

CompareResult

Defined in ​

profectus/src/lib/break_eternity.ts:611

compare ​

â–¸ Static compare(value, other): CompareResult

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

CompareResult

Defined in ​

profectus/src/lib/break_eternity.ts:615

compare_tolerance ​

â–¸ Static compare_tolerance(value, other, tolerance): CompareResult

Parameters ​

NameType
valueDecimalSource
otherDecimalSource
tolerancenumber

Returns ​

CompareResult

Defined in ​

profectus/src/lib/break_eternity.ts:697

cos ​

â–¸ Static cos(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:893

cosh ​

â–¸ Static cosh(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:917

critical_section ​

â–¸ Static critical_section(base, height, grid): number

Parameters ​

NameType
basenumber
heightnumber
gridnumber[][]

Returns ​

number

Defined in ​

profectus/src/lib/break_eternity.ts:2633

cube ​

â–¸ Static cube(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:837

div ​

â–¸ Static div(value, other): default

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:587

divide ​

â–¸ Static divide(value, other): default

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:591

efficiencyOfPurchase ​

â–¸ Static efficiencyOfPurchase(cost, currentRpS, deltaRpS): default

When comparing two purchases that cost (resource) and increase your resource/sec by (deltaRpS), the lowest efficiency score is the better one to purchase. From Frozen Cookies: http://cookieclicker.wikia.com/wiki/Frozen_Cookies_(JavaScript_Add-on)#Efficiency.3F_What.27s_that.3F

Parameters ​

NameType
costDecimalSource
currentRpSDecimalSource
deltaRpSDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1015

efficiencyOfPurchase_core ​

â–¸ Static efficiencyOfPurchase_core(cost, currentRpS, deltaRpS): default

Parameters ​

NameType
costdefault
currentRpSdefault
deltaRpSdefault

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1112

eq ​

â–¸ Static eq(value, other): boolean

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:629

eq_tolerance ​

â–¸ Static eq_tolerance(value, other, tolerance?): boolean

Parameters ​

NameType
valueDecimalSource
otherDecimalSource
tolerance?number

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:705

equals ​

â–¸ Static equals(value, other): boolean

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:633

equals_tolerance ​

â–¸ Static equals_tolerance(value, other, tolerance?): boolean

Parameters ​

NameType
valueDecimalSource
otherDecimalSource
tolerance?number

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:713

exp ​

â–¸ Static exp(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:825

factorial ​

â–¸ Static factorial(value, _other?): default

Parameters ​

NameType
valueDecimalSource
_other?undefined

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:813

floor ​

â–¸ Static floor(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:543

fromComponents ​

â–¸ Static fromComponents(sign, layer, mag): default

Parameters ​

NameType
signnumber
layernumber
magnumber

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:455

fromComponents_noNormalize ​

â–¸ Static fromComponents_noNormalize(sign, layer, mag): default

Parameters ​

NameType
signnumber
layernumber
magnumber

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:459

fromDecimal ​

â–¸ Static fromDecimal(value): default

Parameters ​

NameType
valuedefault

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:471

fromMantissaExponent ​

â–¸ Static fromMantissaExponent(mantissa, exponent): default

Parameters ​

NameType
mantissanumber
exponentnumber

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:463

fromMantissaExponent_noNormalize ​

â–¸ Static fromMantissaExponent_noNormalize(mantissa, exponent): default

Parameters ​

NameType
mantissanumber
exponentnumber

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:467

fromNumber ​

â–¸ Static fromNumber(value): default

Parameters ​

NameType
valuenumber

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:475

fromString ​

â–¸ Static fromString(value): default

Parameters ​

NameType
valuestring

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:479

fromValue ​

â–¸ Static fromValue(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:483

fromValue_noAlloc ​

â–¸ Static fromValue_noAlloc(value): Readonly<default>

Converts a DecimalSource to a Decimal, without constructing a new Decimal if the provided value is already a Decimal.

As the return value could be the provided value itself, this function returns a read-only Decimal to prevent accidental mutations of the value. Use new Decimal(value) to explicitly create a writeable copy if mutation is required.

Parameters ​

NameType
valueDecimalSource

Returns ​

Readonly<default>

Defined in ​

profectus/src/lib/break_eternity.ts:496

gamma ​

â–¸ Static gamma(value, _other?): default

Parameters ​

NameType
valueDecimalSource
_other?undefined

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:817

gt ​

â–¸ Static gt(value, other): boolean

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:653

gt_tolerance ​

â–¸ Static gt_tolerance(value, other, tolerance): boolean

Parameters ​

NameType
valueDecimalSource
otherDecimalSource
tolerancenumber

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:753

gte ​

â–¸ Static gte(value, other): boolean

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:657

gte_tolerance ​

â–¸ Static gte_tolerance(value, other, tolerance): boolean

Parameters ​

NameType
valueDecimalSource
otherDecimalSource
tolerancenumber

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:761

isFinite ​

â–¸ Static isFinite(value): boolean

Parameters ​

NameType
valueDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:624

isNaN ​

â–¸ Static isNaN(value): boolean

Parameters ​

NameType
valueDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:619

iteratedexp ​

â–¸ Static iteratedexp(value, height?, payload?): default

Parameters ​

NameTypeDefault value
valueDecimalSourceundefined
heightnumber2
payloaddefaultundefined

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:853

iteratedlog ​

â–¸ Static iteratedlog(value, base?, times?): default

Parameters ​

NameTypeDefault value
valueDecimalSourceundefined
baseDecimalSource10
timesnumber1

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:857

lambertw ​

â–¸ Static lambertw(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:873

layeradd ​

â–¸ Static layeradd(value, diff, base?): default

Parameters ​

NameTypeDefault value
valueDecimalSourceundefined
diffnumberundefined
baseDecimalSource10

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:865

layeradd10 ​

â–¸ Static layeradd10(value, diff): default

Parameters ​

NameType
valueDecimalSource
diffDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:861

ln ​

â–¸ Static ln(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:789

lngamma ​

â–¸ Static lngamma(value, _other?): default

Parameters ​

NameType
valueDecimalSource
_other?undefined

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:821

log ​

â–¸ Static log(value, base): default

Parameters ​

NameType
valueDecimalSource
baseDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:781

log10 ​

â–¸ Static log10(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:777

log2 ​

â–¸ Static log2(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:785

logarithm ​

â–¸ Static logarithm(value, base): default

Parameters ​

NameType
valueDecimalSource
baseDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:793

lt ​

â–¸ Static lt(value, other): boolean

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:645

lt_tolerance ​

â–¸ Static lt_tolerance(value, other, tolerance): boolean

Parameters ​

NameType
valueDecimalSource
otherDecimalSource
tolerancenumber

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:737

lte ​

â–¸ Static lte(value, other): boolean

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:649

lte_tolerance ​

â–¸ Static lte_tolerance(value, other, tolerance): boolean

Parameters ​

NameType
valueDecimalSource
otherDecimalSource
tolerancenumber

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:745

max ​

â–¸ Static max(value, other): default

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:661

maxabs ​

â–¸ Static maxabs(value, other): default

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:673

min ​

â–¸ Static min(value, other): default

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:665

minabs ​

â–¸ Static minabs(value, other): default

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:669

minus ​

â–¸ Static minus(value, other): default

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:571

mul ​

â–¸ Static mul(value, other): default

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:575

multiply ​

â–¸ Static multiply(value, other): default

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:579

neg ​

â–¸ Static neg(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:519

negate ​

â–¸ Static negate(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:523

negated ​

â–¸ Static negated(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:527

neq ​

â–¸ Static neq(value, other): boolean

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:637

neq_tolerance ​

â–¸ Static neq_tolerance(value, other, tolerance): boolean

Parameters ​

NameType
valueDecimalSource
otherDecimalSource
tolerancenumber

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:721

notEquals ​

â–¸ Static notEquals(value, other): boolean

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:641

notEquals_tolerance ​

â–¸ Static notEquals_tolerance(value, other, tolerance): boolean

Parameters ​

NameType
valueDecimalSource
otherDecimalSource
tolerancenumber

Returns ​

boolean

Defined in ​

profectus/src/lib/break_eternity.ts:729

pLog10 ​

â–¸ Static pLog10(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:769

pentate ​

â–¸ Static pentate(value, height?, payload?): default

Parameters ​

NameTypeDefault value
valueDecimalSourceundefined
heightnumber2
payloadDecimalSourceundefined

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:881

plus ​

â–¸ Static plus(value, other): default

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:559

pow ​

â–¸ Static pow(value, other): default

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:797

pow10 ​

â–¸ Static pow10(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:801

pow_base ​

â–¸ Static pow_base(value, other): default

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:805

randomDecimalForTesting ​

â–¸ Static randomDecimalForTesting(maxLayers): default

Parameters ​

NameType
maxLayersnumber

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1023

recip ​

â–¸ Static recip(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:595

reciprocal ​

â–¸ Static reciprocal(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:599

reciprocate ​

â–¸ Static reciprocate(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:603

root ​

â–¸ Static root(value, other): default

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:809

round ​

â–¸ Static round(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:539

sgn ​

â–¸ Static sgn(value): number

Parameters ​

NameType
valueDecimalSource

Returns ​

number

Defined in ​

profectus/src/lib/break_eternity.ts:535

sign ​

â–¸ Static sign(value): number

Parameters ​

NameType
valueDecimalSource

Returns ​

number

Defined in ​

profectus/src/lib/break_eternity.ts:531

sin ​

â–¸ Static sin(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:889

sinh ​

â–¸ Static sinh(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:913

slog ​

â–¸ Static slog(value, base?): default

Parameters ​

NameTypeDefault value
valueDecimalSourceundefined
basenumber10

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:869

slog_critical ​

â–¸ Static slog_critical(base, height): number

Parameters ​

NameType
basenumber
heightnumber

Returns ​

number

Defined in ​

profectus/src/lib/break_eternity.ts:2621

sqr ​

â–¸ Static sqr(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:829

sqrt ​

â–¸ Static sqrt(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:833

ssqrt ​

â–¸ Static ssqrt(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:877

sub ​

â–¸ Static sub(value, other): default

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:563

subtract ​

â–¸ Static subtract(value, other): default

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:567

sumArithmeticSeries ​

â–¸ Static sumArithmeticSeries(numItems, priceStart, priceAdd, currentOwned): default

How much resource would it cost to buy (numItems) items if you already have currentOwned, the initial price is priceStart and it adds priceAdd each purchase? Adapted from http://www.mathwords.com/a/arithmetic_series.htm

Parameters ​

NameType
numItemsDecimalSource
priceStartDecimalSource
priceAddDecimalSource
currentOwnedDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:995

sumArithmeticSeries_core ​

â–¸ Static sumArithmeticSeries_core(numItems, priceStart, priceAdd, currentOwned): default

Parameters ​

NameType
numItemsdefault
priceStartdefault
priceAdddefault
currentOwneddefault

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1101

sumGeometricSeries ​

â–¸ Static sumGeometricSeries(numItems, priceStart, priceRatio, currentOwned): default

How much resource would it cost to buy (numItems) items if you already have currentOwned, the initial price is priceStart and it multiplies by priceRatio each purchase?

Parameters ​

NameType
numItemsDecimalSource
priceStartDecimalSource
priceRatioDecimalSource
currentOwnedDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:962

sumGeometricSeries_core ​

â–¸ Static sumGeometricSeries_core(numItems, priceStart, priceRatio, currentOwned): default

Parameters ​

NameType
numItemsDecimalSource
priceStartdefault
priceRatiodefault
currentOwnedDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:1070

tan ​

â–¸ Static tan(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:897

tanh ​

â–¸ Static tanh(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:921

tetrate ​

â–¸ Static tetrate(value, height?, payload?): default

Parameters ​

NameTypeDefault value
valueDecimalSourceundefined
heightnumber2
payloadDecimalSourceundefined

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:845

tetrate_critical ​

â–¸ Static tetrate_critical(base, height): number

Parameters ​

NameType
basenumber
heightnumber

Returns ​

number

Defined in ​

profectus/src/lib/break_eternity.ts:2629

times ​

â–¸ Static times(value, other): default

Parameters ​

NameType
valueDecimalSource
otherDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:583

trunc ​

â–¸ Static trunc(value): default

Parameters ​

NameType
valueDecimalSource

Returns ​

default

Defined in ​

profectus/src/lib/break_eternity.ts:551

- diff --git a/api/classes/lib/lru-cache.LRUCache.html b/api/classes/lib/lru-cache.LRUCache.html index c62ffda6..7cab60e3 100644 --- a/api/classes/lib/lru-cache.LRUCache.html +++ b/api/classes/lib/lru-cache.LRUCache.html @@ -22,7 +22,7 @@
Profectus
On this page

Class: LRUCache<K, V> ​

lib/lru-cache.LRUCache

A LRU cache intended for caching pure functions.

Type parameters ​

Name
K
V

Constructors ​

constructor ​

• new LRUCache<K, V>(maxSize)

Type parameters ​

Name
K
V

Parameters ​

NameTypeDescription
maxSizenumberThe maximum size for this cache. We recommend setting this to be one less than a power of 2, as most hashtables - including V8's Object hashtable (https://crsrc.org/c/v8/src/objects/ordered-hash-table.cc) - uses powers of two for hashtable sizes. It can't exactly be a power of two, as a .set() call could temporarily set the size of the map to be maxSize + 1.

Defined in ​

profectus/src/lib/lru-cache.ts:23

Properties ​

first ​

• Private first: undefined | ListNode<K, V> = undefined

Defined in ​

profectus/src/lib/lru-cache.ts:11

last ​

• Private last: undefined | ListNode<K, V> = undefined

Defined in ​

profectus/src/lib/lru-cache.ts:12

map ​

• Private map: Map<K, ListNode<K, V>>

Defined in ​

profectus/src/lib/lru-cache.ts:5

maxSize ​

• maxSize: number

Defined in ​

profectus/src/lib/lru-cache.ts:13

Accessors ​

size ​

• get size(): number

Returns ​

number

Defined in ​

profectus/src/lib/lru-cache.ts:27

Methods ​

get ​

â–¸ get(key): undefined | V

Gets the specified key from the cache, or undefined if it is not in the cache.

Parameters ​

NameTypeDescription
keyKThe key to get.

Returns ​

undefined | V

The cached value, or undefined if key is not in the cache.

Defined in ​

profectus/src/lib/lru-cache.ts:37

set ​

â–¸ set(key, value): void

Sets an entry in the cache.

Throws

Error, if the map already contains the key.

Parameters ​

NameTypeDescription
keyKThe key of the entry.
valueVThe value of the entry.

Returns ​

void

Defined in ​

profectus/src/lib/lru-cache.ts:88

- diff --git a/api/components/ContextComponent.html b/api/components/ContextComponent.html index 9926cb49..edbf535c 100644 --- a/api/components/ContextComponent.html +++ b/api/components/ContextComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Context ​

Events ​

Name
updateNodes

Slots ​

Name
default
- diff --git a/api/components/HotkeyComponent.html b/api/components/HotkeyComponent.html index 28c49d17..0b6d1035 100644 --- a/api/components/HotkeyComponent.html +++ b/api/components/HotkeyComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Hotkey ​

Props ​

NameTypes
hotkey
*
GenericHotkey
- diff --git a/api/components/InfoComponent.html b/api/components/InfoComponent.html index dbbce8d1..b7245b3d 100644 --- a/api/components/InfoComponent.html +++ b/api/components/InfoComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Info ​

Props ​

NameTypes
changelog
*
TSTypeQuery | null
- diff --git a/api/components/LayerComponent.html b/api/components/LayerComponent.html index 7f9fc623..a27ba47f 100644 --- a/api/components/LayerComponent.html +++ b/api/components/LayerComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Layer ​

Props ​

NameTypes
index
*
number
display
*
processedPropType<CoercableComponent>(Object, String, Function)
minimizedDisplay
processedPropType<CoercableComponent>(Object, String, Function)
minimized
*
Ref<boolean>
name
*
processedPropType<string>(String)
color
processedPropType<string>(String)
minimizable
processedPropType<boolean>(Boolean)
nodes
*
Ref<Record<string, FeatureNode | undefined>>

Events ​

Name
setMinimized
- diff --git a/api/components/MarkNodeComponent.html b/api/components/MarkNodeComponent.html index 524f648f..195ebf67 100644 --- a/api/components/MarkNodeComponent.html +++ b/api/components/MarkNodeComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: MarkNode ​

Props ​

NameTypes
mark
boolean | string
- diff --git a/api/components/ModalComponent.html b/api/components/ModalComponent.html index a721f7f1..d4b498f2 100644 --- a/api/components/ModalComponent.html +++ b/api/components/ModalComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Modal ​

Props ​

NameTypes
modelValue
*
boolean

Events ​

Name
update:modelValue

Slots ​

NameBindings
header
body
footer
- diff --git a/api/components/NodeComponent.html b/api/components/NodeComponent.html index f80597ca..23605fe8 100644 --- a/api/components/NodeComponent.html +++ b/api/components/NodeComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Node ​

Props ​

NameTypes
id
*
string
- diff --git a/api/components/SaveComponent.html b/api/components/SaveComponent.html index 1a047c1f..b24201b0 100644 --- a/api/components/SaveComponent.html +++ b/api/components/SaveComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Save ​

Props ​

NameTypes
save
*
LoadablePlayerData

Events ​

Name
export
open
duplicate
delete
editName
- diff --git a/api/components/fields/DangerButtonComponent.html b/api/components/fields/DangerButtonComponent.html index 3faac145..c20bab43 100644 --- a/api/components/fields/DangerButtonComponent.html +++ b/api/components/fields/DangerButtonComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: DangerButton ​

Props ​

NameTypes
disabled
boolean
skipConfirm
boolean

Events ​

Name
click
confirmingChanged

Slots ​

Name
default
- diff --git a/api/components/fields/FeedbackButtonComponent.html b/api/components/fields/FeedbackButtonComponent.html index 88c50bbe..f62de5a9 100644 --- a/api/components/fields/FeedbackButtonComponent.html +++ b/api/components/fields/FeedbackButtonComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: FeedbackButton ​

Props ​

NameTypes
left
boolean

Events ​

Name
click

Slots ​

Name
default
- diff --git a/api/components/fields/SelectComponent.html b/api/components/fields/SelectComponent.html index 9846bf77..c84fea09 100644 --- a/api/components/fields/SelectComponent.html +++ b/api/components/fields/SelectComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Select ​

Props ​

NameTypes
title
CoercableComponent
modelValue
unknown
options
*
SelectOption[]
placeholder
string
closeOnSelect
boolean

Events ​

Name
update:modelValue
- diff --git a/api/components/fields/SliderComponent.html b/api/components/fields/SliderComponent.html index 50b40152..26475726 100644 --- a/api/components/fields/SliderComponent.html +++ b/api/components/fields/SliderComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Slider ​

Props ​

NameTypes
title
string
modelValue
number
min
number
max
number

Events ​

Name
update:modelValue
- diff --git a/api/components/fields/TextComponent.html b/api/components/fields/TextComponent.html index a2c1da4c..101b1974 100644 --- a/api/components/fields/TextComponent.html +++ b/api/components/fields/TextComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Text ​

Props ​

NameTypes
title
CoercableComponent
modelValue
string
textArea
boolean
placeholder
string
maxHeight
number
submitOnBlur
boolean

Events ​

Name
update:modelValue
submit
cancel
- diff --git a/api/components/fields/ToggleComponent.html b/api/components/fields/ToggleComponent.html index a22c622f..2a3a7062 100644 --- a/api/components/fields/ToggleComponent.html +++ b/api/components/fields/ToggleComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Toggle ​

Props ​

NameTypes
title
CoercableComponent
modelValue
boolean

Events ​

Name
update:modelValue
- diff --git a/api/components/layout/CollapsibleComponent.html b/api/components/layout/CollapsibleComponent.html index a12845b7..a0de056f 100644 --- a/api/components/layout/CollapsibleComponent.html +++ b/api/components/layout/CollapsibleComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Collapsible ​

Props ​

NameTypes
collapsed
*
Ref
display
*
CoercableComponent
content
*
CoercableComponent
- diff --git a/api/components/layout/ColumnComponent.html b/api/components/layout/ColumnComponent.html index 4b633135..2ad6d055 100644 --- a/api/components/layout/ColumnComponent.html +++ b/api/components/layout/ColumnComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Column ​

Slots ​

Name
default
- diff --git a/api/components/layout/RowComponent.html b/api/components/layout/RowComponent.html index 3ae7b120..999875a8 100644 --- a/api/components/layout/RowComponent.html +++ b/api/components/layout/RowComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Row ​

Slots ​

Name
default
- diff --git a/api/components/layout/SpacerComponent.html b/api/components/layout/SpacerComponent.html index 919ce01d..827c08f3 100644 --- a/api/components/layout/SpacerComponent.html +++ b/api/components/layout/SpacerComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Spacer ​

Props ​

NameTypesDefault
width
string
"8px"
height
string
"17px"
- diff --git a/api/components/layout/StickyComponent.html b/api/components/layout/StickyComponent.html index fbd2d671..0b593556 100644 --- a/api/components/layout/StickyComponent.html +++ b/api/components/layout/StickyComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Sticky ​

Slots ​

Name
default
- diff --git a/api/components/layout/VerticalRuleComponent.html b/api/components/layout/VerticalRuleComponent.html index b3436bbd..25008522 100644 --- a/api/components/layout/VerticalRuleComponent.html +++ b/api/components/layout/VerticalRuleComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: VerticalRule ​

Props ​

NameTypes
height
string
- diff --git a/api/components/math/FloorComponent.html b/api/components/math/FloorComponent.html index 61d8d5d5..979872fe 100644 --- a/api/components/math/FloorComponent.html +++ b/api/components/math/FloorComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Floor ​

Slots ​

Name
default
- diff --git a/api/components/math/SqrtComponent.html b/api/components/math/SqrtComponent.html index bff7ee8f..17bfa019 100644 --- a/api/components/math/SqrtComponent.html +++ b/api/components/math/SqrtComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Sqrt ​

Slots ​

Name
default
- diff --git a/api/enums/data/themes.Themes.html b/api/enums/data/themes.Themes.html index 64e3741d..a5498561 100644 --- a/api/enums/data/themes.Themes.html +++ b/api/enums/data/themes.Themes.html @@ -22,7 +22,7 @@
Profectus
On this page

Enumeration: Themes ​

data/themes.Themes

An enum of all available themes and their internal IDs. The keys are their display names.

Enumeration Members ​

Aqua ​

• Aqua = "aqua"

Defined in ​

profectus/src/data/themes.ts:77

Classic ​

• Classic = "classic"

Defined in ​

profectus/src/data/themes.ts:74

Nordic ​

• Nordic = "nordic"

Defined in ​

profectus/src/data/themes.ts:76

Paper ​

• Paper = "paper"

Defined in ​

profectus/src/data/themes.ts:75

- diff --git a/api/enums/features/achievements/achievement.AchievementDisplay.html b/api/enums/features/achievements/achievement.AchievementDisplay.html index b7d69c5a..151a33a8 100644 --- a/api/enums/features/achievements/achievement.AchievementDisplay.html +++ b/api/enums/features/achievements/achievement.AchievementDisplay.html @@ -22,7 +22,7 @@
Profectus
On this page

Enumeration: AchievementDisplay ​

features/achievements/achievement.AchievementDisplay

Modes for only displaying some achievements.

Enumeration Members ​

All ​

• All = "all"

Defined in ​

profectus/src/features/achievements/achievement.tsx:51

Configurable ​

• Configurable = "configurable"

Defined in ​

profectus/src/features/achievements/achievement.tsx:53

Incomplete ​

• Incomplete = "incomplete"

Defined in ​

profectus/src/features/achievements/achievement.tsx:54

None ​

• None = "none"

Defined in ​

profectus/src/features/achievements/achievement.tsx:55

- diff --git a/api/enums/features/boards/board.ProgressDisplay.html b/api/enums/features/boards/board.ProgressDisplay.html index 5437f539..0f0a495d 100644 --- a/api/enums/features/boards/board.ProgressDisplay.html +++ b/api/enums/features/boards/board.ProgressDisplay.html @@ -22,7 +22,7 @@
Profectus
On this page

Enumeration: ProgressDisplay ​

features/boards/board.ProgressDisplay

Ways to display progress of an action with a duration.

Enumeration Members ​

Fill ​

• Fill = "Fill"

Defined in ​

profectus/src/features/boards/board.ts:41

Outline ​

• Outline = "Outline"

Defined in ​

profectus/src/features/boards/board.ts:40

- diff --git a/api/enums/features/boards/board.Shape.html b/api/enums/features/boards/board.Shape.html index 21568af0..2dda1559 100644 --- a/api/enums/features/boards/board.Shape.html +++ b/api/enums/features/boards/board.Shape.html @@ -22,7 +22,7 @@
Profectus
On this page

Enumeration: Shape ​

features/boards/board.Shape

Node shapes.

Enumeration Members ​

Circle ​

• Circle = "Circle"

Defined in ​

profectus/src/features/boards/board.ts:46

Diamond ​

• Diamond = "Triangle"

Defined in ​

profectus/src/features/boards/board.ts:47

- diff --git a/api/enums/features/feature.Visibility.html b/api/enums/features/feature.Visibility.html index 0aaa4488..8510f13a 100644 --- a/api/enums/features/feature.Visibility.html +++ b/api/enums/features/feature.Visibility.html @@ -22,7 +22,7 @@
Profectus
On this page

Enumeration: Visibility ​

features/feature.Visibility

Enum for what the visibility of a feature or component should be

Enumeration Members ​

Hidden ​

• Hidden = 1

The feature or component should not appear but still take up space

Defined in ​

profectus/src/features/feature.ts:65

None ​

• None = 2

The feature or component should not appear not take up space

Defined in ​

profectus/src/features/feature.ts:67

Visible ​

• Visible = 0

The feature or component should be visible

Defined in ​

profectus/src/features/feature.ts:63

- diff --git a/api/enums/util/common.Direction.html b/api/enums/util/common.Direction.html index b0e100c1..e68aa4ac 100644 --- a/api/enums/util/common.Direction.html +++ b/api/enums/util/common.Direction.html @@ -22,7 +22,7 @@
Profectus
On this page

Enumeration: Direction ​

util/common.Direction

Enumeration Members ​

Default ​

• Default = "Up"

Defined in ​

profectus/src/util/common.ts:26

Down ​

• Down = "Down"

Defined in ​

profectus/src/util/common.ts:23

Left ​

• Left = "Left"

Defined in ​

profectus/src/util/common.ts:24

• Right = "Right"

Defined in ​

profectus/src/util/common.ts:25

Up ​

• Up = "Up"

Defined in ​

profectus/src/util/common.ts:22

- diff --git a/api/interfaces/data/common.LayerTreeNodeOptions.html b/api/interfaces/data/common.LayerTreeNodeOptions.html index 42e5f738..b8fc9d5f 100644 --- a/api/interfaces/data/common.LayerTreeNodeOptions.html +++ b/api/interfaces/data/common.LayerTreeNodeOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: LayerTreeNodeOptions ​

data/common.LayerTreeNodeOptions

An object that configures a LayerTreeNode

Hierarchy ​

Properties ​

append ​

• Optional append: Computable<boolean>

Whether or not to append the layer to the tabs list. If set to false, then the tree node will instead always remove all tabs to its right and then add the layer tab. Defaults to true.

Defined in ​

profectus/src/data/common.tsx:190

canClick ​

• Optional canClick: Computable<boolean>

Whether or not this tree node can be clicked.

Inherited from ​

TreeNodeOptions.canClick

Defined in ​

profectus/src/features/trees/tree.ts:40

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Inherited from ​

TreeNodeOptions.classes

Defined in ​

profectus/src/features/trees/tree.ts:48

color ​

• color: Computable<string>

The color to display this tree node as

Overrides ​

TreeNodeOptions.color

Defined in ​

profectus/src/data/common.tsx:180

display ​

• Optional display: Computable<CoercableComponent>

The content to display in the tree node. Defaults to the layer's ID

Overrides ​

TreeNodeOptions.display

Defined in ​

profectus/src/data/common.tsx:185

glowColor ​

• Optional glowColor: Computable<string>

The color of the glow effect shown to notify the user there's something to do with this node.

Inherited from ​

TreeNodeOptions.glowColor

Defined in ​

profectus/src/features/trees/tree.ts:46

layerID ​

• layerID: string

The ID of the layer this tree node is associated with

Defined in ​

profectus/src/data/common.tsx:178

mark ​

• Optional mark: Computable<string | boolean>

Shows a marker on the corner of the feature.

Inherited from ​

TreeNodeOptions.mark

Defined in ​

profectus/src/features/trees/tree.ts:52

onClick ​

• Optional onClick: (e?: MouseEvent | TouchEvent) => void

Type declaration ​

â–¸ (e?): void

A function that is called when the tree node is clicked.

Parameters ​
NameType
e?MouseEvent | TouchEvent
Returns ​

void

Inherited from ​

TreeNodeOptions.onClick

Defined in ​

profectus/src/features/trees/tree.ts:56

onHold ​

• Optional onHold: VoidFunction

A function that is called when the tree node is held down.

Inherited from ​

TreeNodeOptions.onHold

Defined in ​

profectus/src/features/trees/tree.ts:58

reset ​

• Optional reset: GenericReset

A reset object attached to this node, used for propagating resets through the tree.

Inherited from ​

TreeNodeOptions.reset

Defined in ​

profectus/src/features/trees/tree.ts:54

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Inherited from ​

TreeNodeOptions.style

Defined in ​

profectus/src/features/trees/tree.ts:50

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this tree node should be visible.

Inherited from ​

TreeNodeOptions.visibility

Defined in ​

profectus/src/features/trees/tree.ts:38

- diff --git a/api/interfaces/data/common.ResetButtonOptions.html b/api/interfaces/data/common.ResetButtonOptions.html index b3f02a1e..076fdcc9 100644 --- a/api/interfaces/data/common.ResetButtonOptions.html +++ b/api/interfaces/data/common.ResetButtonOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: ResetButtonOptions ​

data/common.ResetButtonOptions

An object that configures a ResetButton

Hierarchy ​

Properties ​

canClick ​

• Optional canClick: Computable<boolean>

Whether or not this button can currently be clicked. Defaults to checking the current gain amount is greater than minimumGain

Overrides ​

ClickableOptions.canClick

Defined in ​

profectus/src/data/common.tsx:57

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Inherited from ​

ClickableOptions.classes

Defined in ​

profectus/src/features/clickables/clickable.ts:34

conversion ​

• conversion: GenericConversion

The conversion the button uses to calculate how much resources will be gained on click

Defined in ​

profectus/src/data/common.tsx:36

display ​

• Optional display: Computable<CoercableComponent>

The content to display on the button. By default, this includes the reset description, and amount of currency to be gained.

Overrides ​

ClickableOptions.display

Defined in ​

profectus/src/data/common.tsx:52

mark ​

• Optional mark: Computable<string | boolean>

Shows a marker on the corner of the feature.

Inherited from ​

ClickableOptions.mark

Defined in ​

profectus/src/features/clickables/clickable.ts:38

minimumGain ​

• Optional minimumGain: Computable<DecimalSource>

When canClick is left to its default, minimumGain is used to only enable the reset button when a sufficient amount of currency to gain is available.

Defined in ​

profectus/src/data/common.tsx:61

onClick ​

• Optional onClick: (e?: MouseEvent | TouchEvent) => void

Type declaration ​

â–¸ (e?): void

A function that is called when the clickable is clicked.

Parameters ​
NameType
e?MouseEvent | TouchEvent
Returns ​

void

Inherited from ​

ClickableOptions.onClick

Defined in ​

profectus/src/features/clickables/clickable.ts:52

onHold ​

• Optional onHold: VoidFunction

A function that is called when the clickable is held down.

Inherited from ​

ClickableOptions.onHold

Defined in ​

profectus/src/features/clickables/clickable.ts:54

resetDescription ​

• Optional resetDescription: Computable<string>

Text to display on low conversion amounts, describing what "resetting" is in this context. Defaults to "Reset for ".

Defined in ​

profectus/src/data/common.tsx:45

resetTime ​

• Optional resetTime: Persistent<DecimalSource>

A persistent ref to track how much time has passed since the last time this tree node was reset.

Defined in ​

profectus/src/data/common.tsx:63

showNextAt ​

• Optional showNextAt: Computable<boolean>

Whether or not to show how much currency would be required to make the gain amount increase.

Defined in ​

profectus/src/data/common.tsx:47

small ​

• Optional small: boolean

Toggles a smaller design for the feature.

Inherited from ​

ClickableOptions.small

Defined in ​

profectus/src/features/clickables/clickable.ts:50

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Inherited from ​

ClickableOptions.style

Defined in ​

profectus/src/features/clickables/clickable.ts:36

tree ​

• tree: GenericTree

The tree this reset button is apart of

Defined in ​

profectus/src/data/common.tsx:38

treeNode ​

• treeNode: GenericTreeNode

The specific tree node associated with this reset button

Defined in ​

profectus/src/data/common.tsx:40

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this clickable should be visible.

Inherited from ​

ClickableOptions.visibility

Defined in ​

profectus/src/features/clickables/clickable.ts:30

- diff --git a/api/interfaces/data/common.Section.html b/api/interfaces/data/common.Section.html index d3f38572..ef68b3ed 100644 --- a/api/interfaces/data/common.Section.html +++ b/api/interfaces/data/common.Section.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: Section ​

data/common.Section

An option object for a modifier display as a single section. *

Properties ​

base ​

• Optional base: Computable<DecimalSource>

The base value being modified. *

Defined in ​

profectus/src/data/common.tsx:249

baseText ​

• Optional baseText: Computable<CoercableComponent>

The label to call the base amount. Defaults to "Base". *

Defined in ​

profectus/src/data/common.tsx:253

modifier ​

• modifier: WithRequired<Modifier, "description">

The modifier to be displaying in this section. *

Defined in ​

profectus/src/data/common.tsx:247

subtitle ​

• Optional subtitle: Computable<string>

A subtitle for this modifier, e.g. to explain the context for the modifier. *

Defined in ​

profectus/src/data/common.tsx:245

title ​

• title: Computable<string>

The header for this modifier. *

Defined in ​

profectus/src/data/common.tsx:243

unit ​

• Optional unit: string

The unit of measurement for the base. *

Defined in ​

profectus/src/data/common.tsx:251

visible ​

• Optional visible: Computable<boolean>

Whether or not this section should be currently visible to the player. *

Defined in ​

profectus/src/data/common.tsx:255

- diff --git a/api/interfaces/data/themes.Theme.html b/api/interfaces/data/themes.Theme.html index 6e0c7255..8a132c8a 100644 --- a/api/interfaces/data/themes.Theme.html +++ b/api/interfaces/data/themes.Theme.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: Theme ​

data/themes.Theme

An object representing a theme the player can use to change the look of the game.

Properties ​

floatingTabs ​

• floatingTabs: boolean

Whether or not tabs should "float" in the center of their container.

Defined in ​

profectus/src/data/themes.ts:28

mergeAdjacent ​

• mergeAdjacent: boolean

Whether or not adjacent features should merge together - removing the margin between them, and only applying the border radius to the first and last elements in the row or column.

Defined in ​

profectus/src/data/themes.ts:30

showPin ​

• showPin: boolean

Whether or not to show a pin icon on pinned tooltips.

Defined in ​

profectus/src/data/themes.ts:32

variables ​

• variables: ThemeVars

The values of the theme's CSS variables.

Defined in ​

profectus/src/data/themes.ts:26

- diff --git a/api/interfaces/data/themes.ThemeVars.html b/api/interfaces/data/themes.ThemeVars.html index ca3dd511..32e2fea5 100644 --- a/api/interfaces/data/themes.ThemeVars.html +++ b/api/interfaces/data/themes.ThemeVars.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: ThemeVars ​

data/themes.ThemeVars

A object of all CSS variables determined by the current theme.

Properties ​

--accent1 ​

• --accent1: string

Defined in ​

profectus/src/data/themes.ts:15

--accent2 ​

• --accent2: string

Defined in ​

profectus/src/data/themes.ts:16

--accent3 ​

• --accent3: string

Defined in ​

profectus/src/data/themes.ts:17

--background ​

• --background: string

Defined in ​

profectus/src/data/themes.ts:4

--border-radius ​

• --border-radius: string

Defined in ​

profectus/src/data/themes.ts:18

--bought ​

• --bought: string

Defined in ​

profectus/src/data/themes.ts:11

--danger ​

• --danger: string

Defined in ​

profectus/src/data/themes.ts:12

--feature-foreground ​

• --feature-foreground: string

Defined in ​

profectus/src/data/themes.ts:5

--feature-margin ​

• --feature-margin: string

Defined in ​

profectus/src/data/themes.ts:20

--foreground ​

• --foreground: string

Defined in ​

profectus/src/data/themes.ts:3

--highlighted ​

• --highlighted: string

Defined in ​

profectus/src/data/themes.ts:10

• --link: string

Defined in ​

profectus/src/data/themes.ts:13

--locked ​

• --locked: string

Defined in ​

profectus/src/data/themes.ts:9

• --modal-border: string

Defined in ​

profectus/src/data/themes.ts:19

--outline ​

• --outline: string

Defined in ​

profectus/src/data/themes.ts:14

--points ​

• --points: string

Defined in ​

profectus/src/data/themes.ts:8

--raised-background ​

• --raised-background: string

Defined in ​

profectus/src/data/themes.ts:7

--tooltip-background ​

• --tooltip-background: string

Defined in ​

profectus/src/data/themes.ts:6

- diff --git a/api/interfaces/features/achievements/achievement.AchievementOptions.html b/api/interfaces/features/achievements/achievement.AchievementOptions.html index 4f648832..95534f0f 100644 --- a/api/interfaces/features/achievements/achievement.AchievementOptions.html +++ b/api/interfaces/features/achievements/achievement.AchievementOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: AchievementOptions ​

features/achievements/achievement.AchievementOptions

An object that configures an Achievement.

Properties ​

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Defined in ​

profectus/src/features/achievements/achievement.tsx:87

display ​

• Optional display: Computable<CoercableComponent | { effectDisplay?: CoercableComponent ; optionsDisplay?: CoercableComponent ; requirement?: CoercableComponent }>

The display to use for this achievement.

Defined in ​

profectus/src/features/achievements/achievement.tsx:67

image ​

• Optional image: Computable<string>

An image to display as the background for this achievement.

Defined in ​

profectus/src/features/achievements/achievement.tsx:83

mark ​

• Optional mark: Computable<string | boolean>

Shows a marker on the corner of the feature.

Defined in ​

profectus/src/features/achievements/achievement.tsx:79

onComplete ​

• Optional onComplete: VoidFunction

A function that is called when the achievement is completed.

Defined in ​

profectus/src/features/achievements/achievement.tsx:91

requirements ​

• Optional requirements: Requirements

The requirement(s) to earn this achievement. Can be left null if using complete.

Defined in ​

profectus/src/features/achievements/achievement.tsx:65

showPopups ​

• Optional showPopups: Computable<boolean>

Whether or not to display a notification popup when this achievement is earned.

Defined in ​

profectus/src/features/achievements/achievement.tsx:89

small ​

• Optional small: Computable<boolean>

Toggles a smaller design for the feature.

Defined in ​

profectus/src/features/achievements/achievement.tsx:81

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Defined in ​

profectus/src/features/achievements/achievement.tsx:85

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this achievement should be visible.

Defined in ​

profectus/src/features/achievements/achievement.tsx:63

- diff --git a/api/interfaces/features/achievements/achievement.BaseAchievement.html b/api/interfaces/features/achievements/achievement.BaseAchievement.html index 1f223775..e8afc4a2 100644 --- a/api/interfaces/features/achievements/achievement.BaseAchievement.html +++ b/api/interfaces/features/achievements/achievement.BaseAchievement.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseAchievement ​

features/achievements/achievement.BaseAchievement

The properties that are added onto a processed AchievementOptions to create an Achievement.

Properties ​

[Component] ​

• [Component]: GenericComponent

The Vue component used to render this feature.

Defined in ​

profectus/src/features/achievements/achievement.tsx:107

[GatherProps] ​

• [GatherProps]: () => Record<string, unknown>

Type declaration ​

â–¸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns ​

Record<string, unknown>

Defined in ​

profectus/src/features/achievements/achievement.tsx:109

complete ​

• complete: VoidFunction

A function to complete this achievement.

Defined in ​

profectus/src/features/achievements/achievement.tsx:103

earned ​

• earned: Persistent<boolean>

Whether or not this achievement has been earned.

Defined in ​

profectus/src/features/achievements/achievement.tsx:101

id ​

• id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Defined in ​

profectus/src/features/achievements/achievement.tsx:99

type ​

• type: typeof AchievementType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/achievements/achievement.tsx:105

- diff --git a/api/interfaces/features/action.ActionOptions.html b/api/interfaces/features/action.ActionOptions.html index edbb8190..74fe2594 100644 --- a/api/interfaces/features/action.ActionOptions.html +++ b/api/interfaces/features/action.ActionOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: ActionOptions ​

features/action.ActionOptions

An object that configures a Action.

Hierarchy ​

Properties ​

autoStart ​

• Optional autoStart: Computable<boolean>

Whether or not the action should perform automatically when the cooldown is finished.

Defined in ​

profectus/src/features/action.tsx:45

barOptions ​

• Optional barOptions: Partial<BarOptions>

A pass-through to the Bar used to display the cooldown progress for the action.

Defined in ​

profectus/src/features/action.tsx:49

canClick ​

• Optional canClick: Computable<boolean>

Whether or not the clickable may be clicked.

Inherited from ​

Omit.canClick

Defined in ​

profectus/src/features/clickables/clickable.ts:32

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Inherited from ​

Omit.classes

Defined in ​

profectus/src/features/clickables/clickable.ts:34

display ​

• Optional display: Computable<CoercableComponent | { description: CoercableComponent ; title?: CoercableComponent }>

The display to use for this clickable.

Inherited from ​

Omit.display

Defined in ​

profectus/src/features/clickables/clickable.ts:40

duration ​

• duration: Computable<DecimalSource>

The cooldown during which the action cannot be performed again, in seconds.

Defined in ​

profectus/src/features/action.tsx:43

mark ​

• Optional mark: Computable<string | boolean>

Shows a marker on the corner of the feature.

Inherited from ​

Omit.mark

Defined in ​

profectus/src/features/clickables/clickable.ts:38

onClick ​

• onClick: (amount: DecimalSource) => void

Type declaration ​

â–¸ (amount): void

A function that is called when the action is clicked.

Parameters ​
NameType
amountDecimalSource
Returns ​

void

Defined in ​

profectus/src/features/action.tsx:47

small ​

• Optional small: boolean

Toggles a smaller design for the feature.

Inherited from ​

Omit.small

Defined in ​

profectus/src/features/clickables/clickable.ts:50

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Inherited from ​

Omit.style

Defined in ​

profectus/src/features/clickables/clickable.ts:36

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this clickable should be visible.

Inherited from ​

Omit.visibility

Defined in ​

profectus/src/features/clickables/clickable.ts:30

- diff --git a/api/interfaces/features/action.BaseAction.html b/api/interfaces/features/action.BaseAction.html index 14e8ab7b..3a2d7eea 100644 --- a/api/interfaces/features/action.BaseAction.html +++ b/api/interfaces/features/action.BaseAction.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseAction ​

features/action.BaseAction

The properties that are added onto a processed ActionOptions to create an Action.

Properties ​

[Component] ​

• [Component]: GenericComponent

The Vue component used to render this feature.

Defined in ​

profectus/src/features/action.tsx:69

[GatherProps] ​

• [GatherProps]: () => Record<string, unknown>

Type declaration ​

â–¸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns ​

Record<string, unknown>

Defined in ​

profectus/src/features/action.tsx:71

id ​

• id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Defined in ​

profectus/src/features/action.tsx:57

isHolding ​

• isHolding: Ref<boolean>

Whether or not the player is holding down the action. Actions will be considered clicked as soon as the cooldown completes when being held down.

Defined in ​

profectus/src/features/action.tsx:61

progress ​

• progress: Ref<DecimalSource>

The current amount of progress through the cooldown.

Defined in ​

profectus/src/features/action.tsx:63

progressBar ​

• progressBar: GenericBar

The bar used to display the current cooldown progress.

Defined in ​

profectus/src/features/action.tsx:65

type ​

• type: typeof ActionType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/action.tsx:59

update ​

• update: (diff: number) => void

Type declaration ​

â–¸ (diff): void

Update the cooldown the specified number of seconds

Parameters ​
NameType
diffnumber
Returns ​

void

Defined in ​

profectus/src/features/action.tsx:67

- diff --git a/api/interfaces/features/bars/bar.BarOptions.html b/api/interfaces/features/bars/bar.BarOptions.html index 82487e75..c29ed2ec 100644 --- a/api/interfaces/features/bars/bar.BarOptions.html +++ b/api/interfaces/features/bars/bar.BarOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BarOptions ​

features/bars/bar.BarOptions

An object that configures a Bar.

Properties ​

baseStyle ​

• Optional baseStyle: Computable<StyleValue>

CSS to apply to the bar's base.

Defined in ​

profectus/src/features/bars/bar.ts:44

borderStyle ​

• Optional borderStyle: Computable<StyleValue>

CSS to apply to the bar's border.

Defined in ​

profectus/src/features/bars/bar.ts:42

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Defined in ​

profectus/src/features/bars/bar.ts:40

direction ​

• direction: Computable<Direction>

The direction in which the bar progresses.

Defined in ​

profectus/src/features/bars/bar.ts:36

display ​

• Optional display: Computable<CoercableComponent>

The display to use for this bar.

Defined in ​

profectus/src/features/bars/bar.ts:52

fillStyle ​

• Optional fillStyle: Computable<StyleValue>

CSS to apply to the bar's fill.

Defined in ​

profectus/src/features/bars/bar.ts:48

height ​

• height: Computable<number>

The height of the bar.

Defined in ​

profectus/src/features/bars/bar.ts:34

mark ​

• Optional mark: Computable<string | boolean>

Shows a marker on the corner of the feature.

Defined in ​

profectus/src/features/bars/bar.ts:54

progress ​

• progress: Computable<DecimalSource>

The progress value of the bar, from 0 to 1.

Defined in ​

profectus/src/features/bars/bar.ts:50

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Defined in ​

profectus/src/features/bars/bar.ts:38

textStyle ​

• Optional textStyle: Computable<StyleValue>

CSS to apply to the bar's text.

Defined in ​

profectus/src/features/bars/bar.ts:46

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this bar should be visible.

Defined in ​

profectus/src/features/bars/bar.ts:30

width ​

• width: Computable<number>

The width of the bar.

Defined in ​

profectus/src/features/bars/bar.ts:32

- diff --git a/api/interfaces/features/bars/bar.BaseBar.html b/api/interfaces/features/bars/bar.BaseBar.html index 25e03f76..474101b6 100644 --- a/api/interfaces/features/bars/bar.BaseBar.html +++ b/api/interfaces/features/bars/bar.BaseBar.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseBar ​

features/bars/bar.BaseBar

The properties that are added onto a processed BarOptions to create a Bar.

Properties ​

[Component] ​

• [Component]: GenericComponent

The Vue component used to render this feature.

Defined in ​

profectus/src/features/bars/bar.ts:66

[GatherProps] ​

• [GatherProps]: () => Record<string, unknown>

Type declaration ​

â–¸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns ​

Record<string, unknown>

Defined in ​

profectus/src/features/bars/bar.ts:68

id ​

• id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Defined in ​

profectus/src/features/bars/bar.ts:62

type ​

• type: typeof BarType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/bars/bar.ts:64

- diff --git a/api/interfaces/features/boards/board.BaseBoard.html b/api/interfaces/features/boards/board.BaseBoard.html index 390dd22b..97dfe24c 100644 --- a/api/interfaces/features/boards/board.BaseBoard.html +++ b/api/interfaces/features/boards/board.BaseBoard.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseBoard ​

features/boards/board.BaseBoard

The properties that are added onto a processed BoardOptions to create a Board.

Properties ​

[Component] ​

• [Component]: GenericComponent

The Vue component used to render this feature.

Defined in ​

profectus/src/features/boards/board.ts:254

[GatherProps] ​

• [GatherProps]: () => Record<string, unknown>

Type declaration ​

â–¸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns ​

Record<string, unknown>

Defined in ​

profectus/src/features/boards/board.ts:256

id ​

• id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Defined in ​

profectus/src/features/boards/board.ts:242

mousePosition ​

• mousePosition: Ref<null | { x: number ; y: number }>

The current mouse position, if over the board.

Defined in ​

profectus/src/features/boards/board.ts:250

nodes ​

• nodes: Ref<BoardNode[]>

All the nodes currently on the board.

Defined in ​

profectus/src/features/boards/board.ts:244

selectedAction ​

• selectedAction: Ref<null | GenericBoardNodeAction>

The currently selected action, if any.

Defined in ​

profectus/src/features/boards/board.ts:248

selectedNode ​

• selectedNode: Ref<null | BoardNode>

The currently selected node, if any.

Defined in ​

profectus/src/features/boards/board.ts:246

type ​

• type: typeof BoardType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/boards/board.ts:252

- diff --git a/api/interfaces/features/boards/board.BaseBoardNodeAction.html b/api/interfaces/features/boards/board.BaseBoardNodeAction.html index f9c40029..c565198d 100644 --- a/api/interfaces/features/boards/board.BaseBoardNodeAction.html +++ b/api/interfaces/features/boards/board.BaseBoardNodeAction.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseBoardNodeAction ​

features/boards/board.BaseBoardNodeAction

The properties that are added onto a processed BoardNodeActionOptions to create an BoardNodeAction.

Properties ​

• Optional links: Ref<BoardNodeLink[]>

Defined in ​

profectus/src/features/boards/board.ts:190

- diff --git a/api/interfaces/features/boards/board.BaseNodeType.html b/api/interfaces/features/boards/board.BaseNodeType.html index 09323974..1ed66510 100644 --- a/api/interfaces/features/boards/board.BaseNodeType.html +++ b/api/interfaces/features/boards/board.BaseNodeType.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseNodeType ​

features/boards/board.BaseNodeType

The properties that are added onto a processed NodeTypeOptions to create a NodeType.

Properties ​

nodes ​

• nodes: Ref<BoardNode[]>

The nodes currently on the board of this type.

Defined in ​

profectus/src/features/boards/board.ts:128

- diff --git a/api/interfaces/features/boards/board.BoardNode.html b/api/interfaces/features/boards/board.BoardNode.html index 9327541c..9e5d166f 100644 --- a/api/interfaces/features/boards/board.BoardNode.html +++ b/api/interfaces/features/boards/board.BoardNode.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BoardNode ​

features/boards/board.BoardNode

An object representing a node on the board.

Properties ​

id ​

• id: number

Defined in ​

profectus/src/features/boards/board.ts:52

pinned ​

• Optional pinned: boolean

Defined in ​

profectus/src/features/boards/board.ts:59

position ​

• position: Object

Type declaration ​

NameType
xnumber
ynumber

Defined in ​

profectus/src/features/boards/board.ts:53

state ​

• Optional state: State

Defined in ​

profectus/src/features/boards/board.ts:58

type ​

• type: string

Defined in ​

profectus/src/features/boards/board.ts:57

- diff --git a/api/interfaces/features/boards/board.BoardNodeActionOptions.html b/api/interfaces/features/boards/board.BoardNodeActionOptions.html index b8f2ad97..933c05d1 100644 --- a/api/interfaces/features/boards/board.BoardNodeActionOptions.html +++ b/api/interfaces/features/boards/board.BoardNodeActionOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BoardNodeActionOptions ​

features/boards/board.BoardNodeActionOptions

An object that configures a BoardNodeAction.

Properties ​

fillColor ​

• Optional fillColor: NodeComputable<string>

The fill color of the action.

Defined in ​

profectus/src/features/boards/board.ts:177

icon ​

• icon: NodeComputable<string>

The icon to display for the action.

Defined in ​

profectus/src/features/boards/board.ts:175

id ​

• id: string

A unique identifier for the action.

Defined in ​

profectus/src/features/boards/board.ts:171

• Optional links: NodeComputable<BoardNodeLink[]>

An array of board node links associated with the action. They appear when the action is focused.

Defined in ​

profectus/src/features/boards/board.ts:181

onClick ​

• onClick: (node: BoardNode) => undefined | boolean

Type declaration ​

â–¸ (node): undefined | boolean

A function that is called when the action is clicked.

Parameters ​
NameType
nodeBoardNode
Returns ​

undefined | boolean

Defined in ​

profectus/src/features/boards/board.ts:183

tooltip ​

• tooltip: NodeComputable<string>

The tooltip text to display for the action.

Defined in ​

profectus/src/features/boards/board.ts:179

visibility ​

• Optional visibility: NodeComputable<boolean | Visibility>

Whether this action should be visible.

Defined in ​

profectus/src/features/boards/board.ts:173

- diff --git a/api/interfaces/features/boards/board.BoardNodeLink.html b/api/interfaces/features/boards/board.BoardNodeLink.html index de075018..9f65087b 100644 --- a/api/interfaces/features/boards/board.BoardNodeLink.html +++ b/api/interfaces/features/boards/board.BoardNodeLink.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BoardNodeLink ​

features/boards/board.BoardNodeLink

An object representing a link between two nodes on the board.

Hierarchy ​

  • Omit<Link, "startNode" | "endNode">

    ↳ BoardNodeLink

Properties ​

accent-height ​

• Optional accent-height: Numberish

Inherited from ​

Omit.accent-height

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:945

accumulate ​

• Optional accumulate: "none" | "sum"

Inherited from ​

Omit.accumulate

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:946

additive ​

• Optional additive: "sum" | "replace"

Inherited from ​

Omit.additive

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:947

alignment-baseline ​

• Optional alignment-baseline: "alphabetic" | "hanging" | "ideographic" | "mathematical" | "auto" | "baseline" | "before-edge" | "text-before-edge" | "middle" | "central" | "after-edge" | "text-after-edge" | "inherit"

Inherited from ​

Omit.alignment-baseline

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:948

allowReorder ​

• Optional allowReorder: "no" | "yes"

Inherited from ​

Omit.allowReorder

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:962

alphabetic ​

• Optional alphabetic: Numberish

Inherited from ​

Omit.alphabetic

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:963

amplitude ​

• Optional amplitude: Numberish

Inherited from ​

Omit.amplitude

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:964

arabic-form ​

• Optional arabic-form: "initial" | "medial" | "terminal" | "isolated"

Inherited from ​

Omit.arabic-form

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:965

aria-activedescendant ​

• Optional aria-activedescendant: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

Inherited from ​

Omit.aria-activedescendant

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:224

aria-atomic ​

• Optional aria-atomic: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

Inherited from ​

Omit.aria-atomic

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:226

aria-autocomplete ​

• Optional aria-autocomplete: "none" | "inline" | "list" | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

Inherited from ​

Omit.aria-autocomplete

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:231

aria-busy ​

• Optional aria-busy: Booleanish

Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

Inherited from ​

Omit.aria-busy

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:233

aria-checked ​

• Optional aria-checked: Booleanish | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

See

  • aria-pressed
  • aria-selected.

Inherited from ​

Omit.aria-checked

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:238

aria-colcount ​

• Optional aria-colcount: Numberish

Defines the total number of columns in a table, grid, or treegrid.

See

aria-colindex.

Inherited from ​

Omit.aria-colcount

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:243

aria-colindex ​

• Optional aria-colindex: Numberish

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

See

  • aria-colcount
  • aria-colspan.

Inherited from ​

Omit.aria-colindex

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:248

aria-colspan ​

• Optional aria-colspan: Numberish

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

See

  • aria-colindex
  • aria-rowspan.

Inherited from ​

Omit.aria-colspan

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:253

aria-controls ​

• Optional aria-controls: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

See

aria-owns.

Inherited from ​

Omit.aria-controls

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:258

aria-current ​

• Optional aria-current: "time" | Booleanish | "page" | "step" | "location" | "date"

Indicates the element that represents the current item within a container or set of related elements.

Inherited from ​

Omit.aria-current

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:260

aria-describedby ​

• Optional aria-describedby: string

Identifies the element (or elements) that describes the object.

See

aria-labelledby

Inherited from ​

Omit.aria-describedby

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:265

aria-details ​

• Optional aria-details: string

Identifies the element that provides a detailed, extended description for the object.

See

aria-describedby.

Inherited from ​

Omit.aria-details

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:270

aria-disabled ​

• Optional aria-disabled: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

See

  • aria-hidden
  • aria-readonly.

Inherited from ​

Omit.aria-disabled

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:275

aria-dropeffect ​

• Optional aria-dropeffect: "none" | "copy" | "execute" | "link" | "move" | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.

Deprecated

in ARIA 1.1

Inherited from ​

Omit.aria-dropeffect

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:280

aria-errormessage ​

• Optional aria-errormessage: string

Identifies the element that provides an error message for the object.

See

  • aria-invalid
  • aria-describedby.

Inherited from ​

Omit.aria-errormessage

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:285

aria-expanded ​

• Optional aria-expanded: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

Inherited from ​

Omit.aria-expanded

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:287

aria-flowto ​

• Optional aria-flowto: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

Inherited from ​

Omit.aria-flowto

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:292

aria-grabbed ​

• Optional aria-grabbed: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

Deprecated

in ARIA 1.1

Inherited from ​

Omit.aria-grabbed

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:297

aria-haspopup ​

• Optional aria-haspopup: "tree" | Booleanish | "menu" | "listbox" | "grid" | "dialog"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

Inherited from ​

Omit.aria-haspopup

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:299

aria-hidden ​

• Optional aria-hidden: Booleanish

Indicates whether the element is exposed to an accessibility API.

See

aria-disabled.

Inherited from ​

Omit.aria-hidden

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:304

aria-invalid ​

• Optional aria-invalid: Booleanish | "grammar" | "spelling"

Indicates the entered value does not conform to the format expected by the application.

See

aria-errormessage.

Inherited from ​

Omit.aria-invalid

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:309

aria-keyshortcuts ​

• Optional aria-keyshortcuts: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

Inherited from ​

Omit.aria-keyshortcuts

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:311

aria-label ​

• Optional aria-label: string

Defines a string value that labels the current element.

See

aria-labelledby.

Inherited from ​

Omit.aria-label

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:316

aria-labelledby ​

• Optional aria-labelledby: string

Identifies the element (or elements) that labels the current element.

See

aria-describedby.

Inherited from ​

Omit.aria-labelledby

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:321

aria-level ​

• Optional aria-level: Numberish

Defines the hierarchical level of an element within a structure.

Inherited from ​

Omit.aria-level

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:323

aria-live ​

• Optional aria-live: "off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

Inherited from ​

Omit.aria-live

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:325

aria-modal ​

• Optional aria-modal: Booleanish

Indicates whether an element is modal when displayed.

Inherited from ​

Omit.aria-modal

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:327

aria-multiline ​

• Optional aria-multiline: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

Inherited from ​

Omit.aria-multiline

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:329

aria-multiselectable ​

• Optional aria-multiselectable: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

Inherited from ​

Omit.aria-multiselectable

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:331

aria-orientation ​

• Optional aria-orientation: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

Inherited from ​

Omit.aria-orientation

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:333

aria-owns ​

• Optional aria-owns: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

See

aria-controls.

Inherited from ​

Omit.aria-owns

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:339

aria-placeholder ​

• Optional aria-placeholder: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

Inherited from ​

Omit.aria-placeholder

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:344

aria-posinset ​

• Optional aria-posinset: Numberish

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-setsize.

Inherited from ​

Omit.aria-posinset

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:349

aria-pressed ​

• Optional aria-pressed: Booleanish | "mixed"

Indicates the current "pressed" state of toggle buttons.

See

  • aria-checked
  • aria-selected.

Inherited from ​

Omit.aria-pressed

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:354

aria-readonly ​

• Optional aria-readonly: Booleanish

Indicates that the element is not editable, but is otherwise operable.

See

aria-disabled.

Inherited from ​

Omit.aria-readonly

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:359

aria-relevant ​

• Optional aria-relevant: "additions" | "additions text" | "all" | "removals" | "text"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

See

aria-atomic.

Inherited from ​

Omit.aria-relevant

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:364

aria-required ​

• Optional aria-required: Booleanish

Indicates that user input is required on the element before a form may be submitted.

Inherited from ​

Omit.aria-required

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:366

aria-roledescription ​

• Optional aria-roledescription: string

Defines a human-readable, author-localized description for the role of an element.

Inherited from ​

Omit.aria-roledescription

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:368

aria-rowcount ​

• Optional aria-rowcount: Numberish

Defines the total number of rows in a table, grid, or treegrid.

See

aria-rowindex.

Inherited from ​

Omit.aria-rowcount

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:373

aria-rowindex ​

• Optional aria-rowindex: Numberish

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

See

  • aria-rowcount
  • aria-rowspan.

Inherited from ​

Omit.aria-rowindex

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:378

aria-rowspan ​

• Optional aria-rowspan: Numberish

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

See

  • aria-rowindex
  • aria-colspan.

Inherited from ​

Omit.aria-rowspan

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:383

aria-selected ​

• Optional aria-selected: Booleanish

Indicates the current "selected" state of various widgets.

See

  • aria-checked
  • aria-pressed.

Inherited from ​

Omit.aria-selected

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:388

aria-setsize ​

• Optional aria-setsize: Numberish

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-posinset.

Inherited from ​

Omit.aria-setsize

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:393

aria-sort ​

• Optional aria-sort: "none" | "ascending" | "descending" | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

Inherited from ​

Omit.aria-sort

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:395

aria-valuemax ​

• Optional aria-valuemax: Numberish

Defines the maximum allowed value for a range widget.

Inherited from ​

Omit.aria-valuemax

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:397

aria-valuemin ​

• Optional aria-valuemin: Numberish

Defines the minimum allowed value for a range widget.

Inherited from ​

Omit.aria-valuemin

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:399

aria-valuenow ​

• Optional aria-valuenow: Numberish

Defines the current value for a range widget.

See

aria-valuetext.

Inherited from ​

Omit.aria-valuenow

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:404

aria-valuetext ​

• Optional aria-valuetext: string

Defines the human readable text alternative of aria-valuenow for a range widget.

Inherited from ​

Omit.aria-valuetext

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:406

ascent ​

• Optional ascent: Numberish

Inherited from ​

Omit.ascent

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:966

attributeName ​

• Optional attributeName: string

Inherited from ​

Omit.attributeName

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:967

attributeType ​

• Optional attributeType: string

Inherited from ​

Omit.attributeType

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:968

autoReverse ​

• Optional autoReverse: Numberish

Inherited from ​

Omit.autoReverse

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:969

azimuth ​

• Optional azimuth: Numberish

Inherited from ​

Omit.azimuth

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:970

baseFrequency ​

• Optional baseFrequency: Numberish

Inherited from ​

Omit.baseFrequency

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:971

baseProfile ​

• Optional baseProfile: Numberish

Inherited from ​

Omit.baseProfile

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:973

baseline-shift ​

• Optional baseline-shift: Numberish

Inherited from ​

Omit.baseline-shift

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:972

bbox ​

• Optional bbox: Numberish

Inherited from ​

Omit.bbox

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:974

begin ​

• Optional begin: Numberish

Inherited from ​

Omit.begin

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:975

bias ​

• Optional bias: Numberish

Inherited from ​

Omit.bias

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:976

by ​

• Optional by: Numberish

Inherited from ​

Omit.by

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:977

calcMode ​

• Optional calcMode: Numberish

Inherited from ​

Omit.calcMode

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:978

cap-height ​

• Optional cap-height: Numberish

Inherited from ​

Omit.cap-height

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:979

class ​

• Optional class: any

SVG Styling Attributes

See

https://www.w3.org/TR/SVG/styling.html#ElementSpecificStyling

Inherited from ​

Omit.class

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:924

clip ​

• Optional clip: Numberish

Inherited from ​

Omit.clip

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:980

clip-path ​

• Optional clip-path: string

Inherited from ​

Omit.clip-path

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:981

clip-rule ​

• Optional clip-rule: Numberish

Inherited from ​

Omit.clip-rule

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:983

clipPathUnits ​

• Optional clipPathUnits: Numberish

Inherited from ​

Omit.clipPathUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:982

color ​

• Optional color: string

Inherited from ​

Omit.color

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:927

color-interpolation ​

• Optional color-interpolation: Numberish

Inherited from ​

Omit.color-interpolation

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:984

color-interpolation-filters ​

• Optional color-interpolation-filters: "auto" | "inherit" | "sRGB" | "linearRGB"

Inherited from ​

Omit.color-interpolation-filters

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:985

color-profile ​

• Optional color-profile: Numberish

Inherited from ​

Omit.color-profile

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:986

color-rendering ​

• Optional color-rendering: Numberish

Inherited from ​

Omit.color-rendering

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:987

contentScriptType ​

• Optional contentScriptType: Numberish

Inherited from ​

Omit.contentScriptType

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:988

contentStyleType ​

• Optional contentStyleType: Numberish

Inherited from ​

Omit.contentStyleType

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:989

cursor ​

• Optional cursor: Numberish

Inherited from ​

Omit.cursor

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:990

cx ​

• Optional cx: Numberish

Inherited from ​

Omit.cx

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:991

cy ​

• Optional cy: Numberish

Inherited from ​

Omit.cy

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:992

d ​

• Optional d: string

Inherited from ​

Omit.d

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:993

decelerate ​

• Optional decelerate: Numberish

Inherited from ​

Omit.decelerate

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:994

descent ​

• Optional descent: Numberish

Inherited from ​

Omit.descent

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:995

diffuseConstant ​

• Optional diffuseConstant: Numberish

Inherited from ​

Omit.diffuseConstant

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:996

direction ​

• Optional direction: Numberish

Inherited from ​

Omit.direction

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:997

display ​

• Optional display: Numberish

Inherited from ​

Omit.display

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:998

divisor ​

• Optional divisor: Numberish

Inherited from ​

Omit.divisor

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:999

dominant-baseline ​

• Optional dominant-baseline: Numberish

Inherited from ​

Omit.dominant-baseline

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1000

dur ​

• Optional dur: Numberish

Inherited from ​

Omit.dur

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1001

dx ​

• Optional dx: Numberish

Inherited from ​

Omit.dx

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1002

dy ​

• Optional dy: Numberish

Inherited from ​

Omit.dy

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1003

edgeMode ​

• Optional edgeMode: Numberish

Inherited from ​

Omit.edgeMode

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1004

elevation ​

• Optional elevation: Numberish

Inherited from ​

Omit.elevation

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1005

enable-background ​

• Optional enable-background: Numberish

Inherited from ​

Omit.enable-background

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1006

end ​

• Optional end: Numberish

Inherited from ​

Omit.end

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1007

endNode ​

• endNode: BoardNode

Defined in ​

profectus/src/features/boards/board.ts:65

exponent ​

• Optional exponent: Numberish

Inherited from ​

Omit.exponent

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1008

externalResourcesRequired ​

• Optional externalResourcesRequired: Numberish

Inherited from ​

Omit.externalResourcesRequired

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1009

fill ​

• Optional fill: string

Inherited from ​

Omit.fill

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1010

fill-opacity ​

• Optional fill-opacity: Numberish

Inherited from ​

Omit.fill-opacity

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1011

fill-rule ​

• Optional fill-rule: "inherit" | "nonzero" | "evenodd"

Inherited from ​

Omit.fill-rule

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1012

filter ​

• Optional filter: string

Inherited from ​

Omit.filter

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1013

filterRes ​

• Optional filterRes: Numberish

Inherited from ​

Omit.filterRes

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1014

filterUnits ​

• Optional filterUnits: Numberish

Inherited from ​

Omit.filterUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1015

flood-color ​

• Optional flood-color: Numberish

Inherited from ​

Omit.flood-color

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1016

flood-opacity ​

• Optional flood-opacity: Numberish

Inherited from ​

Omit.flood-opacity

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1017

focusable ​

• Optional focusable: Numberish

Inherited from ​

Omit.focusable

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1018

font-family ​

• Optional font-family: string

Inherited from ​

Omit.font-family

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1019

font-size ​

• Optional font-size: Numberish

Inherited from ​

Omit.font-size

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1020

font-size-adjust ​

• Optional font-size-adjust: Numberish

Inherited from ​

Omit.font-size-adjust

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1021

font-stretch ​

• Optional font-stretch: Numberish

Inherited from ​

Omit.font-stretch

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1022

font-style ​

• Optional font-style: Numberish

Inherited from ​

Omit.font-style

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1023

font-variant ​

• Optional font-variant: Numberish

Inherited from ​

Omit.font-variant

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1024

font-weight ​

• Optional font-weight: Numberish

Inherited from ​

Omit.font-weight

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1025

format ​

• Optional format: Numberish

Inherited from ​

Omit.format

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1026

from ​

• Optional from: Numberish

Inherited from ​

Omit.from

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1027

fx ​

• Optional fx: Numberish

Inherited from ​

Omit.fx

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1028

fy ​

• Optional fy: Numberish

Inherited from ​

Omit.fy

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1029

g1 ​

• Optional g1: Numberish

Inherited from ​

Omit.g1

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1030

g2 ​

• Optional g2: Numberish

Inherited from ​

Omit.g2

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1031

glyph-name ​

• Optional glyph-name: Numberish

Inherited from ​

Omit.glyph-name

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1032

glyph-orientation-horizontal ​

• Optional glyph-orientation-horizontal: Numberish

Inherited from ​

Omit.glyph-orientation-horizontal

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1033

glyph-orientation-vertical ​

• Optional glyph-orientation-vertical: Numberish

Inherited from ​

Omit.glyph-orientation-vertical

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1034

glyphRef ​

• Optional glyphRef: Numberish

Inherited from ​

Omit.glyphRef

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1035

gradientTransform ​

• Optional gradientTransform: string

Inherited from ​

Omit.gradientTransform

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1036

gradientUnits ​

• Optional gradientUnits: string

Inherited from ​

Omit.gradientUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1037

hanging ​

• Optional hanging: Numberish

Inherited from ​

Omit.hanging

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1038

height ​

• Optional height: Numberish

Inherited from ​

Omit.height

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:928

horiz-adv-x ​

• Optional horiz-adv-x: Numberish

Inherited from ​

Omit.horiz-adv-x

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1039

horiz-origin-x ​

• Optional horiz-origin-x: Numberish

Inherited from ​

Omit.horiz-origin-x

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1040

href ​

• Optional href: string

Inherited from ​

Omit.href

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1041

id ​

• Optional id: string

Inherited from ​

Omit.id

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:929

ideographic ​

• Optional ideographic: Numberish

Inherited from ​

Omit.ideographic

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1042

image-rendering ​

• Optional image-rendering: Numberish

Inherited from ​

Omit.image-rendering

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1043

in ​

• Optional in: string

Inherited from ​

Omit.in

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1045

in2 ​

• Optional in2: Numberish

Inherited from ​

Omit.in2

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1044

innerHTML ​

• Optional innerHTML: string

Inherited from ​

Omit.innerHTML

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:918

intercept ​

• Optional intercept: Numberish

Inherited from ​

Omit.intercept

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1046

k ​

• Optional k: Numberish

Inherited from ​

Omit.k

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1051

k1 ​

• Optional k1: Numberish

Inherited from ​

Omit.k1

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1047

k2 ​

• Optional k2: Numberish

Inherited from ​

Omit.k2

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1048

k3 ​

• Optional k3: Numberish

Inherited from ​

Omit.k3

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1049

k4 ​

• Optional k4: Numberish

Inherited from ​

Omit.k4

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1050

kernelMatrix ​

• Optional kernelMatrix: Numberish

Inherited from ​

Omit.kernelMatrix

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1052

kernelUnitLength ​

• Optional kernelUnitLength: Numberish

Inherited from ​

Omit.kernelUnitLength

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1053

kerning ​

• Optional kerning: Numberish

Inherited from ​

Omit.kerning

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1054

keyPoints ​

• Optional keyPoints: Numberish

Inherited from ​

Omit.keyPoints

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1055

keySplines ​

• Optional keySplines: Numberish

Inherited from ​

Omit.keySplines

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1056

keyTimes ​

• Optional keyTimes: Numberish

Inherited from ​

Omit.keyTimes

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1057

lang ​

• Optional lang: string

Inherited from ​

Omit.lang

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:930

lengthAdjust ​

• Optional lengthAdjust: Numberish

Inherited from ​

Omit.lengthAdjust

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1058

letter-spacing ​

• Optional letter-spacing: Numberish

Inherited from ​

Omit.letter-spacing

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1059

lighting-color ​

• Optional lighting-color: Numberish

Inherited from ​

Omit.lighting-color

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1060

limitingConeAngle ​

• Optional limitingConeAngle: Numberish

Inherited from ​

Omit.limitingConeAngle

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1061

local ​

• Optional local: Numberish

Inherited from ​

Omit.local

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1062

marker-end ​

• Optional marker-end: string

Inherited from ​

Omit.marker-end

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1063

marker-mid ​

• Optional marker-mid: string

Inherited from ​

Omit.marker-mid

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1065

marker-start ​

• Optional marker-start: string

Inherited from ​

Omit.marker-start

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1066

markerHeight ​

• Optional markerHeight: Numberish

Inherited from ​

Omit.markerHeight

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1064

markerUnits ​

• Optional markerUnits: Numberish

Inherited from ​

Omit.markerUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1067

markerWidth ​

• Optional markerWidth: Numberish

Inherited from ​

Omit.markerWidth

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1068

mask ​

• Optional mask: string

Inherited from ​

Omit.mask

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1069

maskContentUnits ​

• Optional maskContentUnits: Numberish

Inherited from ​

Omit.maskContentUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1070

maskUnits ​

• Optional maskUnits: Numberish

Inherited from ​

Omit.maskUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1071

mathematical ​

• Optional mathematical: Numberish

Inherited from ​

Omit.mathematical

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1072

max ​

• Optional max: Numberish

Inherited from ​

Omit.max

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:931

media ​

• Optional media: string

Inherited from ​

Omit.media

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:932

method ​

• Optional method: string

Inherited from ​

Omit.method

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:933

min ​

• Optional min: Numberish

Inherited from ​

Omit.min

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:934

mode ​

• Optional mode: Numberish

Inherited from ​

Omit.mode

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1073

name ​

• Optional name: string

Inherited from ​

Omit.name

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:935

numOctaves ​

• Optional numOctaves: Numberish

Inherited from ​

Omit.numOctaves

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1074

offset ​

• Optional offset: Numberish

Inherited from ​

Omit.offset

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1075

offsetEnd ​

• Optional offsetEnd: Position

Inherited from ​

Omit.offsetEnd

Defined in ​

profectus/src/features/links/links.ts:18

offsetStart ​

• Optional offsetStart: Position

Inherited from ​

Omit.offsetStart

Defined in ​

profectus/src/features/links/links.ts:17

onAbort ​

• Optional onAbort: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onAbort

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1432

onAnimationend ​

• Optional onAnimationend: (payload: AnimationEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadAnimationEvent
Returns ​

void

Inherited from ​

Omit.onAnimationend

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1482

onAnimationiteration ​

• Optional onAnimationiteration: (payload: AnimationEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadAnimationEvent
Returns ​

void

Inherited from ​

Omit.onAnimationiteration

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1483

onAnimationstart ​

• Optional onAnimationstart: (payload: AnimationEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadAnimationEvent
Returns ​

void

Inherited from ​

Omit.onAnimationstart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1481

onAuxclick ​

• Optional onAuxclick: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onAuxclick

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1419

onBeforeinput ​

• Optional onBeforeinput: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onBeforeinput

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1403

onBlur ​

• Optional onBlur: (payload: FocusEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadFocusEvent
Returns ​

void

Inherited from ​

Omit.onBlur

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1399

onCanplay ​

• Optional onCanplay: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onCanplay

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1433

onCanplaythrough ​

• Optional onCanplaythrough: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onCanplaythrough

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1434

onChange ​

• Optional onChange: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onChange

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1402

onClick ​

• Optional onClick: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onClick

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1420

onCompositionend ​

• Optional onCompositionend: (payload: CompositionEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadCompositionEvent
Returns ​

void

Inherited from ​

Omit.onCompositionend

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1381

onCompositionstart ​

• Optional onCompositionstart: (payload: CompositionEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadCompositionEvent
Returns ​

void

Inherited from ​

Omit.onCompositionstart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1382

onCompositionupdate ​

• Optional onCompositionupdate: (payload: CompositionEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadCompositionEvent
Returns ​

void

Inherited from ​

Omit.onCompositionupdate

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1383

onContextmenu ​

• Optional onContextmenu: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onContextmenu

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1421

onCopy ​

• Optional onCopy: (payload: ClipboardEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadClipboardEvent
Returns ​

void

Inherited from ​

Omit.onCopy

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1376

onCut ​

• Optional onCut: (payload: ClipboardEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadClipboardEvent
Returns ​

void

Inherited from ​

Omit.onCut

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1377

onDblclick ​

• Optional onDblclick: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onDblclick

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1422

onDrag ​

• Optional onDrag: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

Omit.onDrag

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1386

onDragend ​

• Optional onDragend: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

Omit.onDragend

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1387

onDragenter ​

• Optional onDragenter: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

Omit.onDragenter

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1388

onDragexit ​

• Optional onDragexit: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

Omit.onDragexit

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1389

onDragleave ​

• Optional onDragleave: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

Omit.onDragleave

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1390

onDragover ​

• Optional onDragover: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

Omit.onDragover

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1391

onDragstart ​

• Optional onDragstart: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

Omit.onDragstart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1392

onDrop ​

• Optional onDrop: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

Omit.onDrop

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1393

onDurationchange ​

• Optional onDurationchange: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onDurationchange

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1435

onEmptied ​

• Optional onEmptied: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onEmptied

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1436

onEncrypted ​

• Optional onEncrypted: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onEncrypted

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1437

onEnded ​

• Optional onEnded: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onEnded

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1438

onError ​

• Optional onError: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onError

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1411

onFocus ​

• Optional onFocus: (payload: FocusEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadFocusEvent
Returns ​

void

Inherited from ​

Omit.onFocus

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1396

onFocusin ​

• Optional onFocusin: (payload: FocusEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadFocusEvent
Returns ​

void

Inherited from ​

Omit.onFocusin

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1397

onFocusout ​

• Optional onFocusout: (payload: FocusEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadFocusEvent
Returns ​

void

Inherited from ​

Omit.onFocusout

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1398

onInput ​

• Optional onInput: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onInput

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1404

onInvalid ​

• Optional onInvalid: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onInvalid

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1407

onKeydown ​

• Optional onKeydown: (payload: KeyboardEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadKeyboardEvent
Returns ​

void

Inherited from ​

Omit.onKeydown

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1414

onKeypress ​

• Optional onKeypress: (payload: KeyboardEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadKeyboardEvent
Returns ​

void

Inherited from ​

Omit.onKeypress

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1415

onKeyup ​

• Optional onKeyup: (payload: KeyboardEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadKeyboardEvent
Returns ​

void

Inherited from ​

Omit.onKeyup

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1416

onLoad ​

• Optional onLoad: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onLoad

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1410

onLoadeddata ​

• Optional onLoadeddata: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onLoadeddata

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1439

onLoadedmetadata ​

• Optional onLoadedmetadata: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onLoadedmetadata

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1440

onLoadstart ​

• Optional onLoadstart: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onLoadstart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1441

onMousedown ​

• Optional onMousedown: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onMousedown

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1423

onMouseenter ​

• Optional onMouseenter: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onMouseenter

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1424

onMouseleave ​

• Optional onMouseleave: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onMouseleave

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1425

onMousemove ​

• Optional onMousemove: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onMousemove

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1426

onMouseout ​

• Optional onMouseout: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onMouseout

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1427

onMouseover ​

• Optional onMouseover: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onMouseover

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1428

onMouseup ​

• Optional onMouseup: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onMouseup

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1429

onPaste ​

• Optional onPaste: (payload: ClipboardEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadClipboardEvent
Returns ​

void

Inherited from ​

Omit.onPaste

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1378

onPause ​

• Optional onPause: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onPause

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1442

onPlay ​

• Optional onPlay: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onPlay

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1443

onPlaying ​

• Optional onPlaying: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onPlaying

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1444

onPointercancel ​

• Optional onPointercancel: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

Omit.onPointercancel

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1471

onPointerdown ​

• Optional onPointerdown: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

Omit.onPointerdown

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1468

onPointerenter ​

• Optional onPointerenter: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

Omit.onPointerenter

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1472

onPointerleave ​

• Optional onPointerleave: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

Omit.onPointerleave

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1473

onPointermove ​

• Optional onPointermove: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

Omit.onPointermove

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1469

onPointerout ​

• Optional onPointerout: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

Omit.onPointerout

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1475

onPointerover ​

• Optional onPointerover: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

Omit.onPointerover

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1474

onPointerup ​

• Optional onPointerup: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

Omit.onPointerup

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1470

onProgress ​

• Optional onProgress: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onProgress

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1445

onRatechange ​

• Optional onRatechange: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onRatechange

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1446

onReset ​

• Optional onReset: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onReset

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1405

onScroll ​

• Optional onScroll: (payload: UIEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadUIEvent
Returns ​

void

Inherited from ​

Omit.onScroll

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1459

onSeeked ​

• Optional onSeeked: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onSeeked

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1447

onSeeking ​

• Optional onSeeking: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onSeeking

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1448

onSelect ​

• Optional onSelect: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onSelect

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1456

onStalled ​

• Optional onStalled: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onStalled

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1449

onSubmit ​

• Optional onSubmit: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onSubmit

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1406

onSuspend ​

• Optional onSuspend: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onSuspend

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1450

onTimeupdate ​

• Optional onTimeupdate: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onTimeupdate

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1451

onTouchcancel ​

• Optional onTouchcancel: (payload: TouchEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadTouchEvent
Returns ​

void

Inherited from ​

Omit.onTouchcancel

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1462

onTouchend ​

• Optional onTouchend: (payload: TouchEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadTouchEvent
Returns ​

void

Inherited from ​

Omit.onTouchend

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1463

onTouchmove ​

• Optional onTouchmove: (payload: TouchEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadTouchEvent
Returns ​

void

Inherited from ​

Omit.onTouchmove

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1464

onTouchstart ​

• Optional onTouchstart: (payload: TouchEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadTouchEvent
Returns ​

void

Inherited from ​

Omit.onTouchstart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1465

onTransitionend ​

• Optional onTransitionend: (payload: TransitionEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadTransitionEvent
Returns ​

void

Inherited from ​

Omit.onTransitionend

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1486

onTransitionstart ​

• Optional onTransitionstart: (payload: TransitionEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadTransitionEvent
Returns ​

void

Inherited from ​

Omit.onTransitionstart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1487

onVolumechange ​

• Optional onVolumechange: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onVolumechange

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1452

onWaiting ​

• Optional onWaiting: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onWaiting

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1453

onWheel ​

• Optional onWheel: (payload: WheelEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadWheelEvent
Returns ​

void

Inherited from ​

Omit.onWheel

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1478

opacity ​

• Optional opacity: Numberish

Inherited from ​

Omit.opacity

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1076

operator ​

• Optional operator: Numberish

Inherited from ​

Omit.operator

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1077

order ​

• Optional order: Numberish

Inherited from ​

Omit.order

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1078

orient ​

• Optional orient: Numberish

Inherited from ​

Omit.orient

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1079

orientation ​

• Optional orientation: Numberish

Inherited from ​

Omit.orientation

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1080

origin ​

• Optional origin: Numberish

Inherited from ​

Omit.origin

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1081

overflow ​

• Optional overflow: Numberish

Inherited from ​

Omit.overflow

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1082

overline-position ​

• Optional overline-position: Numberish

Inherited from ​

Omit.overline-position

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1083

overline-thickness ​

• Optional overline-thickness: Numberish

Inherited from ​

Omit.overline-thickness

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1084

paint-order ​

• Optional paint-order: Numberish

Inherited from ​

Omit.paint-order

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1085

panose-1 ​

• Optional panose-1: Numberish

Inherited from ​

Omit.panose-1

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1086

pathLength ​

• Optional pathLength: Numberish

Inherited from ​

Omit.pathLength

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1087

patternContentUnits ​

• Optional patternContentUnits: string

Inherited from ​

Omit.patternContentUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1088

patternTransform ​

• Optional patternTransform: Numberish

Inherited from ​

Omit.patternTransform

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1089

patternUnits ​

• Optional patternUnits: string

Inherited from ​

Omit.patternUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1090

pointer-events ​

• Optional pointer-events: Numberish

Inherited from ​

Omit.pointer-events

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1091

points ​

• Optional points: string

Inherited from ​

Omit.points

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1092

pointsAtX ​

• Optional pointsAtX: Numberish

Inherited from ​

Omit.pointsAtX

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1093

pointsAtY ​

• Optional pointsAtY: Numberish

Inherited from ​

Omit.pointsAtY

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1094

pointsAtZ ​

• Optional pointsAtZ: Numberish

Inherited from ​

Omit.pointsAtZ

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1095

preserveAlpha ​

• Optional preserveAlpha: Numberish

Inherited from ​

Omit.preserveAlpha

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1096

preserveAspectRatio ​

• Optional preserveAspectRatio: string

Inherited from ​

Omit.preserveAspectRatio

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1097

primitiveUnits ​

• Optional primitiveUnits: Numberish

Inherited from ​

Omit.primitiveUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1098

pulsing ​

• Optional pulsing: boolean

Defined in ​

profectus/src/features/boards/board.ts:66

r ​

• Optional r: Numberish

Inherited from ​

Omit.r

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1099

radius ​

• Optional radius: Numberish

Inherited from ​

Omit.radius

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1100

refX ​

• Optional refX: Numberish

Inherited from ​

Omit.refX

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1101

refY ​

• Optional refY: Numberish

Inherited from ​

Omit.refY

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1102

renderingIntent ​

• Optional renderingIntent: Numberish

Inherited from ​

Omit.renderingIntent

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1103

repeatCount ​

• Optional repeatCount: Numberish

Inherited from ​

Omit.repeatCount

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1104

repeatDur ​

• Optional repeatDur: Numberish

Inherited from ​

Omit.repeatDur

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1105

requiredExtensions ​

• Optional requiredExtensions: Numberish

Inherited from ​

Omit.requiredExtensions

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1106

requiredFeatures ​

• Optional requiredFeatures: Numberish

Inherited from ​

Omit.requiredFeatures

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1107

restart ​

• Optional restart: Numberish

Inherited from ​

Omit.restart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1108

result ​

• Optional result: string

Inherited from ​

Omit.result

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1109

role ​

• Optional role: string

Inherited from ​

Omit.role

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:941

rotate ​

• Optional rotate: Numberish

Inherited from ​

Omit.rotate

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1110

rx ​

• Optional rx: Numberish

Inherited from ​

Omit.rx

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1111

ry ​

• Optional ry: Numberish

Inherited from ​

Omit.ry

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1112

scale ​

• Optional scale: Numberish

Inherited from ​

Omit.scale

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1113

seed ​

• Optional seed: Numberish

Inherited from ​

Omit.seed

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1114

shape-rendering ​

• Optional shape-rendering: Numberish

Inherited from ​

Omit.shape-rendering

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1115

slope ​

• Optional slope: Numberish

Inherited from ​

Omit.slope

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1116

spacing ​

• Optional spacing: Numberish

Inherited from ​

Omit.spacing

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1117

specularConstant ​

• Optional specularConstant: Numberish

Inherited from ​

Omit.specularConstant

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1118

specularExponent ​

• Optional specularExponent: Numberish

Inherited from ​

Omit.specularExponent

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1119

speed ​

• Optional speed: Numberish

Inherited from ​

Omit.speed

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1120

spreadMethod ​

• Optional spreadMethod: string

Inherited from ​

Omit.spreadMethod

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1121

startNode ​

• startNode: BoardNode

Defined in ​

profectus/src/features/boards/board.ts:64

startOffset ​

• Optional startOffset: Numberish

Inherited from ​

Omit.startOffset

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1122

stdDeviation ​

• Optional stdDeviation: Numberish

Inherited from ​

Omit.stdDeviation

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1123

stemh ​

• Optional stemh: Numberish

Inherited from ​

Omit.stemh

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1124

stemv ​

• Optional stemv: Numberish

Inherited from ​

Omit.stemv

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1125

stitchTiles ​

• Optional stitchTiles: Numberish

Inherited from ​

Omit.stitchTiles

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1126

stop-color ​

• Optional stop-color: string

Inherited from ​

Omit.stop-color

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1127

stop-opacity ​

• Optional stop-opacity: Numberish

Inherited from ​

Omit.stop-opacity

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1128

strikethrough-position ​

• Optional strikethrough-position: Numberish

Inherited from ​

Omit.strikethrough-position

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1129

strikethrough-thickness ​

• Optional strikethrough-thickness: Numberish

Inherited from ​

Omit.strikethrough-thickness

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1130

string ​

• Optional string: Numberish

Inherited from ​

Omit.string

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1131

stroke ​

• Optional stroke: string

Inherited from ​

Omit.stroke

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1132

stroke-dasharray ​

• Optional stroke-dasharray: Numberish

Inherited from ​

Omit.stroke-dasharray

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1133

stroke-dashoffset ​

• Optional stroke-dashoffset: Numberish

Inherited from ​

Omit.stroke-dashoffset

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1134

stroke-linecap ​

• Optional stroke-linecap: "inherit" | "butt" | "round" | "square"

Inherited from ​

Omit.stroke-linecap

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1135

stroke-linejoin ​

• Optional stroke-linejoin: "inherit" | "round" | "miter" | "bevel"

Inherited from ​

Omit.stroke-linejoin

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1136

stroke-miterlimit ​

• Optional stroke-miterlimit: Numberish

Inherited from ​

Omit.stroke-miterlimit

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1137

stroke-opacity ​

• Optional stroke-opacity: Numberish

Inherited from ​

Omit.stroke-opacity

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1138

stroke-width ​

• Optional stroke-width: Numberish

Inherited from ​

Omit.stroke-width

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1139

style ​

• Optional style: string | CSSProperties

Inherited from ​

Omit.style

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:925

surfaceScale ​

• Optional surfaceScale: Numberish

Inherited from ​

Omit.surfaceScale

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1140

systemLanguage ​

• Optional systemLanguage: Numberish

Inherited from ​

Omit.systemLanguage

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1141

tabindex ​

• Optional tabindex: Numberish

Inherited from ​

Omit.tabindex

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:942

tableValues ​

• Optional tableValues: Numberish

Inherited from ​

Omit.tableValues

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1142

target ​

• Optional target: string

Inherited from ​

Omit.target

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:936

targetX ​

• Optional targetX: Numberish

Inherited from ​

Omit.targetX

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1143

targetY ​

• Optional targetY: Numberish

Inherited from ​

Omit.targetY

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1144

text-anchor ​

• Optional text-anchor: string

Inherited from ​

Omit.text-anchor

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1145

text-decoration ​

• Optional text-decoration: Numberish

Inherited from ​

Omit.text-decoration

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1146

text-rendering ​

• Optional text-rendering: Numberish

Inherited from ​

Omit.text-rendering

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1148

textLength ​

• Optional textLength: Numberish

Inherited from ​

Omit.textLength

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1147

to ​

• Optional to: Numberish

Inherited from ​

Omit.to

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1149

transform ​

• Optional transform: string

Inherited from ​

Omit.transform

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1150

type ​

• Optional type: string

Inherited from ​

Omit.type

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:937

u1 ​

• Optional u1: Numberish

Inherited from ​

Omit.u1

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1151

u2 ​

• Optional u2: Numberish

Inherited from ​

Omit.u2

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1152

underline-position ​

• Optional underline-position: Numberish

Inherited from ​

Omit.underline-position

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1153

underline-thickness ​

• Optional underline-thickness: Numberish

Inherited from ​

Omit.underline-thickness

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1154

unicode ​

• Optional unicode: Numberish

Inherited from ​

Omit.unicode

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1155

unicode-bidi ​

• Optional unicode-bidi: Numberish

Inherited from ​

Omit.unicode-bidi

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1156

unicode-range ​

• Optional unicode-range: Numberish

Inherited from ​

Omit.unicode-range

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1157

unitsPer-em ​

• Optional unitsPer-em: Numberish

Inherited from ​

Omit.unitsPer-em

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1158

v-alphabetic ​

• Optional v-alphabetic: Numberish

Inherited from ​

Omit.v-alphabetic

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1159

v-hanging ​

• Optional v-hanging: Numberish

Inherited from ​

Omit.v-hanging

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1166

v-ideographic ​

• Optional v-ideographic: Numberish

Inherited from ​

Omit.v-ideographic

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1167

v-mathematical ​

• Optional v-mathematical: Numberish

Inherited from ​

Omit.v-mathematical

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1171

values ​

• Optional values: string

Inherited from ​

Omit.values

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1160

vector-effect ​

• Optional vector-effect: Numberish

Inherited from ​

Omit.vector-effect

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1161

version ​

• Optional version: string

Inherited from ​

Omit.version

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1162

vert-adv-y ​

• Optional vert-adv-y: Numberish

Inherited from ​

Omit.vert-adv-y

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1163

vert-origin-x ​

• Optional vert-origin-x: Numberish

Inherited from ​

Omit.vert-origin-x

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1164

vert-origin-y ​

• Optional vert-origin-y: Numberish

Inherited from ​

Omit.vert-origin-y

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1165

viewBox ​

• Optional viewBox: string

Inherited from ​

Omit.viewBox

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1168

viewTarget ​

• Optional viewTarget: Numberish

Inherited from ​

Omit.viewTarget

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1169

visibility ​

• Optional visibility: Numberish

Inherited from ​

Omit.visibility

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1170

width ​

• Optional width: Numberish

Inherited from ​

Omit.width

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:938

widths ​

• Optional widths: Numberish

Inherited from ​

Omit.widths

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1172

word-spacing ​

• Optional word-spacing: Numberish

Inherited from ​

Omit.word-spacing

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1173

writing-mode ​

• Optional writing-mode: Numberish

Inherited from ​

Omit.writing-mode

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1174

x ​

• Optional x: Numberish

Inherited from ​

Omit.x

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1177

x-height ​

• Optional x-height: Numberish

Inherited from ​

Omit.x-height

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1179

x1 ​

• Optional x1: Numberish

Inherited from ​

Omit.x1

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1175

x2 ​

• Optional x2: Numberish

Inherited from ​

Omit.x2

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1176

xChannelSelector ​

• Optional xChannelSelector: string

Inherited from ​

Omit.xChannelSelector

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1178

xlinkActuate ​

• Optional xlinkActuate: string

Inherited from ​

Omit.xlinkActuate

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1180

xlinkArcrole ​

• Optional xlinkArcrole: string

Inherited from ​

Omit.xlinkArcrole

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1181

xlinkHref ​

• Optional xlinkHref: string

Inherited from ​

Omit.xlinkHref

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1182

xlinkRole ​

• Optional xlinkRole: string

Inherited from ​

Omit.xlinkRole

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1183

xlinkShow ​

• Optional xlinkShow: string

Inherited from ​

Omit.xlinkShow

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1184

xlinkTitle ​

• Optional xlinkTitle: string

Inherited from ​

Omit.xlinkTitle

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1185

xlinkType ​

• Optional xlinkType: string

Inherited from ​

Omit.xlinkType

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1186

xmlns ​

• Optional xmlns: string

Inherited from ​

Omit.xmlns

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1187

y ​

• Optional y: Numberish

Inherited from ​

Omit.y

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1190

y1 ​

• Optional y1: Numberish

Inherited from ​

Omit.y1

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1188

y2 ​

• Optional y2: Numberish

Inherited from ​

Omit.y2

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1189

yChannelSelector ​

• Optional yChannelSelector: string

Inherited from ​

Omit.yChannelSelector

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1191

z ​

• Optional z: Numberish

Inherited from ​

Omit.z

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1192

zoomAndPan ​

• Optional zoomAndPan: string

Inherited from ​

Omit.zoomAndPan

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1193

- diff --git a/api/interfaces/features/boards/board.BoardOptions.html b/api/interfaces/features/boards/board.BoardOptions.html index 4178916b..6ed28114 100644 --- a/api/interfaces/features/boards/board.BoardOptions.html +++ b/api/interfaces/features/boards/board.BoardOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BoardOptions ​

features/boards/board.BoardOptions

An object that configures a Board.

Properties ​

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Defined in ​

profectus/src/features/boards/board.ts:224

height ​

• Optional height: Computable<string>

The height of the board. Defaults to 100%

Defined in ​

profectus/src/features/boards/board.ts:220

• Optional links: Computable<null | BoardNodeLink[]>

An array of board node links to display.

Defined in ​

profectus/src/features/boards/board.ts:234

startNodes ​

• startNodes: () => Omit<BoardNode, "id">[]

Type declaration ​

â–¸ (): Omit<BoardNode, "id">[]

A function that returns an array of initial board nodes, without IDs.

Returns ​

Omit<BoardNode, "id">[]

Defined in ​

profectus/src/features/boards/board.ts:228

state ​

• Optional state: Computable<BoardData>

The persistent state of the board.

Defined in ​

profectus/src/features/boards/board.ts:232

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Defined in ​

profectus/src/features/boards/board.ts:226

types ​

• types: Record<string, NodeTypeOptions>

A dictionary of node types that can appear on the board.

Defined in ​

profectus/src/features/boards/board.ts:230

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this board should be visible.

Defined in ​

profectus/src/features/boards/board.ts:218

width ​

• Optional width: Computable<string>

The width of the board. Defaults to 100%

Defined in ​

profectus/src/features/boards/board.ts:222

- diff --git a/api/interfaces/features/boards/board.NodeLabel.html b/api/interfaces/features/boards/board.NodeLabel.html index 3424b560..8c9ee4bf 100644 --- a/api/interfaces/features/boards/board.NodeLabel.html +++ b/api/interfaces/features/boards/board.NodeLabel.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: NodeLabel ​

features/boards/board.NodeLabel

An object representing a label for a node.

Properties ​

color ​

• Optional color: string

Defined in ​

profectus/src/features/boards/board.ts:72

pulsing ​

• Optional pulsing: boolean

Defined in ​

profectus/src/features/boards/board.ts:73

text ​

• text: string

Defined in ​

profectus/src/features/boards/board.ts:71

- diff --git a/api/interfaces/features/boards/board.NodeTypeOptions.html b/api/interfaces/features/boards/board.NodeTypeOptions.html index 9ed04c11..ca7bbd31 100644 --- a/api/interfaces/features/boards/board.NodeTypeOptions.html +++ b/api/interfaces/features/boards/board.NodeTypeOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: NodeTypeOptions ​

features/boards/board.NodeTypeOptions

An object that configures a NodeType.

Properties ​

actionDistance ​

• Optional actionDistance: NodeComputable<number>

The distance between the center of the node and its actions.

Defined in ​

profectus/src/features/boards/board.ts:114

actions ​

• Optional actions: BoardNodeActionOptions[]

The list of action options for the node.

Defined in ​

profectus/src/features/boards/board.ts:112

canAccept ​

• Optional canAccept: boolean | Ref<boolean> | (node: BoardNode, otherNode: BoardNode) => boolean

Whether the node can accept another node being dropped upon it.

Defined in ​

profectus/src/features/boards/board.ts:98

draggable ​

• Optional draggable: NodeComputable<boolean>

Whether the node is draggable or not.

Defined in ​

profectus/src/features/boards/board.ts:94

fillColor ​

• Optional fillColor: NodeComputable<string>

The fill color of the node.

Defined in ​

profectus/src/features/boards/board.ts:106

label ​

• Optional label: NodeComputable<null | NodeLabel>

An optional label for the node.

Defined in ​

profectus/src/features/boards/board.ts:90

onClick ​

• Optional onClick: (node: BoardNode) => void

Type declaration ​

â–¸ (node): void

A function that is called when the node is clicked.

Parameters ​
NameType
nodeBoardNode
Returns ​

void

Defined in ​

profectus/src/features/boards/board.ts:116

onDrop ​

• Optional onDrop: (node: BoardNode, otherNode: BoardNode) => void

Type declaration ​

â–¸ (node, otherNode): void

A function that is called when a node is dropped onto this node.

Parameters ​
NameType
nodeBoardNode
otherNodeBoardNode
Returns ​

void

Defined in ​

profectus/src/features/boards/board.ts:118

outlineColor ​

• Optional outlineColor: NodeComputable<string>

The outline color of the node.

Defined in ​

profectus/src/features/boards/board.ts:108

progress ​

• Optional progress: NodeComputable<number>

The progress value of the node.

Defined in ​

profectus/src/features/boards/board.ts:100

progressColor ​

• Optional progressColor: NodeComputable<string>

The color of the progress indicator.

Defined in ​

profectus/src/features/boards/board.ts:104

progressDisplay ​

• Optional progressDisplay: NodeComputable<ProgressDisplay>

How the progress should be displayed on the node.

Defined in ​

profectus/src/features/boards/board.ts:102

shape ​

• shape: NodeComputable<Shape>

The shape of the node.

Defined in ​

profectus/src/features/boards/board.ts:96

size ​

• size: NodeComputable<number>

The size of the node - diameter for circles, width and height for squares.

Defined in ​

profectus/src/features/boards/board.ts:92

title ​

• title: NodeComputable<string>

The title to display for the node.

Defined in ​

profectus/src/features/boards/board.ts:88

titleColor ​

• Optional titleColor: NodeComputable<string>

The color of the title text.

Defined in ​

profectus/src/features/boards/board.ts:110

update ​

• Optional update: (node: BoardNode, diff: number) => void

Type declaration ​

â–¸ (node, diff): void

A function that is called for each node of this type every tick.

Parameters ​
NameType
nodeBoardNode
diffnumber
Returns ​

void

Defined in ​

profectus/src/features/boards/board.ts:120

- diff --git a/api/interfaces/features/challenges/challenge.BaseChallenge.html b/api/interfaces/features/challenges/challenge.BaseChallenge.html index 163ffccb..aef39947 100644 --- a/api/interfaces/features/challenges/challenge.BaseChallenge.html +++ b/api/interfaces/features/challenges/challenge.BaseChallenge.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseChallenge ​

features/challenges/challenge.BaseChallenge

The properties that are added onto a processed ChallengeOptions to create a Challenge.

Properties ​

[Component] ​

• [Component]: GenericComponent

The Vue component used to render this feature.

Defined in ​

profectus/src/features/challenges/challenge.tsx:114

[GatherProps] ​

• [GatherProps]: () => Record<string, unknown>

Type declaration ​

â–¸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns ​

Record<string, unknown>

Defined in ​

profectus/src/features/challenges/challenge.tsx:116

active ​

• active: Persistent<boolean>

Whether or not this challenge is currently active.

Defined in ​

profectus/src/features/challenges/challenge.tsx:103

canComplete ​

• canComplete: Ref<DecimalSource>

The current amount of times this challenge can be completed.

Defined in ​

profectus/src/features/challenges/challenge.tsx:95

complete ​

• complete: (remainInChallenge?: boolean) => void

Type declaration ​

â–¸ (remainInChallenge?): void

A function to complete this challenge.

Parameters ​
NameTypeDescription
remainInChallenge?booleanOptional parameter to specify if the challenge should remain active after completion.
Returns ​

void

Defined in ​

profectus/src/features/challenges/challenge.tsx:110

completed ​

• completed: Ref<boolean>

Whether or not this challenge has been completed.

Defined in ​

profectus/src/features/challenges/challenge.tsx:99

completions ​

• completions: Persistent<DecimalSource>

The current number of times this challenge has been completed.

Defined in ​

profectus/src/features/challenges/challenge.tsx:97

id ​

• id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Defined in ​

profectus/src/features/challenges/challenge.tsx:93

maxed ​

• maxed: Ref<boolean>

Whether or not this challenge's completion count is at its limit.

Defined in ​

profectus/src/features/challenges/challenge.tsx:101

toggle ​

• toggle: VoidFunction

A function to enter or leave the challenge.

Defined in ​

profectus/src/features/challenges/challenge.tsx:105

type ​

• type: typeof ChallengeType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/challenges/challenge.tsx:112

- diff --git a/api/interfaces/features/challenges/challenge.ChallengeOptions.html b/api/interfaces/features/challenges/challenge.ChallengeOptions.html index 9db9a457..56141cfe 100644 --- a/api/interfaces/features/challenges/challenge.ChallengeOptions.html +++ b/api/interfaces/features/challenges/challenge.ChallengeOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: ChallengeOptions ​

features/challenges/challenge.ChallengeOptions

An object that configures a Challenge.

Properties ​

canStart ​

• Optional canStart: Computable<boolean>

Whether this challenge can be started.

Defined in ​

profectus/src/features/challenges/challenge.tsx:49

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Defined in ​

profectus/src/features/challenges/challenge.tsx:61

completionLimit ​

• Optional completionLimit: Computable<DecimalSource>

The maximum number of times the challenge can be completed.

Defined in ​

profectus/src/features/challenges/challenge.tsx:57

display ​

• Optional display: Computable<CoercableComponent | { description: CoercableComponent ; effectDisplay?: CoercableComponent ; goal?: CoercableComponent ; reward?: CoercableComponent ; title?: CoercableComponent }>

The display to use for this challenge.

Defined in ​

profectus/src/features/challenges/challenge.tsx:65

mark ​

• Optional mark: Computable<string | boolean>

Shows a marker on the corner of the feature.

Defined in ​

profectus/src/features/challenges/challenge.tsx:59

maximize ​

• Optional maximize: Computable<boolean>

Whether or not completing this challenge should grant multiple completions if requirements met. Requires requirements to be a requirement or array of requirements with Requirement.canMaximize true.

Defined in ​

profectus/src/features/challenges/challenge.tsx:55

onComplete ​

• Optional onComplete: VoidFunction

A function that is called when the challenge is completed.

Defined in ​

profectus/src/features/challenges/challenge.tsx:81

onEnter ​

• Optional onEnter: VoidFunction

A function that is called when the challenge is entered.

Defined in ​

profectus/src/features/challenges/challenge.tsx:85

onExit ​

• Optional onExit: VoidFunction

A function that is called when the challenge is exited.

Defined in ​

profectus/src/features/challenges/challenge.tsx:83

requirements ​

• requirements: Requirements

The requirement(s) to complete this challenge.

Defined in ​

profectus/src/features/challenges/challenge.tsx:53

reset ​

• Optional reset: GenericReset

The reset function for this challenge.

Defined in ​

profectus/src/features/challenges/challenge.tsx:51

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Defined in ​

profectus/src/features/challenges/challenge.tsx:63

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this challenge should be visible.

Defined in ​

profectus/src/features/challenges/challenge.tsx:47

- diff --git a/api/interfaces/features/clickables/clickable.BaseClickable.html b/api/interfaces/features/clickables/clickable.BaseClickable.html index a9def6b4..b3a5149e 100644 --- a/api/interfaces/features/clickables/clickable.BaseClickable.html +++ b/api/interfaces/features/clickables/clickable.BaseClickable.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseClickable ​

features/clickables/clickable.BaseClickable

The properties that are added onto a processed ClickableOptions to create an Clickable.

Properties ​

[Component] ​

• [Component]: GenericComponent

The Vue component used to render this feature.

Defined in ​

profectus/src/features/clickables/clickable.ts:66

[GatherProps] ​

• [GatherProps]: () => Record<string, unknown>

Type declaration ​

â–¸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns ​

Record<string, unknown>

Defined in ​

profectus/src/features/clickables/clickable.ts:68

id ​

• id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Defined in ​

profectus/src/features/clickables/clickable.ts:62

type ​

• type: typeof ClickableType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/clickables/clickable.ts:64

- diff --git a/api/interfaces/features/clickables/clickable.ClickableOptions.html b/api/interfaces/features/clickables/clickable.ClickableOptions.html index ec0777d8..9fd09bf8 100644 --- a/api/interfaces/features/clickables/clickable.ClickableOptions.html +++ b/api/interfaces/features/clickables/clickable.ClickableOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: ClickableOptions ​

features/clickables/clickable.ClickableOptions

An object that configures a Clickable.

Hierarchy ​

Properties ​

canClick ​

• Optional canClick: Computable<boolean>

Whether or not the clickable may be clicked.

Defined in ​

profectus/src/features/clickables/clickable.ts:32

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Defined in ​

profectus/src/features/clickables/clickable.ts:34

display ​

• Optional display: Computable<CoercableComponent | { description: CoercableComponent ; title?: CoercableComponent }>

The display to use for this clickable.

Defined in ​

profectus/src/features/clickables/clickable.ts:40

mark ​

• Optional mark: Computable<string | boolean>

Shows a marker on the corner of the feature.

Defined in ​

profectus/src/features/clickables/clickable.ts:38

onClick ​

• Optional onClick: (e?: MouseEvent | TouchEvent) => void

Type declaration ​

â–¸ (e?): void

A function that is called when the clickable is clicked.

Parameters ​
NameType
e?MouseEvent | TouchEvent
Returns ​

void

Defined in ​

profectus/src/features/clickables/clickable.ts:52

onHold ​

• Optional onHold: VoidFunction

A function that is called when the clickable is held down.

Defined in ​

profectus/src/features/clickables/clickable.ts:54

small ​

• Optional small: boolean

Toggles a smaller design for the feature.

Defined in ​

profectus/src/features/clickables/clickable.ts:50

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Defined in ​

profectus/src/features/clickables/clickable.ts:36

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this clickable should be visible.

Defined in ​

profectus/src/features/clickables/clickable.ts:30

- diff --git a/api/interfaces/features/conversion.BaseConversion.html b/api/interfaces/features/conversion.BaseConversion.html index fcdca754..4e8157b5 100644 --- a/api/interfaces/features/conversion.BaseConversion.html +++ b/api/interfaces/features/conversion.BaseConversion.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseConversion ​

features/conversion.BaseConversion

The properties that are added onto a processed ConversionOptions to create a Conversion.

Properties ​

convert ​

• convert: VoidFunction

The function that performs the actual conversion.

Defined in ​

profectus/src/features/conversion.ts:88

- diff --git a/api/interfaces/features/conversion.ConversionOptions.html b/api/interfaces/features/conversion.ConversionOptions.html index 313f5e9c..3da6875b 100644 --- a/api/interfaces/features/conversion.ConversionOptions.html +++ b/api/interfaces/features/conversion.ConversionOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: ConversionOptions ​

features/conversion.ConversionOptions

An object that configures a Conversion.

Properties ​

actualGain ​

• Optional actualGain: Computable<DecimalSource>

The absolute amount the output resource will be changed by. Typically this will be set for you in a conversion constructor. This will differ from currentGain in the cases where the conversion isn't just adding the converted amount to the output resource.

Defined in ​

profectus/src/features/conversion.ts:38

baseResource ​

• baseResource: Resource<DecimalSource>

The input Resource for this conversion.

Defined in ​

profectus/src/features/conversion.ts:53

buyMax ​

• Optional buyMax: Computable<boolean>

Whether or not to cap the amount of the output resource gained by converting at 1. Defaults to true.

Defined in ​

profectus/src/features/conversion.ts:62

convert ​

• Optional convert: VoidFunction

The function that performs the actual conversion from baseResource to gainResource. Typically this will be set for you in a conversion constructor.

Defined in ​

profectus/src/features/conversion.ts:67

currentAt ​

• Optional currentAt: Computable<DecimalSource>

The amount of the input resource currently being required in order to produce the currentGain. That is, if it went below this value then currentGain would decrease. Typically this will be set for you in a conversion constructor.

Defined in ​

profectus/src/features/conversion.ts:44

currentGain ​

• Optional currentGain: Computable<DecimalSource>

How much of the output resource the conversion can currently convert for. Typically this will be set for you in a conversion constructor.

Defined in ​

profectus/src/features/conversion.ts:32

formula ​

• formula: (variable: GenericFormula & { invert: (value: DecimalSource) => DecimalSource } & { evaluateIntegral: (variable?: DecimalSource) => DecimalSource } & { invertIntegral: (value: DecimalSource) => DecimalSource }) => InvertibleFormula

Type declaration ​

â–¸ (variable): InvertibleFormula

The formula used to determine how much gainResource should be earned by this converting. The passed value will be a Formula representing the baseResource variable.

Parameters ​
NameType
variableGenericFormula & { invert: (value: DecimalSource) => DecimalSource } & { evaluateIntegral: (variable?: DecimalSource) => DecimalSource } & { invertIntegral: (value: DecimalSource) => DecimalSource }
Returns ​

InvertibleFormula

Defined in ​

profectus/src/features/conversion.ts:25

gainResource ​

• gainResource: Resource<DecimalSource>

The output Resource for this conversion. i.e. the resource being generated.

Defined in ​

profectus/src/features/conversion.ts:57

nextAt ​

• Optional nextAt: Computable<DecimalSource>

The amount of the input resource required to make currentGain increase. Typically this will be set for you in a conversion constructor.

Defined in ​

profectus/src/features/conversion.ts:49

onConvert ​

• Optional onConvert: (amountGained: DecimalSource) => void

Type declaration ​

â–¸ (amountGained): void

A callback that happens after a conversion has been completed. Receives the amount gained via conversion. This will not be called whenever using currentGain without calling convert (e.g. passive generation)

Parameters ​
NameType
amountGainedDecimalSource
Returns ​

void

Defined in ​

profectus/src/features/conversion.ts:78

spend ​

• Optional spend: (amountGained: DecimalSource) => void

Type declaration ​

â–¸ (amountGained): void

The function that spends the baseResource as part of the conversion. Defaults to setting the baseResource amount to 0.

Parameters ​
NameType
amountGainedDecimalSource
Returns ​

void

Defined in ​

profectus/src/features/conversion.ts:72

- diff --git a/api/interfaces/features/grids/grid.BaseGrid.html b/api/interfaces/features/grids/grid.BaseGrid.html index 5276b1a7..49e74acb 100644 --- a/api/interfaces/features/grids/grid.BaseGrid.html +++ b/api/interfaces/features/grids/grid.BaseGrid.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseGrid ​

features/grids/grid.BaseGrid

The properties that are added onto a processed BoardOptions to create a Board.

Properties ​

[Component] ​

• [Component]: GenericComponent

The Vue component used to render this feature.

Defined in ​

profectus/src/features/grids/grid.ts:270

[GatherProps] ​

• [GatherProps]: () => Record<string, unknown>

Type declaration ​

â–¸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns ​

Record<string, unknown>

Defined in ​

profectus/src/features/grids/grid.ts:272

cellState ​

• cellState: Persistent<Record<string | number, State>>

The persistent state of this grid, which is a dictionary of cell states.

Defined in ​

profectus/src/features/grids/grid.ts:266

cells ​

• cells: Record<string | number, GridCell>

A dictionary of cells within this grid.

Defined in ​

profectus/src/features/grids/grid.ts:264

getID ​

• getID: (id: string | number, state: State) => string

Type declaration ​

â–¸ (id, state): string

Get the auto-generated ID for identifying a specific cell of this grid that appears in the DOM. Will not persist between refreshes or updates.

Parameters ​
NameType
idstring | number
stateState
Returns ​

string

Defined in ​

profectus/src/features/grids/grid.ts:258

getState ​

• getState: (id: string | number) => State

Type declaration ​

â–¸ (id): State

Get the persistent state of the given cell.

Parameters ​
NameType
idstring | number
Returns ​

State

Defined in ​

profectus/src/features/grids/grid.ts:260

id ​

• id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Defined in ​

profectus/src/features/grids/grid.ts:256

setState ​

• setState: (id: string | number, state: State) => void

Type declaration ​

â–¸ (id, state): void

Set the persistent state of the given cell.

Parameters ​
NameType
idstring | number
stateState
Returns ​

void

Defined in ​

profectus/src/features/grids/grid.ts:262

type ​

• type: typeof GridType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/grids/grid.ts:268

- diff --git a/api/interfaces/features/grids/grid.GridCell.html b/api/interfaces/features/grids/grid.GridCell.html index c5b2acd9..5134462d 100644 --- a/api/interfaces/features/grids/grid.GridCell.html +++ b/api/interfaces/features/grids/grid.GridCell.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: GridCell ​

features/grids/grid.GridCell

Represents a cell within a grid. These properties will typically be accessed via a cell proxy that calls functions on the grid to get the properties for a specific cell.

See

createGridProxy

Properties ​

canClick ​

• canClick: boolean

Whether this cell can be clicked.

Defined in ​

profectus/src/features/grids/grid.ts:202

classes ​

• Optional classes: Record<string, boolean>

Dictionary of CSS classes to apply to this feature.

Defined in ​

profectus/src/features/grids/grid.ts:210

display ​

• display: CoercableComponent

The main text that appears in the display.

Defined in ​

profectus/src/features/grids/grid.ts:214

id ​

• id: string

A unique identifier for the grid cell.

Defined in ​

profectus/src/features/grids/grid.ts:198

onClick ​

• Optional onClick: (e?: MouseEvent | TouchEvent) => void

Type declaration ​

â–¸ (e?): void

A function that is called when the cell is clicked.

Parameters ​
NameType
e?MouseEvent | TouchEvent
Returns ​

void

Defined in ​

profectus/src/features/grids/grid.ts:216

onHold ​

• Optional onHold: VoidFunction

A function that is called when the cell is held down.

Defined in ​

profectus/src/features/grids/grid.ts:218

startState ​

• startState: State

The initial persistent state of this cell.

Defined in ​

profectus/src/features/grids/grid.ts:204

state ​

• state: State

The persistent state of this cell.

Defined in ​

profectus/src/features/grids/grid.ts:206

style ​

• Optional style: StyleValue

CSS to apply to this feature.

Defined in ​

profectus/src/features/grids/grid.ts:208

title ​

• Optional title: CoercableComponent

A header to appear at the top of the display.

Defined in ​

profectus/src/features/grids/grid.ts:212

visibility ​

• visibility: boolean | Visibility

Whether this cell should be visible.

Defined in ​

profectus/src/features/grids/grid.ts:200

- diff --git a/api/interfaces/features/grids/grid.GridOptions.html b/api/interfaces/features/grids/grid.GridOptions.html index 0123f9fa..390a9d9b 100644 --- a/api/interfaces/features/grids/grid.GridOptions.html +++ b/api/interfaces/features/grids/grid.GridOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: GridOptions ​

features/grids/grid.GridOptions

An object that configures a Grid.

Properties ​

cols ​

• cols: Computable<number>

The number of columns in the grid.

Defined in ​

profectus/src/features/grids/grid.ts:230

getCanClick ​

• Optional getCanClick: CellComputable<boolean>

A computable to determine if a cell can be clicked.

Defined in ​

profectus/src/features/grids/grid.ts:234

getClasses ​

• Optional getClasses: CellComputable<Record<string, boolean>>

A computable to get the CSS classes for a cell.

Defined in ​

profectus/src/features/grids/grid.ts:240

getDisplay ​

• getDisplay: CellComputable<CoercableComponent>

A computable to get the display component for a cell.

Defined in ​

profectus/src/features/grids/grid.ts:244

getStartState ​

• getStartState: Computable<State> | (id: string | number) => State

A computable to get the initial persistent state of a cell.

Defined in ​

profectus/src/features/grids/grid.ts:236

getStyle ​

• Optional getStyle: CellComputable<StyleValue>

A computable to get the CSS styles for a cell.

Defined in ​

profectus/src/features/grids/grid.ts:238

getTitle ​

• Optional getTitle: CellComputable<CoercableComponent>

A computable to get the title component for a cell.

Defined in ​

profectus/src/features/grids/grid.ts:242

getVisibility ​

• Optional getVisibility: CellComputable<boolean | Visibility>

A computable to determine the visibility of a cell.

Defined in ​

profectus/src/features/grids/grid.ts:232

onClick ​

• Optional onClick: (id: string | number, state: State, e?: MouseEvent | TouchEvent) => void

Type declaration ​

â–¸ (id, state, e?): void

A function that is called when a cell is clicked.

Parameters ​
NameType
idstring | number
stateState
e?MouseEvent | TouchEvent
Returns ​

void

Defined in ​

profectus/src/features/grids/grid.ts:246

onHold ​

• Optional onHold: (id: string | number, state: State) => void

Type declaration ​

â–¸ (id, state): void

A function that is called when a cell is held down.

Parameters ​
NameType
idstring | number
stateState
Returns ​

void

Defined in ​

profectus/src/features/grids/grid.ts:248

rows ​

• rows: Computable<number>

The number of rows in the grid.

Defined in ​

profectus/src/features/grids/grid.ts:228

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this grid should be visible.

Defined in ​

profectus/src/features/grids/grid.ts:226

- diff --git a/api/interfaces/features/hotkey.BaseHotkey.html b/api/interfaces/features/hotkey.BaseHotkey.html index cbe00eb0..ff6f9ad9 100644 --- a/api/interfaces/features/hotkey.BaseHotkey.html +++ b/api/interfaces/features/hotkey.BaseHotkey.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseHotkey ​

features/hotkey.BaseHotkey

The properties that are added onto a processed HotkeyOptions to create an Hotkey.

Properties ​

type ​

• type: typeof HotkeyType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/hotkey.tsx:42

- diff --git a/api/interfaces/features/hotkey.HotkeyOptions.html b/api/interfaces/features/hotkey.HotkeyOptions.html index 3d43d8d2..c924478f 100644 --- a/api/interfaces/features/hotkey.HotkeyOptions.html +++ b/api/interfaces/features/hotkey.HotkeyOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: HotkeyOptions ​

features/hotkey.HotkeyOptions

An object that configures a Hotkey.

Properties ​

description ​

• description: Computable<string>

The description of this hotkey, to display in the settings.

Defined in ​

profectus/src/features/hotkey.tsx:32

enabled ​

• Optional enabled: Computable<boolean>

Whether or not this hotkey is currently enabled.

Defined in ​

profectus/src/features/hotkey.tsx:28

key ​

• key: string

The key tied to this hotkey

Defined in ​

profectus/src/features/hotkey.tsx:30

onPress ​

• onPress: VoidFunction

What to do upon pressing the key.

Defined in ​

profectus/src/features/hotkey.tsx:34

- diff --git a/api/interfaces/features/infoboxes/infobox.BaseInfobox.html b/api/interfaces/features/infoboxes/infobox.BaseInfobox.html index 93a0bbe5..42621044 100644 --- a/api/interfaces/features/infoboxes/infobox.BaseInfobox.html +++ b/api/interfaces/features/infoboxes/infobox.BaseInfobox.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseInfobox ​

features/infoboxes/infobox.BaseInfobox

The properties that are added onto a processed InfoboxOptions to create an Infobox.

Properties ​

[Component] ​

• [Component]: GenericComponent

The Vue component used to render this feature.

Defined in ​

profectus/src/features/infoboxes/infobox.ts:58

[GatherProps] ​

• [GatherProps]: () => Record<string, unknown>

Type declaration ​

â–¸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns ​

Record<string, unknown>

Defined in ​

profectus/src/features/infoboxes/infobox.ts:60

collapsed ​

• collapsed: Persistent<boolean>

Whether or not this infobox is collapsed.

Defined in ​

profectus/src/features/infoboxes/infobox.ts:54

id ​

• id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Defined in ​

profectus/src/features/infoboxes/infobox.ts:52

type ​

• type: typeof InfoboxType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/infoboxes/infobox.ts:56

- diff --git a/api/interfaces/features/infoboxes/infobox.InfoboxOptions.html b/api/interfaces/features/infoboxes/infobox.InfoboxOptions.html index 240dd885..7e23fb46 100644 --- a/api/interfaces/features/infoboxes/infobox.InfoboxOptions.html +++ b/api/interfaces/features/infoboxes/infobox.InfoboxOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: InfoboxOptions ​

features/infoboxes/infobox.InfoboxOptions

An object that configures an Infobox.

Properties ​

bodyStyle ​

• Optional bodyStyle: Computable<StyleValue>

CSS to apply to the body of the infobox.

Defined in ​

profectus/src/features/infoboxes/infobox.ts:38

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Defined in ​

profectus/src/features/infoboxes/infobox.ts:40

color ​

• Optional color: Computable<string>

The background color of the Infobox.

Defined in ​

profectus/src/features/infoboxes/infobox.ts:32

display ​

• display: Computable<CoercableComponent>

The main text that appears in the display.

Defined in ​

profectus/src/features/infoboxes/infobox.ts:44

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Defined in ​

profectus/src/features/infoboxes/infobox.ts:34

title ​

• title: Computable<CoercableComponent>

A header to appear at the top of the display.

Defined in ​

profectus/src/features/infoboxes/infobox.ts:42

titleStyle ​

• Optional titleStyle: Computable<StyleValue>

CSS to apply to the title of the infobox.

Defined in ​

profectus/src/features/infoboxes/infobox.ts:36

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this clickable should be visible.

Defined in ​

profectus/src/features/infoboxes/infobox.ts:30

- diff --git a/api/interfaces/features/links/links.BaseLinks.html b/api/interfaces/features/links/links.BaseLinks.html index d6cbc595..c1dd8723 100644 --- a/api/interfaces/features/links/links.BaseLinks.html +++ b/api/interfaces/features/links/links.BaseLinks.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseLinks ​

features/links/links.BaseLinks

The properties that are added onto a processed LinksOptions to create an Links.

Properties ​

[Component] ​

• [Component]: GenericComponent

The Vue component used to render this feature.

Defined in ​

profectus/src/features/links/links.ts:34

[GatherProps] ​

• [GatherProps]: () => Record<string, unknown>

Type declaration ​

â–¸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns ​

Record<string, unknown>

Defined in ​

profectus/src/features/links/links.ts:36

type ​

• type: typeof LinksType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/links/links.ts:32

- diff --git a/api/interfaces/features/links/links.Link.html b/api/interfaces/features/links/links.Link.html index fc3dcda4..48b6e862 100644 --- a/api/interfaces/features/links/links.Link.html +++ b/api/interfaces/features/links/links.Link.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: Link ​

features/links/links.Link

Represents a link between two nodes. It will be displayed as an SVG line, and can take any appropriate properties for an SVG line element.

Hierarchy ​

  • SVGAttributes

    ↳ Link

Properties ​

accent-height ​

• Optional accent-height: Numberish

Inherited from ​

SVGAttributes.accent-height

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:945

accumulate ​

• Optional accumulate: "none" | "sum"

Inherited from ​

SVGAttributes.accumulate

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:946

additive ​

• Optional additive: "sum" | "replace"

Inherited from ​

SVGAttributes.additive

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:947

alignment-baseline ​

• Optional alignment-baseline: "alphabetic" | "hanging" | "ideographic" | "mathematical" | "auto" | "baseline" | "before-edge" | "text-before-edge" | "middle" | "central" | "after-edge" | "text-after-edge" | "inherit"

Inherited from ​

SVGAttributes.alignment-baseline

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:948

allowReorder ​

• Optional allowReorder: "no" | "yes"

Inherited from ​

SVGAttributes.allowReorder

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:962

alphabetic ​

• Optional alphabetic: Numberish

Inherited from ​

SVGAttributes.alphabetic

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:963

amplitude ​

• Optional amplitude: Numberish

Inherited from ​

SVGAttributes.amplitude

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:964

arabic-form ​

• Optional arabic-form: "initial" | "medial" | "terminal" | "isolated"

Inherited from ​

SVGAttributes.arabic-form

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:965

aria-activedescendant ​

• Optional aria-activedescendant: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

Inherited from ​

SVGAttributes.aria-activedescendant

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:224

aria-atomic ​

• Optional aria-atomic: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

Inherited from ​

SVGAttributes.aria-atomic

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:226

aria-autocomplete ​

• Optional aria-autocomplete: "none" | "inline" | "list" | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

Inherited from ​

SVGAttributes.aria-autocomplete

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:231

aria-busy ​

• Optional aria-busy: Booleanish

Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

Inherited from ​

SVGAttributes.aria-busy

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:233

aria-checked ​

• Optional aria-checked: Booleanish | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

See

  • aria-pressed
  • aria-selected.

Inherited from ​

SVGAttributes.aria-checked

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:238

aria-colcount ​

• Optional aria-colcount: Numberish

Defines the total number of columns in a table, grid, or treegrid.

See

aria-colindex.

Inherited from ​

SVGAttributes.aria-colcount

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:243

aria-colindex ​

• Optional aria-colindex: Numberish

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

See

  • aria-colcount
  • aria-colspan.

Inherited from ​

SVGAttributes.aria-colindex

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:248

aria-colspan ​

• Optional aria-colspan: Numberish

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

See

  • aria-colindex
  • aria-rowspan.

Inherited from ​

SVGAttributes.aria-colspan

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:253

aria-controls ​

• Optional aria-controls: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

See

aria-owns.

Inherited from ​

SVGAttributes.aria-controls

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:258

aria-current ​

• Optional aria-current: "time" | Booleanish | "page" | "step" | "location" | "date"

Indicates the element that represents the current item within a container or set of related elements.

Inherited from ​

SVGAttributes.aria-current

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:260

aria-describedby ​

• Optional aria-describedby: string

Identifies the element (or elements) that describes the object.

See

aria-labelledby

Inherited from ​

SVGAttributes.aria-describedby

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:265

aria-details ​

• Optional aria-details: string

Identifies the element that provides a detailed, extended description for the object.

See

aria-describedby.

Inherited from ​

SVGAttributes.aria-details

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:270

aria-disabled ​

• Optional aria-disabled: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

See

  • aria-hidden
  • aria-readonly.

Inherited from ​

SVGAttributes.aria-disabled

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:275

aria-dropeffect ​

• Optional aria-dropeffect: "none" | "copy" | "execute" | "link" | "move" | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.

Deprecated

in ARIA 1.1

Inherited from ​

SVGAttributes.aria-dropeffect

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:280

aria-errormessage ​

• Optional aria-errormessage: string

Identifies the element that provides an error message for the object.

See

  • aria-invalid
  • aria-describedby.

Inherited from ​

SVGAttributes.aria-errormessage

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:285

aria-expanded ​

• Optional aria-expanded: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

Inherited from ​

SVGAttributes.aria-expanded

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:287

aria-flowto ​

• Optional aria-flowto: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

Inherited from ​

SVGAttributes.aria-flowto

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:292

aria-grabbed ​

• Optional aria-grabbed: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

Deprecated

in ARIA 1.1

Inherited from ​

SVGAttributes.aria-grabbed

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:297

aria-haspopup ​

• Optional aria-haspopup: "tree" | Booleanish | "menu" | "listbox" | "grid" | "dialog"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

Inherited from ​

SVGAttributes.aria-haspopup

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:299

aria-hidden ​

• Optional aria-hidden: Booleanish

Indicates whether the element is exposed to an accessibility API.

See

aria-disabled.

Inherited from ​

SVGAttributes.aria-hidden

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:304

aria-invalid ​

• Optional aria-invalid: Booleanish | "grammar" | "spelling"

Indicates the entered value does not conform to the format expected by the application.

See

aria-errormessage.

Inherited from ​

SVGAttributes.aria-invalid

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:309

aria-keyshortcuts ​

• Optional aria-keyshortcuts: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

Inherited from ​

SVGAttributes.aria-keyshortcuts

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:311

aria-label ​

• Optional aria-label: string

Defines a string value that labels the current element.

See

aria-labelledby.

Inherited from ​

SVGAttributes.aria-label

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:316

aria-labelledby ​

• Optional aria-labelledby: string

Identifies the element (or elements) that labels the current element.

See

aria-describedby.

Inherited from ​

SVGAttributes.aria-labelledby

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:321

aria-level ​

• Optional aria-level: Numberish

Defines the hierarchical level of an element within a structure.

Inherited from ​

SVGAttributes.aria-level

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:323

aria-live ​

• Optional aria-live: "off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

Inherited from ​

SVGAttributes.aria-live

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:325

aria-modal ​

• Optional aria-modal: Booleanish

Indicates whether an element is modal when displayed.

Inherited from ​

SVGAttributes.aria-modal

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:327

aria-multiline ​

• Optional aria-multiline: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

Inherited from ​

SVGAttributes.aria-multiline

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:329

aria-multiselectable ​

• Optional aria-multiselectable: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

Inherited from ​

SVGAttributes.aria-multiselectable

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:331

aria-orientation ​

• Optional aria-orientation: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

Inherited from ​

SVGAttributes.aria-orientation

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:333

aria-owns ​

• Optional aria-owns: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

See

aria-controls.

Inherited from ​

SVGAttributes.aria-owns

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:339

aria-placeholder ​

• Optional aria-placeholder: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

Inherited from ​

SVGAttributes.aria-placeholder

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:344

aria-posinset ​

• Optional aria-posinset: Numberish

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-setsize.

Inherited from ​

SVGAttributes.aria-posinset

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:349

aria-pressed ​

• Optional aria-pressed: Booleanish | "mixed"

Indicates the current "pressed" state of toggle buttons.

See

  • aria-checked
  • aria-selected.

Inherited from ​

SVGAttributes.aria-pressed

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:354

aria-readonly ​

• Optional aria-readonly: Booleanish

Indicates that the element is not editable, but is otherwise operable.

See

aria-disabled.

Inherited from ​

SVGAttributes.aria-readonly

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:359

aria-relevant ​

• Optional aria-relevant: "additions" | "additions text" | "all" | "removals" | "text"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

See

aria-atomic.

Inherited from ​

SVGAttributes.aria-relevant

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:364

aria-required ​

• Optional aria-required: Booleanish

Indicates that user input is required on the element before a form may be submitted.

Inherited from ​

SVGAttributes.aria-required

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:366

aria-roledescription ​

• Optional aria-roledescription: string

Defines a human-readable, author-localized description for the role of an element.

Inherited from ​

SVGAttributes.aria-roledescription

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:368

aria-rowcount ​

• Optional aria-rowcount: Numberish

Defines the total number of rows in a table, grid, or treegrid.

See

aria-rowindex.

Inherited from ​

SVGAttributes.aria-rowcount

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:373

aria-rowindex ​

• Optional aria-rowindex: Numberish

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

See

  • aria-rowcount
  • aria-rowspan.

Inherited from ​

SVGAttributes.aria-rowindex

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:378

aria-rowspan ​

• Optional aria-rowspan: Numberish

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

See

  • aria-rowindex
  • aria-colspan.

Inherited from ​

SVGAttributes.aria-rowspan

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:383

aria-selected ​

• Optional aria-selected: Booleanish

Indicates the current "selected" state of various widgets.

See

  • aria-checked
  • aria-pressed.

Inherited from ​

SVGAttributes.aria-selected

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:388

aria-setsize ​

• Optional aria-setsize: Numberish

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-posinset.

Inherited from ​

SVGAttributes.aria-setsize

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:393

aria-sort ​

• Optional aria-sort: "none" | "ascending" | "descending" | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

Inherited from ​

SVGAttributes.aria-sort

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:395

aria-valuemax ​

• Optional aria-valuemax: Numberish

Defines the maximum allowed value for a range widget.

Inherited from ​

SVGAttributes.aria-valuemax

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:397

aria-valuemin ​

• Optional aria-valuemin: Numberish

Defines the minimum allowed value for a range widget.

Inherited from ​

SVGAttributes.aria-valuemin

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:399

aria-valuenow ​

• Optional aria-valuenow: Numberish

Defines the current value for a range widget.

See

aria-valuetext.

Inherited from ​

SVGAttributes.aria-valuenow

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:404

aria-valuetext ​

• Optional aria-valuetext: string

Defines the human readable text alternative of aria-valuenow for a range widget.

Inherited from ​

SVGAttributes.aria-valuetext

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:406

ascent ​

• Optional ascent: Numberish

Inherited from ​

SVGAttributes.ascent

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:966

attributeName ​

• Optional attributeName: string

Inherited from ​

SVGAttributes.attributeName

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:967

attributeType ​

• Optional attributeType: string

Inherited from ​

SVGAttributes.attributeType

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:968

autoReverse ​

• Optional autoReverse: Numberish

Inherited from ​

SVGAttributes.autoReverse

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:969

azimuth ​

• Optional azimuth: Numberish

Inherited from ​

SVGAttributes.azimuth

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:970

baseFrequency ​

• Optional baseFrequency: Numberish

Inherited from ​

SVGAttributes.baseFrequency

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:971

baseProfile ​

• Optional baseProfile: Numberish

Inherited from ​

SVGAttributes.baseProfile

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:973

baseline-shift ​

• Optional baseline-shift: Numberish

Inherited from ​

SVGAttributes.baseline-shift

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:972

bbox ​

• Optional bbox: Numberish

Inherited from ​

SVGAttributes.bbox

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:974

begin ​

• Optional begin: Numberish

Inherited from ​

SVGAttributes.begin

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:975

bias ​

• Optional bias: Numberish

Inherited from ​

SVGAttributes.bias

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:976

by ​

• Optional by: Numberish

Inherited from ​

SVGAttributes.by

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:977

calcMode ​

• Optional calcMode: Numberish

Inherited from ​

SVGAttributes.calcMode

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:978

cap-height ​

• Optional cap-height: Numberish

Inherited from ​

SVGAttributes.cap-height

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:979

class ​

• Optional class: any

SVG Styling Attributes

See

https://www.w3.org/TR/SVG/styling.html#ElementSpecificStyling

Inherited from ​

SVGAttributes.class

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:924

clip ​

• Optional clip: Numberish

Inherited from ​

SVGAttributes.clip

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:980

clip-path ​

• Optional clip-path: string

Inherited from ​

SVGAttributes.clip-path

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:981

clip-rule ​

• Optional clip-rule: Numberish

Inherited from ​

SVGAttributes.clip-rule

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:983

clipPathUnits ​

• Optional clipPathUnits: Numberish

Inherited from ​

SVGAttributes.clipPathUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:982

color ​

• Optional color: string

Inherited from ​

SVGAttributes.color

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:927

color-interpolation ​

• Optional color-interpolation: Numberish

Inherited from ​

SVGAttributes.color-interpolation

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:984

color-interpolation-filters ​

• Optional color-interpolation-filters: "auto" | "inherit" | "sRGB" | "linearRGB"

Inherited from ​

SVGAttributes.color-interpolation-filters

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:985

color-profile ​

• Optional color-profile: Numberish

Inherited from ​

SVGAttributes.color-profile

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:986

color-rendering ​

• Optional color-rendering: Numberish

Inherited from ​

SVGAttributes.color-rendering

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:987

contentScriptType ​

• Optional contentScriptType: Numberish

Inherited from ​

SVGAttributes.contentScriptType

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:988

contentStyleType ​

• Optional contentStyleType: Numberish

Inherited from ​

SVGAttributes.contentStyleType

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:989

cursor ​

• Optional cursor: Numberish

Inherited from ​

SVGAttributes.cursor

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:990

cx ​

• Optional cx: Numberish

Inherited from ​

SVGAttributes.cx

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:991

cy ​

• Optional cy: Numberish

Inherited from ​

SVGAttributes.cy

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:992

d ​

• Optional d: string

Inherited from ​

SVGAttributes.d

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:993

decelerate ​

• Optional decelerate: Numberish

Inherited from ​

SVGAttributes.decelerate

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:994

descent ​

• Optional descent: Numberish

Inherited from ​

SVGAttributes.descent

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:995

diffuseConstant ​

• Optional diffuseConstant: Numberish

Inherited from ​

SVGAttributes.diffuseConstant

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:996

direction ​

• Optional direction: Numberish

Inherited from ​

SVGAttributes.direction

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:997

display ​

• Optional display: Numberish

Inherited from ​

SVGAttributes.display

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:998

divisor ​

• Optional divisor: Numberish

Inherited from ​

SVGAttributes.divisor

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:999

dominant-baseline ​

• Optional dominant-baseline: Numberish

Inherited from ​

SVGAttributes.dominant-baseline

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1000

dur ​

• Optional dur: Numberish

Inherited from ​

SVGAttributes.dur

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1001

dx ​

• Optional dx: Numberish

Inherited from ​

SVGAttributes.dx

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1002

dy ​

• Optional dy: Numberish

Inherited from ​

SVGAttributes.dy

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1003

edgeMode ​

• Optional edgeMode: Numberish

Inherited from ​

SVGAttributes.edgeMode

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1004

elevation ​

• Optional elevation: Numberish

Inherited from ​

SVGAttributes.elevation

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1005

enable-background ​

• Optional enable-background: Numberish

Inherited from ​

SVGAttributes.enable-background

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1006

end ​

• Optional end: Numberish

Inherited from ​

SVGAttributes.end

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1007

endNode ​

• endNode: Object

Type declaration ​

NameType
idstring

Defined in ​

profectus/src/features/links/links.ts:16

exponent ​

• Optional exponent: Numberish

Inherited from ​

SVGAttributes.exponent

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1008

externalResourcesRequired ​

• Optional externalResourcesRequired: Numberish

Inherited from ​

SVGAttributes.externalResourcesRequired

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1009

fill ​

• Optional fill: string

Inherited from ​

SVGAttributes.fill

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1010

fill-opacity ​

• Optional fill-opacity: Numberish

Inherited from ​

SVGAttributes.fill-opacity

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1011

fill-rule ​

• Optional fill-rule: "inherit" | "nonzero" | "evenodd"

Inherited from ​

SVGAttributes.fill-rule

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1012

filter ​

• Optional filter: string

Inherited from ​

SVGAttributes.filter

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1013

filterRes ​

• Optional filterRes: Numberish

Inherited from ​

SVGAttributes.filterRes

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1014

filterUnits ​

• Optional filterUnits: Numberish

Inherited from ​

SVGAttributes.filterUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1015

flood-color ​

• Optional flood-color: Numberish

Inherited from ​

SVGAttributes.flood-color

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1016

flood-opacity ​

• Optional flood-opacity: Numberish

Inherited from ​

SVGAttributes.flood-opacity

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1017

focusable ​

• Optional focusable: Numberish

Inherited from ​

SVGAttributes.focusable

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1018

font-family ​

• Optional font-family: string

Inherited from ​

SVGAttributes.font-family

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1019

font-size ​

• Optional font-size: Numberish

Inherited from ​

SVGAttributes.font-size

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1020

font-size-adjust ​

• Optional font-size-adjust: Numberish

Inherited from ​

SVGAttributes.font-size-adjust

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1021

font-stretch ​

• Optional font-stretch: Numberish

Inherited from ​

SVGAttributes.font-stretch

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1022

font-style ​

• Optional font-style: Numberish

Inherited from ​

SVGAttributes.font-style

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1023

font-variant ​

• Optional font-variant: Numberish

Inherited from ​

SVGAttributes.font-variant

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1024

font-weight ​

• Optional font-weight: Numberish

Inherited from ​

SVGAttributes.font-weight

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1025

format ​

• Optional format: Numberish

Inherited from ​

SVGAttributes.format

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1026

from ​

• Optional from: Numberish

Inherited from ​

SVGAttributes.from

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1027

fx ​

• Optional fx: Numberish

Inherited from ​

SVGAttributes.fx

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1028

fy ​

• Optional fy: Numberish

Inherited from ​

SVGAttributes.fy

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1029

g1 ​

• Optional g1: Numberish

Inherited from ​

SVGAttributes.g1

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1030

g2 ​

• Optional g2: Numberish

Inherited from ​

SVGAttributes.g2

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1031

glyph-name ​

• Optional glyph-name: Numberish

Inherited from ​

SVGAttributes.glyph-name

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1032

glyph-orientation-horizontal ​

• Optional glyph-orientation-horizontal: Numberish

Inherited from ​

SVGAttributes.glyph-orientation-horizontal

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1033

glyph-orientation-vertical ​

• Optional glyph-orientation-vertical: Numberish

Inherited from ​

SVGAttributes.glyph-orientation-vertical

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1034

glyphRef ​

• Optional glyphRef: Numberish

Inherited from ​

SVGAttributes.glyphRef

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1035

gradientTransform ​

• Optional gradientTransform: string

Inherited from ​

SVGAttributes.gradientTransform

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1036

gradientUnits ​

• Optional gradientUnits: string

Inherited from ​

SVGAttributes.gradientUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1037

hanging ​

• Optional hanging: Numberish

Inherited from ​

SVGAttributes.hanging

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1038

height ​

• Optional height: Numberish

Inherited from ​

SVGAttributes.height

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:928

horiz-adv-x ​

• Optional horiz-adv-x: Numberish

Inherited from ​

SVGAttributes.horiz-adv-x

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1039

horiz-origin-x ​

• Optional horiz-origin-x: Numberish

Inherited from ​

SVGAttributes.horiz-origin-x

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1040

href ​

• Optional href: string

Inherited from ​

SVGAttributes.href

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1041

id ​

• Optional id: string

Inherited from ​

SVGAttributes.id

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:929

ideographic ​

• Optional ideographic: Numberish

Inherited from ​

SVGAttributes.ideographic

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1042

image-rendering ​

• Optional image-rendering: Numberish

Inherited from ​

SVGAttributes.image-rendering

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1043

in ​

• Optional in: string

Inherited from ​

SVGAttributes.in

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1045

in2 ​

• Optional in2: Numberish

Inherited from ​

SVGAttributes.in2

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1044

innerHTML ​

• Optional innerHTML: string

Inherited from ​

SVGAttributes.innerHTML

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:918

intercept ​

• Optional intercept: Numberish

Inherited from ​

SVGAttributes.intercept

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1046

k ​

• Optional k: Numberish

Inherited from ​

SVGAttributes.k

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1051

k1 ​

• Optional k1: Numberish

Inherited from ​

SVGAttributes.k1

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1047

k2 ​

• Optional k2: Numberish

Inherited from ​

SVGAttributes.k2

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1048

k3 ​

• Optional k3: Numberish

Inherited from ​

SVGAttributes.k3

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1049

k4 ​

• Optional k4: Numberish

Inherited from ​

SVGAttributes.k4

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1050

kernelMatrix ​

• Optional kernelMatrix: Numberish

Inherited from ​

SVGAttributes.kernelMatrix

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1052

kernelUnitLength ​

• Optional kernelUnitLength: Numberish

Inherited from ​

SVGAttributes.kernelUnitLength

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1053

kerning ​

• Optional kerning: Numberish

Inherited from ​

SVGAttributes.kerning

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1054

keyPoints ​

• Optional keyPoints: Numberish

Inherited from ​

SVGAttributes.keyPoints

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1055

keySplines ​

• Optional keySplines: Numberish

Inherited from ​

SVGAttributes.keySplines

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1056

keyTimes ​

• Optional keyTimes: Numberish

Inherited from ​

SVGAttributes.keyTimes

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1057

lang ​

• Optional lang: string

Inherited from ​

SVGAttributes.lang

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:930

lengthAdjust ​

• Optional lengthAdjust: Numberish

Inherited from ​

SVGAttributes.lengthAdjust

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1058

letter-spacing ​

• Optional letter-spacing: Numberish

Inherited from ​

SVGAttributes.letter-spacing

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1059

lighting-color ​

• Optional lighting-color: Numberish

Inherited from ​

SVGAttributes.lighting-color

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1060

limitingConeAngle ​

• Optional limitingConeAngle: Numberish

Inherited from ​

SVGAttributes.limitingConeAngle

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1061

local ​

• Optional local: Numberish

Inherited from ​

SVGAttributes.local

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1062

marker-end ​

• Optional marker-end: string

Inherited from ​

SVGAttributes.marker-end

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1063

marker-mid ​

• Optional marker-mid: string

Inherited from ​

SVGAttributes.marker-mid

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1065

marker-start ​

• Optional marker-start: string

Inherited from ​

SVGAttributes.marker-start

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1066

markerHeight ​

• Optional markerHeight: Numberish

Inherited from ​

SVGAttributes.markerHeight

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1064

markerUnits ​

• Optional markerUnits: Numberish

Inherited from ​

SVGAttributes.markerUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1067

markerWidth ​

• Optional markerWidth: Numberish

Inherited from ​

SVGAttributes.markerWidth

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1068

mask ​

• Optional mask: string

Inherited from ​

SVGAttributes.mask

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1069

maskContentUnits ​

• Optional maskContentUnits: Numberish

Inherited from ​

SVGAttributes.maskContentUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1070

maskUnits ​

• Optional maskUnits: Numberish

Inherited from ​

SVGAttributes.maskUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1071

mathematical ​

• Optional mathematical: Numberish

Inherited from ​

SVGAttributes.mathematical

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1072

max ​

• Optional max: Numberish

Inherited from ​

SVGAttributes.max

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:931

media ​

• Optional media: string

Inherited from ​

SVGAttributes.media

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:932

method ​

• Optional method: string

Inherited from ​

SVGAttributes.method

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:933

min ​

• Optional min: Numberish

Inherited from ​

SVGAttributes.min

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:934

mode ​

• Optional mode: Numberish

Inherited from ​

SVGAttributes.mode

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1073

name ​

• Optional name: string

Inherited from ​

SVGAttributes.name

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:935

numOctaves ​

• Optional numOctaves: Numberish

Inherited from ​

SVGAttributes.numOctaves

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1074

offset ​

• Optional offset: Numberish

Inherited from ​

SVGAttributes.offset

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1075

offsetEnd ​

• Optional offsetEnd: Position

Defined in ​

profectus/src/features/links/links.ts:18

offsetStart ​

• Optional offsetStart: Position

Defined in ​

profectus/src/features/links/links.ts:17

onAbort ​

• Optional onAbort: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onAbort

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1432

onAnimationend ​

• Optional onAnimationend: (payload: AnimationEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadAnimationEvent
Returns ​

void

Inherited from ​

SVGAttributes.onAnimationend

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1482

onAnimationiteration ​

• Optional onAnimationiteration: (payload: AnimationEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadAnimationEvent
Returns ​

void

Inherited from ​

SVGAttributes.onAnimationiteration

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1483

onAnimationstart ​

• Optional onAnimationstart: (payload: AnimationEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadAnimationEvent
Returns ​

void

Inherited from ​

SVGAttributes.onAnimationstart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1481

onAuxclick ​

• Optional onAuxclick: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

SVGAttributes.onAuxclick

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1419

onBeforeinput ​

• Optional onBeforeinput: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onBeforeinput

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1403

onBlur ​

• Optional onBlur: (payload: FocusEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadFocusEvent
Returns ​

void

Inherited from ​

SVGAttributes.onBlur

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1399

onCanplay ​

• Optional onCanplay: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onCanplay

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1433

onCanplaythrough ​

• Optional onCanplaythrough: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onCanplaythrough

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1434

onChange ​

• Optional onChange: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onChange

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1402

onClick ​

• Optional onClick: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

SVGAttributes.onClick

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1420

onCompositionend ​

• Optional onCompositionend: (payload: CompositionEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadCompositionEvent
Returns ​

void

Inherited from ​

SVGAttributes.onCompositionend

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1381

onCompositionstart ​

• Optional onCompositionstart: (payload: CompositionEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadCompositionEvent
Returns ​

void

Inherited from ​

SVGAttributes.onCompositionstart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1382

onCompositionupdate ​

• Optional onCompositionupdate: (payload: CompositionEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadCompositionEvent
Returns ​

void

Inherited from ​

SVGAttributes.onCompositionupdate

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1383

onContextmenu ​

• Optional onContextmenu: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

SVGAttributes.onContextmenu

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1421

onCopy ​

• Optional onCopy: (payload: ClipboardEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadClipboardEvent
Returns ​

void

Inherited from ​

SVGAttributes.onCopy

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1376

onCut ​

• Optional onCut: (payload: ClipboardEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadClipboardEvent
Returns ​

void

Inherited from ​

SVGAttributes.onCut

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1377

onDblclick ​

• Optional onDblclick: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

SVGAttributes.onDblclick

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1422

onDrag ​

• Optional onDrag: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

SVGAttributes.onDrag

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1386

onDragend ​

• Optional onDragend: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

SVGAttributes.onDragend

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1387

onDragenter ​

• Optional onDragenter: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

SVGAttributes.onDragenter

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1388

onDragexit ​

• Optional onDragexit: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

SVGAttributes.onDragexit

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1389

onDragleave ​

• Optional onDragleave: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

SVGAttributes.onDragleave

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1390

onDragover ​

• Optional onDragover: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

SVGAttributes.onDragover

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1391

onDragstart ​

• Optional onDragstart: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

SVGAttributes.onDragstart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1392

onDrop ​

• Optional onDrop: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

SVGAttributes.onDrop

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1393

onDurationchange ​

• Optional onDurationchange: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onDurationchange

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1435

onEmptied ​

• Optional onEmptied: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onEmptied

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1436

onEncrypted ​

• Optional onEncrypted: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onEncrypted

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1437

onEnded ​

• Optional onEnded: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onEnded

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1438

onError ​

• Optional onError: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onError

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1411

onFocus ​

• Optional onFocus: (payload: FocusEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadFocusEvent
Returns ​

void

Inherited from ​

SVGAttributes.onFocus

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1396

onFocusin ​

• Optional onFocusin: (payload: FocusEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadFocusEvent
Returns ​

void

Inherited from ​

SVGAttributes.onFocusin

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1397

onFocusout ​

• Optional onFocusout: (payload: FocusEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadFocusEvent
Returns ​

void

Inherited from ​

SVGAttributes.onFocusout

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1398

onInput ​

• Optional onInput: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onInput

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1404

onInvalid ​

• Optional onInvalid: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onInvalid

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1407

onKeydown ​

• Optional onKeydown: (payload: KeyboardEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadKeyboardEvent
Returns ​

void

Inherited from ​

SVGAttributes.onKeydown

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1414

onKeypress ​

• Optional onKeypress: (payload: KeyboardEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadKeyboardEvent
Returns ​

void

Inherited from ​

SVGAttributes.onKeypress

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1415

onKeyup ​

• Optional onKeyup: (payload: KeyboardEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadKeyboardEvent
Returns ​

void

Inherited from ​

SVGAttributes.onKeyup

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1416

onLoad ​

• Optional onLoad: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onLoad

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1410

onLoadeddata ​

• Optional onLoadeddata: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onLoadeddata

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1439

onLoadedmetadata ​

• Optional onLoadedmetadata: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onLoadedmetadata

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1440

onLoadstart ​

• Optional onLoadstart: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onLoadstart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1441

onMousedown ​

• Optional onMousedown: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

SVGAttributes.onMousedown

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1423

onMouseenter ​

• Optional onMouseenter: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

SVGAttributes.onMouseenter

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1424

onMouseleave ​

• Optional onMouseleave: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

SVGAttributes.onMouseleave

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1425

onMousemove ​

• Optional onMousemove: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

SVGAttributes.onMousemove

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1426

onMouseout ​

• Optional onMouseout: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

SVGAttributes.onMouseout

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1427

onMouseover ​

• Optional onMouseover: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

SVGAttributes.onMouseover

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1428

onMouseup ​

• Optional onMouseup: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

SVGAttributes.onMouseup

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1429

onPaste ​

• Optional onPaste: (payload: ClipboardEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadClipboardEvent
Returns ​

void

Inherited from ​

SVGAttributes.onPaste

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1378

onPause ​

• Optional onPause: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onPause

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1442

onPlay ​

• Optional onPlay: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onPlay

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1443

onPlaying ​

• Optional onPlaying: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onPlaying

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1444

onPointercancel ​

• Optional onPointercancel: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

SVGAttributes.onPointercancel

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1471

onPointerdown ​

• Optional onPointerdown: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

SVGAttributes.onPointerdown

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1468

onPointerenter ​

• Optional onPointerenter: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

SVGAttributes.onPointerenter

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1472

onPointerleave ​

• Optional onPointerleave: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

SVGAttributes.onPointerleave

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1473

onPointermove ​

• Optional onPointermove: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

SVGAttributes.onPointermove

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1469

onPointerout ​

• Optional onPointerout: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

SVGAttributes.onPointerout

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1475

onPointerover ​

• Optional onPointerover: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

SVGAttributes.onPointerover

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1474

onPointerup ​

• Optional onPointerup: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

SVGAttributes.onPointerup

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1470

onProgress ​

• Optional onProgress: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onProgress

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1445

onRatechange ​

• Optional onRatechange: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onRatechange

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1446

onReset ​

• Optional onReset: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onReset

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1405

onScroll ​

• Optional onScroll: (payload: UIEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadUIEvent
Returns ​

void

Inherited from ​

SVGAttributes.onScroll

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1459

onSeeked ​

• Optional onSeeked: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onSeeked

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1447

onSeeking ​

• Optional onSeeking: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onSeeking

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1448

onSelect ​

• Optional onSelect: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onSelect

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1456

onStalled ​

• Optional onStalled: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onStalled

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1449

onSubmit ​

• Optional onSubmit: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onSubmit

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1406

onSuspend ​

• Optional onSuspend: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onSuspend

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1450

onTimeupdate ​

• Optional onTimeupdate: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onTimeupdate

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1451

onTouchcancel ​

• Optional onTouchcancel: (payload: TouchEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadTouchEvent
Returns ​

void

Inherited from ​

SVGAttributes.onTouchcancel

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1462

onTouchend ​

• Optional onTouchend: (payload: TouchEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadTouchEvent
Returns ​

void

Inherited from ​

SVGAttributes.onTouchend

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1463

onTouchmove ​

• Optional onTouchmove: (payload: TouchEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadTouchEvent
Returns ​

void

Inherited from ​

SVGAttributes.onTouchmove

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1464

onTouchstart ​

• Optional onTouchstart: (payload: TouchEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadTouchEvent
Returns ​

void

Inherited from ​

SVGAttributes.onTouchstart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1465

onTransitionend ​

• Optional onTransitionend: (payload: TransitionEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadTransitionEvent
Returns ​

void

Inherited from ​

SVGAttributes.onTransitionend

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1486

onTransitionstart ​

• Optional onTransitionstart: (payload: TransitionEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadTransitionEvent
Returns ​

void

Inherited from ​

SVGAttributes.onTransitionstart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1487

onVolumechange ​

• Optional onVolumechange: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onVolumechange

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1452

onWaiting ​

• Optional onWaiting: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

SVGAttributes.onWaiting

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1453

onWheel ​

• Optional onWheel: (payload: WheelEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadWheelEvent
Returns ​

void

Inherited from ​

SVGAttributes.onWheel

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1478

opacity ​

• Optional opacity: Numberish

Inherited from ​

SVGAttributes.opacity

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1076

operator ​

• Optional operator: Numberish

Inherited from ​

SVGAttributes.operator

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1077

order ​

• Optional order: Numberish

Inherited from ​

SVGAttributes.order

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1078

orient ​

• Optional orient: Numberish

Inherited from ​

SVGAttributes.orient

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1079

orientation ​

• Optional orientation: Numberish

Inherited from ​

SVGAttributes.orientation

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1080

origin ​

• Optional origin: Numberish

Inherited from ​

SVGAttributes.origin

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1081

overflow ​

• Optional overflow: Numberish

Inherited from ​

SVGAttributes.overflow

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1082

overline-position ​

• Optional overline-position: Numberish

Inherited from ​

SVGAttributes.overline-position

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1083

overline-thickness ​

• Optional overline-thickness: Numberish

Inherited from ​

SVGAttributes.overline-thickness

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1084

paint-order ​

• Optional paint-order: Numberish

Inherited from ​

SVGAttributes.paint-order

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1085

panose-1 ​

• Optional panose-1: Numberish

Inherited from ​

SVGAttributes.panose-1

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1086

pathLength ​

• Optional pathLength: Numberish

Inherited from ​

SVGAttributes.pathLength

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1087

patternContentUnits ​

• Optional patternContentUnits: string

Inherited from ​

SVGAttributes.patternContentUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1088

patternTransform ​

• Optional patternTransform: Numberish

Inherited from ​

SVGAttributes.patternTransform

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1089

patternUnits ​

• Optional patternUnits: string

Inherited from ​

SVGAttributes.patternUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1090

pointer-events ​

• Optional pointer-events: Numberish

Inherited from ​

SVGAttributes.pointer-events

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1091

points ​

• Optional points: string

Inherited from ​

SVGAttributes.points

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1092

pointsAtX ​

• Optional pointsAtX: Numberish

Inherited from ​

SVGAttributes.pointsAtX

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1093

pointsAtY ​

• Optional pointsAtY: Numberish

Inherited from ​

SVGAttributes.pointsAtY

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1094

pointsAtZ ​

• Optional pointsAtZ: Numberish

Inherited from ​

SVGAttributes.pointsAtZ

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1095

preserveAlpha ​

• Optional preserveAlpha: Numberish

Inherited from ​

SVGAttributes.preserveAlpha

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1096

preserveAspectRatio ​

• Optional preserveAspectRatio: string

Inherited from ​

SVGAttributes.preserveAspectRatio

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1097

primitiveUnits ​

• Optional primitiveUnits: Numberish

Inherited from ​

SVGAttributes.primitiveUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1098

r ​

• Optional r: Numberish

Inherited from ​

SVGAttributes.r

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1099

radius ​

• Optional radius: Numberish

Inherited from ​

SVGAttributes.radius

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1100

refX ​

• Optional refX: Numberish

Inherited from ​

SVGAttributes.refX

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1101

refY ​

• Optional refY: Numberish

Inherited from ​

SVGAttributes.refY

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1102

renderingIntent ​

• Optional renderingIntent: Numberish

Inherited from ​

SVGAttributes.renderingIntent

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1103

repeatCount ​

• Optional repeatCount: Numberish

Inherited from ​

SVGAttributes.repeatCount

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1104

repeatDur ​

• Optional repeatDur: Numberish

Inherited from ​

SVGAttributes.repeatDur

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1105

requiredExtensions ​

• Optional requiredExtensions: Numberish

Inherited from ​

SVGAttributes.requiredExtensions

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1106

requiredFeatures ​

• Optional requiredFeatures: Numberish

Inherited from ​

SVGAttributes.requiredFeatures

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1107

restart ​

• Optional restart: Numberish

Inherited from ​

SVGAttributes.restart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1108

result ​

• Optional result: string

Inherited from ​

SVGAttributes.result

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1109

role ​

• Optional role: string

Inherited from ​

SVGAttributes.role

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:941

rotate ​

• Optional rotate: Numberish

Inherited from ​

SVGAttributes.rotate

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1110

rx ​

• Optional rx: Numberish

Inherited from ​

SVGAttributes.rx

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1111

ry ​

• Optional ry: Numberish

Inherited from ​

SVGAttributes.ry

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1112

scale ​

• Optional scale: Numberish

Inherited from ​

SVGAttributes.scale

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1113

seed ​

• Optional seed: Numberish

Inherited from ​

SVGAttributes.seed

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1114

shape-rendering ​

• Optional shape-rendering: Numberish

Inherited from ​

SVGAttributes.shape-rendering

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1115

slope ​

• Optional slope: Numberish

Inherited from ​

SVGAttributes.slope

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1116

spacing ​

• Optional spacing: Numberish

Inherited from ​

SVGAttributes.spacing

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1117

specularConstant ​

• Optional specularConstant: Numberish

Inherited from ​

SVGAttributes.specularConstant

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1118

specularExponent ​

• Optional specularExponent: Numberish

Inherited from ​

SVGAttributes.specularExponent

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1119

speed ​

• Optional speed: Numberish

Inherited from ​

SVGAttributes.speed

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1120

spreadMethod ​

• Optional spreadMethod: string

Inherited from ​

SVGAttributes.spreadMethod

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1121

startNode ​

• startNode: Object

Type declaration ​

NameType
idstring

Defined in ​

profectus/src/features/links/links.ts:15

startOffset ​

• Optional startOffset: Numberish

Inherited from ​

SVGAttributes.startOffset

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1122

stdDeviation ​

• Optional stdDeviation: Numberish

Inherited from ​

SVGAttributes.stdDeviation

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1123

stemh ​

• Optional stemh: Numberish

Inherited from ​

SVGAttributes.stemh

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1124

stemv ​

• Optional stemv: Numberish

Inherited from ​

SVGAttributes.stemv

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1125

stitchTiles ​

• Optional stitchTiles: Numberish

Inherited from ​

SVGAttributes.stitchTiles

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1126

stop-color ​

• Optional stop-color: string

Inherited from ​

SVGAttributes.stop-color

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1127

stop-opacity ​

• Optional stop-opacity: Numberish

Inherited from ​

SVGAttributes.stop-opacity

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1128

strikethrough-position ​

• Optional strikethrough-position: Numberish

Inherited from ​

SVGAttributes.strikethrough-position

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1129

strikethrough-thickness ​

• Optional strikethrough-thickness: Numberish

Inherited from ​

SVGAttributes.strikethrough-thickness

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1130

string ​

• Optional string: Numberish

Inherited from ​

SVGAttributes.string

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1131

stroke ​

• Optional stroke: string

Inherited from ​

SVGAttributes.stroke

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1132

stroke-dasharray ​

• Optional stroke-dasharray: Numberish

Inherited from ​

SVGAttributes.stroke-dasharray

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1133

stroke-dashoffset ​

• Optional stroke-dashoffset: Numberish

Inherited from ​

SVGAttributes.stroke-dashoffset

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1134

stroke-linecap ​

• Optional stroke-linecap: "inherit" | "butt" | "round" | "square"

Inherited from ​

SVGAttributes.stroke-linecap

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1135

stroke-linejoin ​

• Optional stroke-linejoin: "inherit" | "round" | "miter" | "bevel"

Inherited from ​

SVGAttributes.stroke-linejoin

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1136

stroke-miterlimit ​

• Optional stroke-miterlimit: Numberish

Inherited from ​

SVGAttributes.stroke-miterlimit

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1137

stroke-opacity ​

• Optional stroke-opacity: Numberish

Inherited from ​

SVGAttributes.stroke-opacity

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1138

stroke-width ​

• Optional stroke-width: Numberish

Inherited from ​

SVGAttributes.stroke-width

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1139

style ​

• Optional style: string | CSSProperties

Inherited from ​

SVGAttributes.style

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:925

surfaceScale ​

• Optional surfaceScale: Numberish

Inherited from ​

SVGAttributes.surfaceScale

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1140

systemLanguage ​

• Optional systemLanguage: Numberish

Inherited from ​

SVGAttributes.systemLanguage

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1141

tabindex ​

• Optional tabindex: Numberish

Inherited from ​

SVGAttributes.tabindex

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:942

tableValues ​

• Optional tableValues: Numberish

Inherited from ​

SVGAttributes.tableValues

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1142

target ​

• Optional target: string

Inherited from ​

SVGAttributes.target

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:936

targetX ​

• Optional targetX: Numberish

Inherited from ​

SVGAttributes.targetX

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1143

targetY ​

• Optional targetY: Numberish

Inherited from ​

SVGAttributes.targetY

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1144

text-anchor ​

• Optional text-anchor: string

Inherited from ​

SVGAttributes.text-anchor

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1145

text-decoration ​

• Optional text-decoration: Numberish

Inherited from ​

SVGAttributes.text-decoration

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1146

text-rendering ​

• Optional text-rendering: Numberish

Inherited from ​

SVGAttributes.text-rendering

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1148

textLength ​

• Optional textLength: Numberish

Inherited from ​

SVGAttributes.textLength

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1147

to ​

• Optional to: Numberish

Inherited from ​

SVGAttributes.to

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1149

transform ​

• Optional transform: string

Inherited from ​

SVGAttributes.transform

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1150

type ​

• Optional type: string

Inherited from ​

SVGAttributes.type

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:937

u1 ​

• Optional u1: Numberish

Inherited from ​

SVGAttributes.u1

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1151

u2 ​

• Optional u2: Numberish

Inherited from ​

SVGAttributes.u2

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1152

underline-position ​

• Optional underline-position: Numberish

Inherited from ​

SVGAttributes.underline-position

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1153

underline-thickness ​

• Optional underline-thickness: Numberish

Inherited from ​

SVGAttributes.underline-thickness

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1154

unicode ​

• Optional unicode: Numberish

Inherited from ​

SVGAttributes.unicode

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1155

unicode-bidi ​

• Optional unicode-bidi: Numberish

Inherited from ​

SVGAttributes.unicode-bidi

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1156

unicode-range ​

• Optional unicode-range: Numberish

Inherited from ​

SVGAttributes.unicode-range

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1157

unitsPer-em ​

• Optional unitsPer-em: Numberish

Inherited from ​

SVGAttributes.unitsPer-em

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1158

v-alphabetic ​

• Optional v-alphabetic: Numberish

Inherited from ​

SVGAttributes.v-alphabetic

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1159

v-hanging ​

• Optional v-hanging: Numberish

Inherited from ​

SVGAttributes.v-hanging

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1166

v-ideographic ​

• Optional v-ideographic: Numberish

Inherited from ​

SVGAttributes.v-ideographic

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1167

v-mathematical ​

• Optional v-mathematical: Numberish

Inherited from ​

SVGAttributes.v-mathematical

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1171

values ​

• Optional values: string

Inherited from ​

SVGAttributes.values

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1160

vector-effect ​

• Optional vector-effect: Numberish

Inherited from ​

SVGAttributes.vector-effect

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1161

version ​

• Optional version: string

Inherited from ​

SVGAttributes.version

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1162

vert-adv-y ​

• Optional vert-adv-y: Numberish

Inherited from ​

SVGAttributes.vert-adv-y

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1163

vert-origin-x ​

• Optional vert-origin-x: Numberish

Inherited from ​

SVGAttributes.vert-origin-x

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1164

vert-origin-y ​

• Optional vert-origin-y: Numberish

Inherited from ​

SVGAttributes.vert-origin-y

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1165

viewBox ​

• Optional viewBox: string

Inherited from ​

SVGAttributes.viewBox

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1168

viewTarget ​

• Optional viewTarget: Numberish

Inherited from ​

SVGAttributes.viewTarget

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1169

visibility ​

• Optional visibility: Numberish

Inherited from ​

SVGAttributes.visibility

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1170

width ​

• Optional width: Numberish

Inherited from ​

SVGAttributes.width

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:938

widths ​

• Optional widths: Numberish

Inherited from ​

SVGAttributes.widths

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1172

word-spacing ​

• Optional word-spacing: Numberish

Inherited from ​

SVGAttributes.word-spacing

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1173

writing-mode ​

• Optional writing-mode: Numberish

Inherited from ​

SVGAttributes.writing-mode

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1174

x ​

• Optional x: Numberish

Inherited from ​

SVGAttributes.x

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1177

x-height ​

• Optional x-height: Numberish

Inherited from ​

SVGAttributes.x-height

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1179

x1 ​

• Optional x1: Numberish

Inherited from ​

SVGAttributes.x1

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1175

x2 ​

• Optional x2: Numberish

Inherited from ​

SVGAttributes.x2

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1176

xChannelSelector ​

• Optional xChannelSelector: string

Inherited from ​

SVGAttributes.xChannelSelector

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1178

xlinkActuate ​

• Optional xlinkActuate: string

Inherited from ​

SVGAttributes.xlinkActuate

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1180

xlinkArcrole ​

• Optional xlinkArcrole: string

Inherited from ​

SVGAttributes.xlinkArcrole

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1181

xlinkHref ​

• Optional xlinkHref: string

Inherited from ​

SVGAttributes.xlinkHref

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1182

xlinkRole ​

• Optional xlinkRole: string

Inherited from ​

SVGAttributes.xlinkRole

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1183

xlinkShow ​

• Optional xlinkShow: string

Inherited from ​

SVGAttributes.xlinkShow

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1184

xlinkTitle ​

• Optional xlinkTitle: string

Inherited from ​

SVGAttributes.xlinkTitle

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1185

xlinkType ​

• Optional xlinkType: string

Inherited from ​

SVGAttributes.xlinkType

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1186

xmlns ​

• Optional xmlns: string

Inherited from ​

SVGAttributes.xmlns

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1187

y ​

• Optional y: Numberish

Inherited from ​

SVGAttributes.y

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1190

y1 ​

• Optional y1: Numberish

Inherited from ​

SVGAttributes.y1

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1188

y2 ​

• Optional y2: Numberish

Inherited from ​

SVGAttributes.y2

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1189

yChannelSelector ​

• Optional yChannelSelector: string

Inherited from ​

SVGAttributes.yChannelSelector

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1191

z ​

• Optional z: Numberish

Inherited from ​

SVGAttributes.z

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1192

zoomAndPan ​

• Optional zoomAndPan: string

Inherited from ​

SVGAttributes.zoomAndPan

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1193

- diff --git a/api/interfaces/features/links/links.LinksOptions.html b/api/interfaces/features/links/links.LinksOptions.html index e8338f9d..340e844a 100644 --- a/api/interfaces/features/links/links.LinksOptions.html +++ b/api/interfaces/features/links/links.LinksOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: LinksOptions ​

features/links/links.LinksOptions

An object that configures a Links.

Properties ​

• links: Computable<Link[]>

The list of links to display.

Defined in ​

profectus/src/features/links/links.ts:24

- diff --git a/api/interfaces/features/particles/particles.BaseParticles.html b/api/interfaces/features/particles/particles.BaseParticles.html index 868767e8..27ac68f4 100644 --- a/api/interfaces/features/particles/particles.BaseParticles.html +++ b/api/interfaces/features/particles/particles.BaseParticles.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseParticles ​

features/particles/particles.BaseParticles

The properties that are added onto a processed ParticlesOptions to create an Particles.

Properties ​

[Component] ​

• [Component]: GenericComponent

The Vue component used to render this feature.

Defined in ​

profectus/src/features/particles/particles.tsx:45

[GatherProps] ​

• [GatherProps]: () => Record<string, unknown>

Type declaration ​

â–¸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns ​

Record<string, unknown>

Defined in ​

profectus/src/features/particles/particles.tsx:47

addEmitter ​

• addEmitter: (config: EmitterConfigV3) => Promise<Emitter>

Type declaration ​

â–¸ (config): Promise<Emitter>

A function to asynchronously add an emitter to the canvas. The returned emitter can then be positioned as appropriate and started.

See

Particles

Parameters ​
NameType
configEmitterConfigV3
Returns ​

Promise<Emitter>

Defined in ​

profectus/src/features/particles/particles.tsx:41

app ​

• app: Ref<null | Application>

The Pixi.JS Application powering this particles canvas.

Defined in ​

profectus/src/features/particles/particles.tsx:35

id ​

• id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Defined in ​

profectus/src/features/particles/particles.tsx:33

type ​

• type: typeof ParticlesType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/particles/particles.tsx:43

- diff --git a/api/interfaces/features/particles/particles.ParticlesOptions.html b/api/interfaces/features/particles/particles.ParticlesOptions.html index b98fb08f..e41589ec 100644 --- a/api/interfaces/features/particles/particles.ParticlesOptions.html +++ b/api/interfaces/features/particles/particles.ParticlesOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: ParticlesOptions ​

features/particles/particles.ParticlesOptions

An object that configures Particles.

Properties ​

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Defined in ​

profectus/src/features/particles/particles.tsx:19

onContainerResized ​

• Optional onContainerResized: (boundingRect: DOMRect) => void

Type declaration ​

â–¸ (boundingRect): void

A function that is called when the particles canvas is resized.

Parameters ​
NameType
boundingRectDOMRect
Returns ​

void

Defined in ​

profectus/src/features/particles/particles.tsx:23

onHotReload ​

• Optional onHotReload: VoidFunction

A function that is called whenever the particles element is reloaded during development. For restarting particle effects.

Defined in ​

profectus/src/features/particles/particles.tsx:25

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Defined in ​

profectus/src/features/particles/particles.tsx:21

- diff --git a/api/interfaces/features/repeatable.BaseRepeatable.html b/api/interfaces/features/repeatable.BaseRepeatable.html index 81d1f6dd..0bee69bb 100644 --- a/api/interfaces/features/repeatable.BaseRepeatable.html +++ b/api/interfaces/features/repeatable.BaseRepeatable.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseRepeatable ​

features/repeatable.BaseRepeatable

The properties that are added onto a processed RepeatableOptions to create a Repeatable.

Properties ​

[Component] ​

• [Component]: GenericComponent

The Vue component used to render this feature.

Defined in ​

profectus/src/features/repeatable.tsx:97

[GatherProps] ​

• [GatherProps]: () => Record<string, unknown>

Type declaration ​

â–¸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns ​

Record<string, unknown>

Defined in ​

profectus/src/features/repeatable.tsx:99

amount ​

• amount: Persistent<DecimalSource>

The current amount this repeatable has.

Defined in ​

profectus/src/features/repeatable.tsx:82

amountToIncrease ​

• amountToIncrease: Ref<DecimalSource>

How much amount can be increased by, or 1 if unclickable. Capped at 1 if maximize is false.

Defined in ​

profectus/src/features/repeatable.tsx:91

canClick ​

• canClick: ProcessedComputable<boolean>

Whether or not this repeatable can be clicked.

Defined in ​

profectus/src/features/repeatable.tsx:86

id ​

• id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Defined in ​

profectus/src/features/repeatable.tsx:80

maxed ​

• maxed: Ref<boolean>

Whether or not this repeatable's amount is at it's limit.

Defined in ​

profectus/src/features/repeatable.tsx:84

onClick ​

• onClick: (event?: MouseEvent | TouchEvent) => void

Type declaration ​

â–¸ (event?): void

A function that gets called when this repeatable is clicked.

Parameters ​
NameType
event?MouseEvent | TouchEvent
Returns ​

void

Defined in ​

profectus/src/features/repeatable.tsx:93

type ​

• type: typeof RepeatableType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/repeatable.tsx:95

- diff --git a/api/interfaces/features/repeatable.RepeatableOptions.html b/api/interfaces/features/repeatable.RepeatableOptions.html index 14322b75..e1e09ebd 100644 --- a/api/interfaces/features/repeatable.RepeatableOptions.html +++ b/api/interfaces/features/repeatable.RepeatableOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: RepeatableOptions ​

features/repeatable.RepeatableOptions

An object that configures a Repeatable.

Properties ​

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Defined in ​

profectus/src/features/repeatable.tsx:62

display ​

• Optional display: Computable<RepeatableDisplay>

The display to use for this repeatable.

Defined in ​

profectus/src/features/repeatable.tsx:72

initialAmount ​

• Optional initialAmount: DecimalSource

The initial amount this repeatable has on a new save / after reset.

Defined in ​

profectus/src/features/repeatable.tsx:60

limit ​

• Optional limit: Computable<DecimalSource>

The maximum amount obtainable for this repeatable.

Defined in ​

profectus/src/features/repeatable.tsx:58

mark ​

• Optional mark: Computable<string | boolean>

Shows a marker on the corner of the feature.

Defined in ​

profectus/src/features/repeatable.tsx:66

maximize ​

• Optional maximize: Computable<boolean>

Whether or not clicking this repeatable should attempt to maximize amount based on the requirements met. Requires requirements to be a requirement or array of requirements with Requirement.canMaximize true.

Defined in ​

profectus/src/features/repeatable.tsx:70

requirements ​

• requirements: Requirements

The requirement(s) to increase this repeatable.

Defined in ​

profectus/src/features/repeatable.tsx:56

small ​

• Optional small: Computable<boolean>

Toggles a smaller design for the feature.

Defined in ​

profectus/src/features/repeatable.tsx:68

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Defined in ​

profectus/src/features/repeatable.tsx:64

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this repeatable should be visible.

Defined in ​

profectus/src/features/repeatable.tsx:54

- diff --git a/api/interfaces/features/reset.BaseReset.html b/api/interfaces/features/reset.BaseReset.html index 748932d6..bbf48444 100644 --- a/api/interfaces/features/reset.BaseReset.html +++ b/api/interfaces/features/reset.BaseReset.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseReset ​

features/reset.BaseReset

The properties that are added onto a processed ResetOptions to create an Reset.

Properties ​

id ​

• id: string

An auto-generated ID for identifying which reset is being performed. Will not persist between refreshes or updates.

Defined in ​

profectus/src/features/reset.ts:32

reset ​

• reset: VoidFunction

Trigger the reset.

Defined in ​

profectus/src/features/reset.ts:34

type ​

• type: typeof ResetType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/reset.ts:36

- diff --git a/api/interfaces/features/reset.ResetOptions.html b/api/interfaces/features/reset.ResetOptions.html index 7f018fec..44b0276c 100644 --- a/api/interfaces/features/reset.ResetOptions.html +++ b/api/interfaces/features/reset.ResetOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: ResetOptions ​

features/reset.ResetOptions

An object that configures a Clickable.

Properties ​

onReset ​

• Optional onReset: VoidFunction

A function that is called when the reset is performed.

Defined in ​

profectus/src/features/reset.ts:24

thingsToReset ​

• thingsToReset: Computable<Record<string, unknown>[]>

List of things to reset. Can include objects which will be recursed over for persistent values.

Defined in ​

profectus/src/features/reset.ts:22

- diff --git a/api/interfaces/features/resources/resource.Resource.html b/api/interfaces/features/resources/resource.Resource.html index bab61684..8795b332 100644 --- a/api/interfaces/features/resources/resource.Resource.html +++ b/api/interfaces/features/resources/resource.Resource.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: Resource<T> ​

features/resources/resource.Resource

An object that represents a named and quantifiable resource in the game.

Type parameters ​

NameType
TDecimalSource

Hierarchy ​

  • Ref<T>

    ↳ Resource

Properties ​

[RefSymbol] ​

• [RefSymbol]: true

Type differentiator only. We need this to be in public d.ts but don't want it to show up in IDE autocomplete, so we use a private Symbol instead.

Inherited from ​

Ref.__@RefSymbol@312

Defined in ​

node_modules/@vue/reactivity/dist/reactivity.d.ts:202

displayName ​

• displayName: string

The name of this resource.

Defined in ​

profectus/src/features/resources/resource.ts:14

precision ​

• precision: number

When displaying the value of this resource, how many significant digits to display.

Defined in ​

profectus/src/features/resources/resource.ts:16

small ​

• Optional small: boolean

Whether or not to display very small values using scientific notation, or rounding to 0.

Defined in ​

profectus/src/features/resources/resource.ts:18

value ​

• value: T

Inherited from ​

Ref.value

Defined in ​

node_modules/@vue/reactivity/dist/reactivity.d.ts:196

- diff --git a/api/interfaces/features/tabs/tab.BaseTab.html b/api/interfaces/features/tabs/tab.BaseTab.html index da308274..f5d3c7cf 100644 --- a/api/interfaces/features/tabs/tab.BaseTab.html +++ b/api/interfaces/features/tabs/tab.BaseTab.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseTab ​

features/tabs/tab.BaseTab

The properties that are added onto a processed TabOptions to create an Tab.

Properties ​

[Component] ​

• [Component]: GenericComponent

The Vue component used to render this feature.

Defined in ​

profectus/src/features/tabs/tab.ts:37

[GatherProps] ​

• [GatherProps]: () => Record<string, unknown>

Type declaration ​

â–¸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns ​

Record<string, unknown>

Defined in ​

profectus/src/features/tabs/tab.ts:39

id ​

• id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Defined in ​

profectus/src/features/tabs/tab.ts:33

type ​

• type: typeof TabType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/tabs/tab.ts:35

- diff --git a/api/interfaces/features/tabs/tab.TabOptions.html b/api/interfaces/features/tabs/tab.TabOptions.html index c66171cc..be12024f 100644 --- a/api/interfaces/features/tabs/tab.TabOptions.html +++ b/api/interfaces/features/tabs/tab.TabOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: TabOptions ​

features/tabs/tab.TabOptions

An object that configures a Tab.

Properties ​

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Defined in ​

profectus/src/features/tabs/tab.ts:21

display ​

• display: Computable<CoercableComponent>

The display to use for this tab.

Defined in ​

profectus/src/features/tabs/tab.ts:25

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Defined in ​

profectus/src/features/tabs/tab.ts:23

- diff --git a/api/interfaces/features/tabs/tabFamily.BaseTabButton.html b/api/interfaces/features/tabs/tabFamily.BaseTabButton.html index e574ad61..a206ae30 100644 --- a/api/interfaces/features/tabs/tabFamily.BaseTabButton.html +++ b/api/interfaces/features/tabs/tabFamily.BaseTabButton.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseTabButton ​

features/tabs/tabFamily.BaseTabButton

The properties that are added onto a processed TabButtonOptions to create an TabButton.

Properties ​

[Component] ​

• [Component]: GenericComponent

The Vue component used to render this feature.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:62

type ​

• type: typeof TabButtonType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:60

- diff --git a/api/interfaces/features/tabs/tabFamily.BaseTabFamily.html b/api/interfaces/features/tabs/tabFamily.BaseTabFamily.html index deb89301..a0a980ef 100644 --- a/api/interfaces/features/tabs/tabFamily.BaseTabFamily.html +++ b/api/interfaces/features/tabs/tabFamily.BaseTabFamily.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseTabFamily ​

features/tabs/tabFamily.BaseTabFamily

The properties that are added onto a processed TabFamilyOptions to create an TabFamily.

Properties ​

[Component] ​

• [Component]: GenericComponent

The Vue component used to render this feature.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:120

[GatherProps] ​

• [GatherProps]: () => Record<string, unknown>

Type declaration ​

â–¸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns ​

Record<string, unknown>

Defined in ​

profectus/src/features/tabs/tabFamily.ts:122

activeTab ​

• activeTab: Ref<null | CoercableComponent | GenericTab>

The currently active tab, if any.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:114

id ​

• id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:110

selected ​

• selected: Persistent<string>

The name of the tab that is currently active.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:116

tabs ​

• tabs: Record<string, TabButtonOptions>

All the tabs within this family.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:112

type ​

• type: typeof TabFamilyType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:118

- diff --git a/api/interfaces/features/tabs/tabFamily.TabButtonOptions.html b/api/interfaces/features/tabs/tabFamily.TabButtonOptions.html index 59e9ec7e..40043460 100644 --- a/api/interfaces/features/tabs/tabFamily.TabButtonOptions.html +++ b/api/interfaces/features/tabs/tabFamily.TabButtonOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: TabButtonOptions ​

features/tabs/tabFamily.TabButtonOptions

An object that configures a TabButton.

Properties ​

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:48

display ​

• display: Computable<CoercableComponent>

The label on this button.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:46

glowColor ​

• Optional glowColor: Computable<string>

The color of the glow effect to display when this button is active.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:52

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:50

tab ​

• tab: Computable<CoercableComponent | GenericTab>

The tab to display when this button is clicked.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:44

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this tab button should be visible.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:42

- diff --git a/api/interfaces/features/tabs/tabFamily.TabFamilyOptions.html b/api/interfaces/features/tabs/tabFamily.TabFamilyOptions.html index 4111d324..7b62e107 100644 --- a/api/interfaces/features/tabs/tabFamily.TabFamilyOptions.html +++ b/api/interfaces/features/tabs/tabFamily.TabFamilyOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: TabFamilyOptions ​

features/tabs/tabFamily.TabFamilyOptions

An object that configures a TabFamily.

Properties ​

buttonContainerClasses ​

• Optional buttonContainerClasses: Computable<Record<string, boolean>>

A dictionary of CSS classes to apply to the list of buttons for changing tabs.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:100

buttonContainerStyle ​

• Optional buttonContainerStyle: Computable<StyleValue>

CSS to apply to the list of buttons for changing tabs.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:102

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:96

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:98

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this tab button should be visible.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:94

- diff --git a/api/interfaces/features/tooltips/tooltip.BaseTooltip.html b/api/interfaces/features/tooltips/tooltip.BaseTooltip.html index 0a517026..7ba20f0d 100644 --- a/api/interfaces/features/tooltips/tooltip.BaseTooltip.html +++ b/api/interfaces/features/tooltips/tooltip.BaseTooltip.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseTooltip ​

features/tooltips/tooltip.BaseTooltip

The properties that are added onto a processed TooltipOptions to create an Tooltip.

Properties ​

pinned ​

• Optional pinned: Ref<boolean>

Defined in ​

profectus/src/features/tooltips/tooltip.ts:48

- diff --git a/api/interfaces/features/tooltips/tooltip.TooltipOptions.html b/api/interfaces/features/tooltips/tooltip.TooltipOptions.html index 816c216d..061a3c7e 100644 --- a/api/interfaces/features/tooltips/tooltip.TooltipOptions.html +++ b/api/interfaces/features/tooltips/tooltip.TooltipOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: TooltipOptions ​

features/tooltips/tooltip.TooltipOptions

An object that configures a Tooltip.

Properties ​

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Defined in ​

profectus/src/features/tooltips/tooltip.ts:33

direction ​

• Optional direction: Computable<Direction>

The direction in which to display the tooltip

Defined in ​

profectus/src/features/tooltips/tooltip.ts:37

display ​

• display: Computable<CoercableComponent>

The text to display inside the tooltip.

Defined in ​

profectus/src/features/tooltips/tooltip.ts:31

pinnable ​

• Optional pinnable: boolean

Whether or not this tooltip can be pinned, meaning it'll stay visible even when not hovered.

Defined in ​

profectus/src/features/tooltips/tooltip.ts:29

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Defined in ​

profectus/src/features/tooltips/tooltip.ts:35

xoffset ​

• Optional xoffset: Computable<string>

The x offset of the tooltip, in px.

Defined in ​

profectus/src/features/tooltips/tooltip.ts:39

yoffset ​

• Optional yoffset: Computable<string>

The y offset of the tooltip, in px.

Defined in ​

profectus/src/features/tooltips/tooltip.ts:41

- diff --git a/api/interfaces/features/trees/tree.BaseTree.html b/api/interfaces/features/trees/tree.BaseTree.html index c6b9c47a..83f33f12 100644 --- a/api/interfaces/features/trees/tree.BaseTree.html +++ b/api/interfaces/features/trees/tree.BaseTree.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseTree ​

features/trees/tree.BaseTree

Properties ​

[Component] ​

• [Component]: GenericComponent

The Vue component used to render this feature.

Defined in ​

profectus/src/features/trees/tree.ts:213

[GatherProps] ​

• [GatherProps]: () => Record<string, unknown>

Type declaration ​

â–¸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns ​

Record<string, unknown>

Defined in ​

profectus/src/features/trees/tree.ts:215

id ​

• id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Defined in ​

profectus/src/features/trees/tree.ts:201

isResetting ​

• isResetting: Ref<boolean>

A flag that is true while the reset is still propagating through the tree.

Defined in ​

profectus/src/features/trees/tree.ts:207

• links: Ref<Link[]>

The link objects for each of the branches of the tree.

Defined in ​

profectus/src/features/trees/tree.ts:203

reset ​

• reset: (node: GenericTreeNode) => void

Type declaration ​

â–¸ (node): void

Cause a reset on this node and propagate it through the tree according to resetPropagation.

Parameters ​
NameType
nodeGenericTreeNode
Returns ​

void

Defined in ​

profectus/src/features/trees/tree.ts:205

resettingNode ​

• resettingNode: Ref<null | GenericTreeNode>

A reference to the node that caused the currently propagating reset.

Defined in ​

profectus/src/features/trees/tree.ts:209

type ​

• type: typeof TreeType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/trees/tree.ts:211

- diff --git a/api/interfaces/features/trees/tree.BaseTreeNode.html b/api/interfaces/features/trees/tree.BaseTreeNode.html index 3aee06ee..b0a9b390 100644 --- a/api/interfaces/features/trees/tree.BaseTreeNode.html +++ b/api/interfaces/features/trees/tree.BaseTreeNode.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseTreeNode ​

features/trees/tree.BaseTreeNode

The properties that are added onto a processed TreeNodeOptions to create an TreeNode.

Properties ​

[Component] ​

• [Component]: GenericComponent

The Vue component used to render this feature.

Defined in ​

profectus/src/features/trees/tree.ts:70

[GatherProps] ​

• [GatherProps]: () => Record<string, unknown>

Type declaration ​

â–¸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns ​

Record<string, unknown>

Defined in ​

profectus/src/features/trees/tree.ts:72

id ​

• id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Defined in ​

profectus/src/features/trees/tree.ts:66

type ​

• type: typeof TreeNodeType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/trees/tree.ts:68

- diff --git a/api/interfaces/features/trees/tree.TreeBranch.html b/api/interfaces/features/trees/tree.TreeBranch.html index 58bbbf5c..1dd95236 100644 --- a/api/interfaces/features/trees/tree.TreeBranch.html +++ b/api/interfaces/features/trees/tree.TreeBranch.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: TreeBranch ​

features/trees/tree.TreeBranch

Represents a branch between two nodes in a tree.

Hierarchy ​

  • Omit<Link, "startNode" | "endNode">

    ↳ TreeBranch

Properties ​

accent-height ​

• Optional accent-height: Numberish

Inherited from ​

Omit.accent-height

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:945

accumulate ​

• Optional accumulate: "none" | "sum"

Inherited from ​

Omit.accumulate

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:946

additive ​

• Optional additive: "sum" | "replace"

Inherited from ​

Omit.additive

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:947

alignment-baseline ​

• Optional alignment-baseline: "alphabetic" | "hanging" | "ideographic" | "mathematical" | "auto" | "baseline" | "before-edge" | "text-before-edge" | "middle" | "central" | "after-edge" | "text-after-edge" | "inherit"

Inherited from ​

Omit.alignment-baseline

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:948

allowReorder ​

• Optional allowReorder: "no" | "yes"

Inherited from ​

Omit.allowReorder

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:962

alphabetic ​

• Optional alphabetic: Numberish

Inherited from ​

Omit.alphabetic

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:963

amplitude ​

• Optional amplitude: Numberish

Inherited from ​

Omit.amplitude

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:964

arabic-form ​

• Optional arabic-form: "initial" | "medial" | "terminal" | "isolated"

Inherited from ​

Omit.arabic-form

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:965

aria-activedescendant ​

• Optional aria-activedescendant: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

Inherited from ​

Omit.aria-activedescendant

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:224

aria-atomic ​

• Optional aria-atomic: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

Inherited from ​

Omit.aria-atomic

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:226

aria-autocomplete ​

• Optional aria-autocomplete: "none" | "inline" | "list" | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

Inherited from ​

Omit.aria-autocomplete

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:231

aria-busy ​

• Optional aria-busy: Booleanish

Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

Inherited from ​

Omit.aria-busy

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:233

aria-checked ​

• Optional aria-checked: Booleanish | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

See

  • aria-pressed
  • aria-selected.

Inherited from ​

Omit.aria-checked

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:238

aria-colcount ​

• Optional aria-colcount: Numberish

Defines the total number of columns in a table, grid, or treegrid.

See

aria-colindex.

Inherited from ​

Omit.aria-colcount

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:243

aria-colindex ​

• Optional aria-colindex: Numberish

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

See

  • aria-colcount
  • aria-colspan.

Inherited from ​

Omit.aria-colindex

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:248

aria-colspan ​

• Optional aria-colspan: Numberish

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

See

  • aria-colindex
  • aria-rowspan.

Inherited from ​

Omit.aria-colspan

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:253

aria-controls ​

• Optional aria-controls: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

See

aria-owns.

Inherited from ​

Omit.aria-controls

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:258

aria-current ​

• Optional aria-current: "time" | Booleanish | "page" | "step" | "location" | "date"

Indicates the element that represents the current item within a container or set of related elements.

Inherited from ​

Omit.aria-current

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:260

aria-describedby ​

• Optional aria-describedby: string

Identifies the element (or elements) that describes the object.

See

aria-labelledby

Inherited from ​

Omit.aria-describedby

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:265

aria-details ​

• Optional aria-details: string

Identifies the element that provides a detailed, extended description for the object.

See

aria-describedby.

Inherited from ​

Omit.aria-details

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:270

aria-disabled ​

• Optional aria-disabled: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

See

  • aria-hidden
  • aria-readonly.

Inherited from ​

Omit.aria-disabled

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:275

aria-dropeffect ​

• Optional aria-dropeffect: "none" | "copy" | "execute" | "link" | "move" | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.

Deprecated

in ARIA 1.1

Inherited from ​

Omit.aria-dropeffect

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:280

aria-errormessage ​

• Optional aria-errormessage: string

Identifies the element that provides an error message for the object.

See

  • aria-invalid
  • aria-describedby.

Inherited from ​

Omit.aria-errormessage

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:285

aria-expanded ​

• Optional aria-expanded: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

Inherited from ​

Omit.aria-expanded

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:287

aria-flowto ​

• Optional aria-flowto: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

Inherited from ​

Omit.aria-flowto

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:292

aria-grabbed ​

• Optional aria-grabbed: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

Deprecated

in ARIA 1.1

Inherited from ​

Omit.aria-grabbed

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:297

aria-haspopup ​

• Optional aria-haspopup: "tree" | Booleanish | "menu" | "listbox" | "grid" | "dialog"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

Inherited from ​

Omit.aria-haspopup

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:299

aria-hidden ​

• Optional aria-hidden: Booleanish

Indicates whether the element is exposed to an accessibility API.

See

aria-disabled.

Inherited from ​

Omit.aria-hidden

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:304

aria-invalid ​

• Optional aria-invalid: Booleanish | "grammar" | "spelling"

Indicates the entered value does not conform to the format expected by the application.

See

aria-errormessage.

Inherited from ​

Omit.aria-invalid

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:309

aria-keyshortcuts ​

• Optional aria-keyshortcuts: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

Inherited from ​

Omit.aria-keyshortcuts

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:311

aria-label ​

• Optional aria-label: string

Defines a string value that labels the current element.

See

aria-labelledby.

Inherited from ​

Omit.aria-label

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:316

aria-labelledby ​

• Optional aria-labelledby: string

Identifies the element (or elements) that labels the current element.

See

aria-describedby.

Inherited from ​

Omit.aria-labelledby

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:321

aria-level ​

• Optional aria-level: Numberish

Defines the hierarchical level of an element within a structure.

Inherited from ​

Omit.aria-level

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:323

aria-live ​

• Optional aria-live: "off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

Inherited from ​

Omit.aria-live

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:325

aria-modal ​

• Optional aria-modal: Booleanish

Indicates whether an element is modal when displayed.

Inherited from ​

Omit.aria-modal

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:327

aria-multiline ​

• Optional aria-multiline: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

Inherited from ​

Omit.aria-multiline

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:329

aria-multiselectable ​

• Optional aria-multiselectable: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

Inherited from ​

Omit.aria-multiselectable

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:331

aria-orientation ​

• Optional aria-orientation: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

Inherited from ​

Omit.aria-orientation

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:333

aria-owns ​

• Optional aria-owns: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

See

aria-controls.

Inherited from ​

Omit.aria-owns

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:339

aria-placeholder ​

• Optional aria-placeholder: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

Inherited from ​

Omit.aria-placeholder

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:344

aria-posinset ​

• Optional aria-posinset: Numberish

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-setsize.

Inherited from ​

Omit.aria-posinset

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:349

aria-pressed ​

• Optional aria-pressed: Booleanish | "mixed"

Indicates the current "pressed" state of toggle buttons.

See

  • aria-checked
  • aria-selected.

Inherited from ​

Omit.aria-pressed

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:354

aria-readonly ​

• Optional aria-readonly: Booleanish

Indicates that the element is not editable, but is otherwise operable.

See

aria-disabled.

Inherited from ​

Omit.aria-readonly

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:359

aria-relevant ​

• Optional aria-relevant: "additions" | "additions text" | "all" | "removals" | "text"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

See

aria-atomic.

Inherited from ​

Omit.aria-relevant

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:364

aria-required ​

• Optional aria-required: Booleanish

Indicates that user input is required on the element before a form may be submitted.

Inherited from ​

Omit.aria-required

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:366

aria-roledescription ​

• Optional aria-roledescription: string

Defines a human-readable, author-localized description for the role of an element.

Inherited from ​

Omit.aria-roledescription

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:368

aria-rowcount ​

• Optional aria-rowcount: Numberish

Defines the total number of rows in a table, grid, or treegrid.

See

aria-rowindex.

Inherited from ​

Omit.aria-rowcount

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:373

aria-rowindex ​

• Optional aria-rowindex: Numberish

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

See

  • aria-rowcount
  • aria-rowspan.

Inherited from ​

Omit.aria-rowindex

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:378

aria-rowspan ​

• Optional aria-rowspan: Numberish

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

See

  • aria-rowindex
  • aria-colspan.

Inherited from ​

Omit.aria-rowspan

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:383

aria-selected ​

• Optional aria-selected: Booleanish

Indicates the current "selected" state of various widgets.

See

  • aria-checked
  • aria-pressed.

Inherited from ​

Omit.aria-selected

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:388

aria-setsize ​

• Optional aria-setsize: Numberish

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-posinset.

Inherited from ​

Omit.aria-setsize

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:393

aria-sort ​

• Optional aria-sort: "none" | "ascending" | "descending" | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

Inherited from ​

Omit.aria-sort

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:395

aria-valuemax ​

• Optional aria-valuemax: Numberish

Defines the maximum allowed value for a range widget.

Inherited from ​

Omit.aria-valuemax

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:397

aria-valuemin ​

• Optional aria-valuemin: Numberish

Defines the minimum allowed value for a range widget.

Inherited from ​

Omit.aria-valuemin

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:399

aria-valuenow ​

• Optional aria-valuenow: Numberish

Defines the current value for a range widget.

See

aria-valuetext.

Inherited from ​

Omit.aria-valuenow

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:404

aria-valuetext ​

• Optional aria-valuetext: string

Defines the human readable text alternative of aria-valuenow for a range widget.

Inherited from ​

Omit.aria-valuetext

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:406

ascent ​

• Optional ascent: Numberish

Inherited from ​

Omit.ascent

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:966

attributeName ​

• Optional attributeName: string

Inherited from ​

Omit.attributeName

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:967

attributeType ​

• Optional attributeType: string

Inherited from ​

Omit.attributeType

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:968

autoReverse ​

• Optional autoReverse: Numberish

Inherited from ​

Omit.autoReverse

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:969

azimuth ​

• Optional azimuth: Numberish

Inherited from ​

Omit.azimuth

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:970

baseFrequency ​

• Optional baseFrequency: Numberish

Inherited from ​

Omit.baseFrequency

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:971

baseProfile ​

• Optional baseProfile: Numberish

Inherited from ​

Omit.baseProfile

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:973

baseline-shift ​

• Optional baseline-shift: Numberish

Inherited from ​

Omit.baseline-shift

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:972

bbox ​

• Optional bbox: Numberish

Inherited from ​

Omit.bbox

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:974

begin ​

• Optional begin: Numberish

Inherited from ​

Omit.begin

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:975

bias ​

• Optional bias: Numberish

Inherited from ​

Omit.bias

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:976

by ​

• Optional by: Numberish

Inherited from ​

Omit.by

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:977

calcMode ​

• Optional calcMode: Numberish

Inherited from ​

Omit.calcMode

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:978

cap-height ​

• Optional cap-height: Numberish

Inherited from ​

Omit.cap-height

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:979

class ​

• Optional class: any

SVG Styling Attributes

See

https://www.w3.org/TR/SVG/styling.html#ElementSpecificStyling

Inherited from ​

Omit.class

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:924

clip ​

• Optional clip: Numberish

Inherited from ​

Omit.clip

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:980

clip-path ​

• Optional clip-path: string

Inherited from ​

Omit.clip-path

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:981

clip-rule ​

• Optional clip-rule: Numberish

Inherited from ​

Omit.clip-rule

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:983

clipPathUnits ​

• Optional clipPathUnits: Numberish

Inherited from ​

Omit.clipPathUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:982

color ​

• Optional color: string

Inherited from ​

Omit.color

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:927

color-interpolation ​

• Optional color-interpolation: Numberish

Inherited from ​

Omit.color-interpolation

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:984

color-interpolation-filters ​

• Optional color-interpolation-filters: "auto" | "inherit" | "sRGB" | "linearRGB"

Inherited from ​

Omit.color-interpolation-filters

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:985

color-profile ​

• Optional color-profile: Numberish

Inherited from ​

Omit.color-profile

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:986

color-rendering ​

• Optional color-rendering: Numberish

Inherited from ​

Omit.color-rendering

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:987

contentScriptType ​

• Optional contentScriptType: Numberish

Inherited from ​

Omit.contentScriptType

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:988

contentStyleType ​

• Optional contentStyleType: Numberish

Inherited from ​

Omit.contentStyleType

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:989

cursor ​

• Optional cursor: Numberish

Inherited from ​

Omit.cursor

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:990

cx ​

• Optional cx: Numberish

Inherited from ​

Omit.cx

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:991

cy ​

• Optional cy: Numberish

Inherited from ​

Omit.cy

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:992

d ​

• Optional d: string

Inherited from ​

Omit.d

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:993

decelerate ​

• Optional decelerate: Numberish

Inherited from ​

Omit.decelerate

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:994

descent ​

• Optional descent: Numberish

Inherited from ​

Omit.descent

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:995

diffuseConstant ​

• Optional diffuseConstant: Numberish

Inherited from ​

Omit.diffuseConstant

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:996

direction ​

• Optional direction: Numberish

Inherited from ​

Omit.direction

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:997

display ​

• Optional display: Numberish

Inherited from ​

Omit.display

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:998

divisor ​

• Optional divisor: Numberish

Inherited from ​

Omit.divisor

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:999

dominant-baseline ​

• Optional dominant-baseline: Numberish

Inherited from ​

Omit.dominant-baseline

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1000

dur ​

• Optional dur: Numberish

Inherited from ​

Omit.dur

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1001

dx ​

• Optional dx: Numberish

Inherited from ​

Omit.dx

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1002

dy ​

• Optional dy: Numberish

Inherited from ​

Omit.dy

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1003

edgeMode ​

• Optional edgeMode: Numberish

Inherited from ​

Omit.edgeMode

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1004

elevation ​

• Optional elevation: Numberish

Inherited from ​

Omit.elevation

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1005

enable-background ​

• Optional enable-background: Numberish

Inherited from ​

Omit.enable-background

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1006

end ​

• Optional end: Numberish

Inherited from ​

Omit.end

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1007

endNode ​

• endNode: GenericTreeNode

Defined in ​

profectus/src/features/trees/tree.ts:176

exponent ​

• Optional exponent: Numberish

Inherited from ​

Omit.exponent

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1008

externalResourcesRequired ​

• Optional externalResourcesRequired: Numberish

Inherited from ​

Omit.externalResourcesRequired

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1009

fill ​

• Optional fill: string

Inherited from ​

Omit.fill

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1010

fill-opacity ​

• Optional fill-opacity: Numberish

Inherited from ​

Omit.fill-opacity

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1011

fill-rule ​

• Optional fill-rule: "inherit" | "nonzero" | "evenodd"

Inherited from ​

Omit.fill-rule

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1012

filter ​

• Optional filter: string

Inherited from ​

Omit.filter

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1013

filterRes ​

• Optional filterRes: Numberish

Inherited from ​

Omit.filterRes

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1014

filterUnits ​

• Optional filterUnits: Numberish

Inherited from ​

Omit.filterUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1015

flood-color ​

• Optional flood-color: Numberish

Inherited from ​

Omit.flood-color

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1016

flood-opacity ​

• Optional flood-opacity: Numberish

Inherited from ​

Omit.flood-opacity

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1017

focusable ​

• Optional focusable: Numberish

Inherited from ​

Omit.focusable

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1018

font-family ​

• Optional font-family: string

Inherited from ​

Omit.font-family

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1019

font-size ​

• Optional font-size: Numberish

Inherited from ​

Omit.font-size

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1020

font-size-adjust ​

• Optional font-size-adjust: Numberish

Inherited from ​

Omit.font-size-adjust

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1021

font-stretch ​

• Optional font-stretch: Numberish

Inherited from ​

Omit.font-stretch

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1022

font-style ​

• Optional font-style: Numberish

Inherited from ​

Omit.font-style

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1023

font-variant ​

• Optional font-variant: Numberish

Inherited from ​

Omit.font-variant

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1024

font-weight ​

• Optional font-weight: Numberish

Inherited from ​

Omit.font-weight

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1025

format ​

• Optional format: Numberish

Inherited from ​

Omit.format

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1026

from ​

• Optional from: Numberish

Inherited from ​

Omit.from

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1027

fx ​

• Optional fx: Numberish

Inherited from ​

Omit.fx

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1028

fy ​

• Optional fy: Numberish

Inherited from ​

Omit.fy

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1029

g1 ​

• Optional g1: Numberish

Inherited from ​

Omit.g1

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1030

g2 ​

• Optional g2: Numberish

Inherited from ​

Omit.g2

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1031

glyph-name ​

• Optional glyph-name: Numberish

Inherited from ​

Omit.glyph-name

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1032

glyph-orientation-horizontal ​

• Optional glyph-orientation-horizontal: Numberish

Inherited from ​

Omit.glyph-orientation-horizontal

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1033

glyph-orientation-vertical ​

• Optional glyph-orientation-vertical: Numberish

Inherited from ​

Omit.glyph-orientation-vertical

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1034

glyphRef ​

• Optional glyphRef: Numberish

Inherited from ​

Omit.glyphRef

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1035

gradientTransform ​

• Optional gradientTransform: string

Inherited from ​

Omit.gradientTransform

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1036

gradientUnits ​

• Optional gradientUnits: string

Inherited from ​

Omit.gradientUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1037

hanging ​

• Optional hanging: Numberish

Inherited from ​

Omit.hanging

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1038

height ​

• Optional height: Numberish

Inherited from ​

Omit.height

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:928

horiz-adv-x ​

• Optional horiz-adv-x: Numberish

Inherited from ​

Omit.horiz-adv-x

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1039

horiz-origin-x ​

• Optional horiz-origin-x: Numberish

Inherited from ​

Omit.horiz-origin-x

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1040

href ​

• Optional href: string

Inherited from ​

Omit.href

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1041

id ​

• Optional id: string

Inherited from ​

Omit.id

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:929

ideographic ​

• Optional ideographic: Numberish

Inherited from ​

Omit.ideographic

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1042

image-rendering ​

• Optional image-rendering: Numberish

Inherited from ​

Omit.image-rendering

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1043

in ​

• Optional in: string

Inherited from ​

Omit.in

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1045

in2 ​

• Optional in2: Numberish

Inherited from ​

Omit.in2

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1044

innerHTML ​

• Optional innerHTML: string

Inherited from ​

Omit.innerHTML

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:918

intercept ​

• Optional intercept: Numberish

Inherited from ​

Omit.intercept

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1046

k ​

• Optional k: Numberish

Inherited from ​

Omit.k

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1051

k1 ​

• Optional k1: Numberish

Inherited from ​

Omit.k1

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1047

k2 ​

• Optional k2: Numberish

Inherited from ​

Omit.k2

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1048

k3 ​

• Optional k3: Numberish

Inherited from ​

Omit.k3

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1049

k4 ​

• Optional k4: Numberish

Inherited from ​

Omit.k4

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1050

kernelMatrix ​

• Optional kernelMatrix: Numberish

Inherited from ​

Omit.kernelMatrix

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1052

kernelUnitLength ​

• Optional kernelUnitLength: Numberish

Inherited from ​

Omit.kernelUnitLength

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1053

kerning ​

• Optional kerning: Numberish

Inherited from ​

Omit.kerning

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1054

keyPoints ​

• Optional keyPoints: Numberish

Inherited from ​

Omit.keyPoints

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1055

keySplines ​

• Optional keySplines: Numberish

Inherited from ​

Omit.keySplines

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1056

keyTimes ​

• Optional keyTimes: Numberish

Inherited from ​

Omit.keyTimes

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1057

lang ​

• Optional lang: string

Inherited from ​

Omit.lang

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:930

lengthAdjust ​

• Optional lengthAdjust: Numberish

Inherited from ​

Omit.lengthAdjust

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1058

letter-spacing ​

• Optional letter-spacing: Numberish

Inherited from ​

Omit.letter-spacing

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1059

lighting-color ​

• Optional lighting-color: Numberish

Inherited from ​

Omit.lighting-color

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1060

limitingConeAngle ​

• Optional limitingConeAngle: Numberish

Inherited from ​

Omit.limitingConeAngle

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1061

local ​

• Optional local: Numberish

Inherited from ​

Omit.local

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1062

marker-end ​

• Optional marker-end: string

Inherited from ​

Omit.marker-end

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1063

marker-mid ​

• Optional marker-mid: string

Inherited from ​

Omit.marker-mid

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1065

marker-start ​

• Optional marker-start: string

Inherited from ​

Omit.marker-start

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1066

markerHeight ​

• Optional markerHeight: Numberish

Inherited from ​

Omit.markerHeight

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1064

markerUnits ​

• Optional markerUnits: Numberish

Inherited from ​

Omit.markerUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1067

markerWidth ​

• Optional markerWidth: Numberish

Inherited from ​

Omit.markerWidth

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1068

mask ​

• Optional mask: string

Inherited from ​

Omit.mask

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1069

maskContentUnits ​

• Optional maskContentUnits: Numberish

Inherited from ​

Omit.maskContentUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1070

maskUnits ​

• Optional maskUnits: Numberish

Inherited from ​

Omit.maskUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1071

mathematical ​

• Optional mathematical: Numberish

Inherited from ​

Omit.mathematical

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1072

max ​

• Optional max: Numberish

Inherited from ​

Omit.max

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:931

media ​

• Optional media: string

Inherited from ​

Omit.media

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:932

method ​

• Optional method: string

Inherited from ​

Omit.method

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:933

min ​

• Optional min: Numberish

Inherited from ​

Omit.min

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:934

mode ​

• Optional mode: Numberish

Inherited from ​

Omit.mode

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1073

name ​

• Optional name: string

Inherited from ​

Omit.name

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:935

numOctaves ​

• Optional numOctaves: Numberish

Inherited from ​

Omit.numOctaves

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1074

offset ​

• Optional offset: Numberish

Inherited from ​

Omit.offset

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1075

offsetEnd ​

• Optional offsetEnd: Position

Inherited from ​

Omit.offsetEnd

Defined in ​

profectus/src/features/links/links.ts:18

offsetStart ​

• Optional offsetStart: Position

Inherited from ​

Omit.offsetStart

Defined in ​

profectus/src/features/links/links.ts:17

onAbort ​

• Optional onAbort: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onAbort

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1432

onAnimationend ​

• Optional onAnimationend: (payload: AnimationEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadAnimationEvent
Returns ​

void

Inherited from ​

Omit.onAnimationend

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1482

onAnimationiteration ​

• Optional onAnimationiteration: (payload: AnimationEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadAnimationEvent
Returns ​

void

Inherited from ​

Omit.onAnimationiteration

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1483

onAnimationstart ​

• Optional onAnimationstart: (payload: AnimationEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadAnimationEvent
Returns ​

void

Inherited from ​

Omit.onAnimationstart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1481

onAuxclick ​

• Optional onAuxclick: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onAuxclick

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1419

onBeforeinput ​

• Optional onBeforeinput: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onBeforeinput

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1403

onBlur ​

• Optional onBlur: (payload: FocusEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadFocusEvent
Returns ​

void

Inherited from ​

Omit.onBlur

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1399

onCanplay ​

• Optional onCanplay: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onCanplay

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1433

onCanplaythrough ​

• Optional onCanplaythrough: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onCanplaythrough

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1434

onChange ​

• Optional onChange: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onChange

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1402

onClick ​

• Optional onClick: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onClick

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1420

onCompositionend ​

• Optional onCompositionend: (payload: CompositionEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadCompositionEvent
Returns ​

void

Inherited from ​

Omit.onCompositionend

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1381

onCompositionstart ​

• Optional onCompositionstart: (payload: CompositionEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadCompositionEvent
Returns ​

void

Inherited from ​

Omit.onCompositionstart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1382

onCompositionupdate ​

• Optional onCompositionupdate: (payload: CompositionEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadCompositionEvent
Returns ​

void

Inherited from ​

Omit.onCompositionupdate

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1383

onContextmenu ​

• Optional onContextmenu: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onContextmenu

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1421

onCopy ​

• Optional onCopy: (payload: ClipboardEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadClipboardEvent
Returns ​

void

Inherited from ​

Omit.onCopy

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1376

onCut ​

• Optional onCut: (payload: ClipboardEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadClipboardEvent
Returns ​

void

Inherited from ​

Omit.onCut

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1377

onDblclick ​

• Optional onDblclick: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onDblclick

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1422

onDrag ​

• Optional onDrag: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

Omit.onDrag

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1386

onDragend ​

• Optional onDragend: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

Omit.onDragend

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1387

onDragenter ​

• Optional onDragenter: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

Omit.onDragenter

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1388

onDragexit ​

• Optional onDragexit: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

Omit.onDragexit

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1389

onDragleave ​

• Optional onDragleave: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

Omit.onDragleave

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1390

onDragover ​

• Optional onDragover: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

Omit.onDragover

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1391

onDragstart ​

• Optional onDragstart: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

Omit.onDragstart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1392

onDrop ​

• Optional onDrop: (payload: DragEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadDragEvent
Returns ​

void

Inherited from ​

Omit.onDrop

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1393

onDurationchange ​

• Optional onDurationchange: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onDurationchange

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1435

onEmptied ​

• Optional onEmptied: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onEmptied

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1436

onEncrypted ​

• Optional onEncrypted: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onEncrypted

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1437

onEnded ​

• Optional onEnded: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onEnded

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1438

onError ​

• Optional onError: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onError

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1411

onFocus ​

• Optional onFocus: (payload: FocusEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadFocusEvent
Returns ​

void

Inherited from ​

Omit.onFocus

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1396

onFocusin ​

• Optional onFocusin: (payload: FocusEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadFocusEvent
Returns ​

void

Inherited from ​

Omit.onFocusin

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1397

onFocusout ​

• Optional onFocusout: (payload: FocusEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadFocusEvent
Returns ​

void

Inherited from ​

Omit.onFocusout

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1398

onInput ​

• Optional onInput: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onInput

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1404

onInvalid ​

• Optional onInvalid: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onInvalid

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1407

onKeydown ​

• Optional onKeydown: (payload: KeyboardEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadKeyboardEvent
Returns ​

void

Inherited from ​

Omit.onKeydown

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1414

onKeypress ​

• Optional onKeypress: (payload: KeyboardEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadKeyboardEvent
Returns ​

void

Inherited from ​

Omit.onKeypress

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1415

onKeyup ​

• Optional onKeyup: (payload: KeyboardEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadKeyboardEvent
Returns ​

void

Inherited from ​

Omit.onKeyup

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1416

onLoad ​

• Optional onLoad: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onLoad

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1410

onLoadeddata ​

• Optional onLoadeddata: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onLoadeddata

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1439

onLoadedmetadata ​

• Optional onLoadedmetadata: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onLoadedmetadata

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1440

onLoadstart ​

• Optional onLoadstart: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onLoadstart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1441

onMousedown ​

• Optional onMousedown: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onMousedown

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1423

onMouseenter ​

• Optional onMouseenter: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onMouseenter

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1424

onMouseleave ​

• Optional onMouseleave: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onMouseleave

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1425

onMousemove ​

• Optional onMousemove: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onMousemove

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1426

onMouseout ​

• Optional onMouseout: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onMouseout

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1427

onMouseover ​

• Optional onMouseover: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onMouseover

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1428

onMouseup ​

• Optional onMouseup: (payload: MouseEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadMouseEvent
Returns ​

void

Inherited from ​

Omit.onMouseup

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1429

onPaste ​

• Optional onPaste: (payload: ClipboardEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadClipboardEvent
Returns ​

void

Inherited from ​

Omit.onPaste

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1378

onPause ​

• Optional onPause: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onPause

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1442

onPlay ​

• Optional onPlay: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onPlay

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1443

onPlaying ​

• Optional onPlaying: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onPlaying

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1444

onPointercancel ​

• Optional onPointercancel: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

Omit.onPointercancel

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1471

onPointerdown ​

• Optional onPointerdown: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

Omit.onPointerdown

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1468

onPointerenter ​

• Optional onPointerenter: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

Omit.onPointerenter

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1472

onPointerleave ​

• Optional onPointerleave: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

Omit.onPointerleave

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1473

onPointermove ​

• Optional onPointermove: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

Omit.onPointermove

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1469

onPointerout ​

• Optional onPointerout: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

Omit.onPointerout

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1475

onPointerover ​

• Optional onPointerover: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

Omit.onPointerover

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1474

onPointerup ​

• Optional onPointerup: (payload: PointerEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadPointerEvent
Returns ​

void

Inherited from ​

Omit.onPointerup

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1470

onProgress ​

• Optional onProgress: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onProgress

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1445

onRatechange ​

• Optional onRatechange: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onRatechange

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1446

onReset ​

• Optional onReset: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onReset

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1405

onScroll ​

• Optional onScroll: (payload: UIEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadUIEvent
Returns ​

void

Inherited from ​

Omit.onScroll

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1459

onSeeked ​

• Optional onSeeked: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onSeeked

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1447

onSeeking ​

• Optional onSeeking: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onSeeking

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1448

onSelect ​

• Optional onSelect: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onSelect

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1456

onStalled ​

• Optional onStalled: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onStalled

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1449

onSubmit ​

• Optional onSubmit: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onSubmit

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1406

onSuspend ​

• Optional onSuspend: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onSuspend

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1450

onTimeupdate ​

• Optional onTimeupdate: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onTimeupdate

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1451

onTouchcancel ​

• Optional onTouchcancel: (payload: TouchEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadTouchEvent
Returns ​

void

Inherited from ​

Omit.onTouchcancel

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1462

onTouchend ​

• Optional onTouchend: (payload: TouchEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadTouchEvent
Returns ​

void

Inherited from ​

Omit.onTouchend

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1463

onTouchmove ​

• Optional onTouchmove: (payload: TouchEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadTouchEvent
Returns ​

void

Inherited from ​

Omit.onTouchmove

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1464

onTouchstart ​

• Optional onTouchstart: (payload: TouchEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadTouchEvent
Returns ​

void

Inherited from ​

Omit.onTouchstart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1465

onTransitionend ​

• Optional onTransitionend: (payload: TransitionEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadTransitionEvent
Returns ​

void

Inherited from ​

Omit.onTransitionend

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1486

onTransitionstart ​

• Optional onTransitionstart: (payload: TransitionEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadTransitionEvent
Returns ​

void

Inherited from ​

Omit.onTransitionstart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1487

onVolumechange ​

• Optional onVolumechange: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onVolumechange

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1452

onWaiting ​

• Optional onWaiting: (payload: Event) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadEvent
Returns ​

void

Inherited from ​

Omit.onWaiting

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1453

onWheel ​

• Optional onWheel: (payload: WheelEvent) => void

Type declaration ​

â–¸ (payload): void

Parameters ​
NameType
payloadWheelEvent
Returns ​

void

Inherited from ​

Omit.onWheel

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1478

opacity ​

• Optional opacity: Numberish

Inherited from ​

Omit.opacity

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1076

operator ​

• Optional operator: Numberish

Inherited from ​

Omit.operator

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1077

order ​

• Optional order: Numberish

Inherited from ​

Omit.order

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1078

orient ​

• Optional orient: Numberish

Inherited from ​

Omit.orient

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1079

orientation ​

• Optional orientation: Numberish

Inherited from ​

Omit.orientation

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1080

origin ​

• Optional origin: Numberish

Inherited from ​

Omit.origin

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1081

overflow ​

• Optional overflow: Numberish

Inherited from ​

Omit.overflow

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1082

overline-position ​

• Optional overline-position: Numberish

Inherited from ​

Omit.overline-position

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1083

overline-thickness ​

• Optional overline-thickness: Numberish

Inherited from ​

Omit.overline-thickness

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1084

paint-order ​

• Optional paint-order: Numberish

Inherited from ​

Omit.paint-order

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1085

panose-1 ​

• Optional panose-1: Numberish

Inherited from ​

Omit.panose-1

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1086

pathLength ​

• Optional pathLength: Numberish

Inherited from ​

Omit.pathLength

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1087

patternContentUnits ​

• Optional patternContentUnits: string

Inherited from ​

Omit.patternContentUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1088

patternTransform ​

• Optional patternTransform: Numberish

Inherited from ​

Omit.patternTransform

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1089

patternUnits ​

• Optional patternUnits: string

Inherited from ​

Omit.patternUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1090

pointer-events ​

• Optional pointer-events: Numberish

Inherited from ​

Omit.pointer-events

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1091

points ​

• Optional points: string

Inherited from ​

Omit.points

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1092

pointsAtX ​

• Optional pointsAtX: Numberish

Inherited from ​

Omit.pointsAtX

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1093

pointsAtY ​

• Optional pointsAtY: Numberish

Inherited from ​

Omit.pointsAtY

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1094

pointsAtZ ​

• Optional pointsAtZ: Numberish

Inherited from ​

Omit.pointsAtZ

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1095

preserveAlpha ​

• Optional preserveAlpha: Numberish

Inherited from ​

Omit.preserveAlpha

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1096

preserveAspectRatio ​

• Optional preserveAspectRatio: string

Inherited from ​

Omit.preserveAspectRatio

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1097

primitiveUnits ​

• Optional primitiveUnits: Numberish

Inherited from ​

Omit.primitiveUnits

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1098

r ​

• Optional r: Numberish

Inherited from ​

Omit.r

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1099

radius ​

• Optional radius: Numberish

Inherited from ​

Omit.radius

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1100

refX ​

• Optional refX: Numberish

Inherited from ​

Omit.refX

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1101

refY ​

• Optional refY: Numberish

Inherited from ​

Omit.refY

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1102

renderingIntent ​

• Optional renderingIntent: Numberish

Inherited from ​

Omit.renderingIntent

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1103

repeatCount ​

• Optional repeatCount: Numberish

Inherited from ​

Omit.repeatCount

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1104

repeatDur ​

• Optional repeatDur: Numberish

Inherited from ​

Omit.repeatDur

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1105

requiredExtensions ​

• Optional requiredExtensions: Numberish

Inherited from ​

Omit.requiredExtensions

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1106

requiredFeatures ​

• Optional requiredFeatures: Numberish

Inherited from ​

Omit.requiredFeatures

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1107

restart ​

• Optional restart: Numberish

Inherited from ​

Omit.restart

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1108

result ​

• Optional result: string

Inherited from ​

Omit.result

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1109

role ​

• Optional role: string

Inherited from ​

Omit.role

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:941

rotate ​

• Optional rotate: Numberish

Inherited from ​

Omit.rotate

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1110

rx ​

• Optional rx: Numberish

Inherited from ​

Omit.rx

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1111

ry ​

• Optional ry: Numberish

Inherited from ​

Omit.ry

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1112

scale ​

• Optional scale: Numberish

Inherited from ​

Omit.scale

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1113

seed ​

• Optional seed: Numberish

Inherited from ​

Omit.seed

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1114

shape-rendering ​

• Optional shape-rendering: Numberish

Inherited from ​

Omit.shape-rendering

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1115

slope ​

• Optional slope: Numberish

Inherited from ​

Omit.slope

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1116

spacing ​

• Optional spacing: Numberish

Inherited from ​

Omit.spacing

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1117

specularConstant ​

• Optional specularConstant: Numberish

Inherited from ​

Omit.specularConstant

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1118

specularExponent ​

• Optional specularExponent: Numberish

Inherited from ​

Omit.specularExponent

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1119

speed ​

• Optional speed: Numberish

Inherited from ​

Omit.speed

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1120

spreadMethod ​

• Optional spreadMethod: string

Inherited from ​

Omit.spreadMethod

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1121

startNode ​

• startNode: GenericTreeNode

Defined in ​

profectus/src/features/trees/tree.ts:175

startOffset ​

• Optional startOffset: Numberish

Inherited from ​

Omit.startOffset

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1122

stdDeviation ​

• Optional stdDeviation: Numberish

Inherited from ​

Omit.stdDeviation

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1123

stemh ​

• Optional stemh: Numberish

Inherited from ​

Omit.stemh

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1124

stemv ​

• Optional stemv: Numberish

Inherited from ​

Omit.stemv

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1125

stitchTiles ​

• Optional stitchTiles: Numberish

Inherited from ​

Omit.stitchTiles

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1126

stop-color ​

• Optional stop-color: string

Inherited from ​

Omit.stop-color

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1127

stop-opacity ​

• Optional stop-opacity: Numberish

Inherited from ​

Omit.stop-opacity

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1128

strikethrough-position ​

• Optional strikethrough-position: Numberish

Inherited from ​

Omit.strikethrough-position

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1129

strikethrough-thickness ​

• Optional strikethrough-thickness: Numberish

Inherited from ​

Omit.strikethrough-thickness

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1130

string ​

• Optional string: Numberish

Inherited from ​

Omit.string

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1131

stroke ​

• Optional stroke: string

Inherited from ​

Omit.stroke

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1132

stroke-dasharray ​

• Optional stroke-dasharray: Numberish

Inherited from ​

Omit.stroke-dasharray

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1133

stroke-dashoffset ​

• Optional stroke-dashoffset: Numberish

Inherited from ​

Omit.stroke-dashoffset

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1134

stroke-linecap ​

• Optional stroke-linecap: "inherit" | "butt" | "round" | "square"

Inherited from ​

Omit.stroke-linecap

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1135

stroke-linejoin ​

• Optional stroke-linejoin: "inherit" | "round" | "miter" | "bevel"

Inherited from ​

Omit.stroke-linejoin

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1136

stroke-miterlimit ​

• Optional stroke-miterlimit: Numberish

Inherited from ​

Omit.stroke-miterlimit

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1137

stroke-opacity ​

• Optional stroke-opacity: Numberish

Inherited from ​

Omit.stroke-opacity

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1138

stroke-width ​

• Optional stroke-width: Numberish

Inherited from ​

Omit.stroke-width

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1139

style ​

• Optional style: string | CSSProperties

Inherited from ​

Omit.style

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:925

surfaceScale ​

• Optional surfaceScale: Numberish

Inherited from ​

Omit.surfaceScale

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1140

systemLanguage ​

• Optional systemLanguage: Numberish

Inherited from ​

Omit.systemLanguage

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1141

tabindex ​

• Optional tabindex: Numberish

Inherited from ​

Omit.tabindex

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:942

tableValues ​

• Optional tableValues: Numberish

Inherited from ​

Omit.tableValues

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1142

target ​

• Optional target: string

Inherited from ​

Omit.target

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:936

targetX ​

• Optional targetX: Numberish

Inherited from ​

Omit.targetX

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1143

targetY ​

• Optional targetY: Numberish

Inherited from ​

Omit.targetY

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1144

text-anchor ​

• Optional text-anchor: string

Inherited from ​

Omit.text-anchor

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1145

text-decoration ​

• Optional text-decoration: Numberish

Inherited from ​

Omit.text-decoration

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1146

text-rendering ​

• Optional text-rendering: Numberish

Inherited from ​

Omit.text-rendering

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1148

textLength ​

• Optional textLength: Numberish

Inherited from ​

Omit.textLength

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1147

to ​

• Optional to: Numberish

Inherited from ​

Omit.to

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1149

transform ​

• Optional transform: string

Inherited from ​

Omit.transform

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1150

type ​

• Optional type: string

Inherited from ​

Omit.type

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:937

u1 ​

• Optional u1: Numberish

Inherited from ​

Omit.u1

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1151

u2 ​

• Optional u2: Numberish

Inherited from ​

Omit.u2

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1152

underline-position ​

• Optional underline-position: Numberish

Inherited from ​

Omit.underline-position

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1153

underline-thickness ​

• Optional underline-thickness: Numberish

Inherited from ​

Omit.underline-thickness

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1154

unicode ​

• Optional unicode: Numberish

Inherited from ​

Omit.unicode

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1155

unicode-bidi ​

• Optional unicode-bidi: Numberish

Inherited from ​

Omit.unicode-bidi

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1156

unicode-range ​

• Optional unicode-range: Numberish

Inherited from ​

Omit.unicode-range

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1157

unitsPer-em ​

• Optional unitsPer-em: Numberish

Inherited from ​

Omit.unitsPer-em

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1158

v-alphabetic ​

• Optional v-alphabetic: Numberish

Inherited from ​

Omit.v-alphabetic

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1159

v-hanging ​

• Optional v-hanging: Numberish

Inherited from ​

Omit.v-hanging

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1166

v-ideographic ​

• Optional v-ideographic: Numberish

Inherited from ​

Omit.v-ideographic

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1167

v-mathematical ​

• Optional v-mathematical: Numberish

Inherited from ​

Omit.v-mathematical

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1171

values ​

• Optional values: string

Inherited from ​

Omit.values

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1160

vector-effect ​

• Optional vector-effect: Numberish

Inherited from ​

Omit.vector-effect

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1161

version ​

• Optional version: string

Inherited from ​

Omit.version

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1162

vert-adv-y ​

• Optional vert-adv-y: Numberish

Inherited from ​

Omit.vert-adv-y

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1163

vert-origin-x ​

• Optional vert-origin-x: Numberish

Inherited from ​

Omit.vert-origin-x

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1164

vert-origin-y ​

• Optional vert-origin-y: Numberish

Inherited from ​

Omit.vert-origin-y

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1165

viewBox ​

• Optional viewBox: string

Inherited from ​

Omit.viewBox

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1168

viewTarget ​

• Optional viewTarget: Numberish

Inherited from ​

Omit.viewTarget

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1169

visibility ​

• Optional visibility: Numberish

Inherited from ​

Omit.visibility

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1170

width ​

• Optional width: Numberish

Inherited from ​

Omit.width

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:938

widths ​

• Optional widths: Numberish

Inherited from ​

Omit.widths

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1172

word-spacing ​

• Optional word-spacing: Numberish

Inherited from ​

Omit.word-spacing

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1173

writing-mode ​

• Optional writing-mode: Numberish

Inherited from ​

Omit.writing-mode

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1174

x ​

• Optional x: Numberish

Inherited from ​

Omit.x

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1177

x-height ​

• Optional x-height: Numberish

Inherited from ​

Omit.x-height

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1179

x1 ​

• Optional x1: Numberish

Inherited from ​

Omit.x1

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1175

x2 ​

• Optional x2: Numberish

Inherited from ​

Omit.x2

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1176

xChannelSelector ​

• Optional xChannelSelector: string

Inherited from ​

Omit.xChannelSelector

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1178

xlinkActuate ​

• Optional xlinkActuate: string

Inherited from ​

Omit.xlinkActuate

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1180

xlinkArcrole ​

• Optional xlinkArcrole: string

Inherited from ​

Omit.xlinkArcrole

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1181

xlinkHref ​

• Optional xlinkHref: string

Inherited from ​

Omit.xlinkHref

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1182

xlinkRole ​

• Optional xlinkRole: string

Inherited from ​

Omit.xlinkRole

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1183

xlinkShow ​

• Optional xlinkShow: string

Inherited from ​

Omit.xlinkShow

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1184

xlinkTitle ​

• Optional xlinkTitle: string

Inherited from ​

Omit.xlinkTitle

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1185

xlinkType ​

• Optional xlinkType: string

Inherited from ​

Omit.xlinkType

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1186

xmlns ​

• Optional xmlns: string

Inherited from ​

Omit.xmlns

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1187

y ​

• Optional y: Numberish

Inherited from ​

Omit.y

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1190

y1 ​

• Optional y1: Numberish

Inherited from ​

Omit.y1

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1188

y2 ​

• Optional y2: Numberish

Inherited from ​

Omit.y2

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1189

yChannelSelector ​

• Optional yChannelSelector: string

Inherited from ​

Omit.yChannelSelector

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1191

z ​

• Optional z: Numberish

Inherited from ​

Omit.z

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1192

zoomAndPan ​

• Optional zoomAndPan: string

Inherited from ​

Omit.zoomAndPan

Defined in ​

node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts:1193

- diff --git a/api/interfaces/features/trees/tree.TreeNodeOptions.html b/api/interfaces/features/trees/tree.TreeNodeOptions.html index 2ab54317..1e3d2a31 100644 --- a/api/interfaces/features/trees/tree.TreeNodeOptions.html +++ b/api/interfaces/features/trees/tree.TreeNodeOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: TreeNodeOptions ​

features/trees/tree.TreeNodeOptions

An object that configures a TreeNode.

Hierarchy ​

Properties ​

canClick ​

• Optional canClick: Computable<boolean>

Whether or not this tree node can be clicked.

Defined in ​

profectus/src/features/trees/tree.ts:40

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Defined in ​

profectus/src/features/trees/tree.ts:48

color ​

• Optional color: Computable<string>

The background color for this node.

Defined in ​

profectus/src/features/trees/tree.ts:42

display ​

• Optional display: Computable<CoercableComponent>

The label to display on this tree node.

Defined in ​

profectus/src/features/trees/tree.ts:44

glowColor ​

• Optional glowColor: Computable<string>

The color of the glow effect shown to notify the user there's something to do with this node.

Defined in ​

profectus/src/features/trees/tree.ts:46

mark ​

• Optional mark: Computable<string | boolean>

Shows a marker on the corner of the feature.

Defined in ​

profectus/src/features/trees/tree.ts:52

onClick ​

• Optional onClick: (e?: MouseEvent | TouchEvent) => void

Type declaration ​

â–¸ (e?): void

A function that is called when the tree node is clicked.

Parameters ​
NameType
e?MouseEvent | TouchEvent
Returns ​

void

Defined in ​

profectus/src/features/trees/tree.ts:56

onHold ​

• Optional onHold: VoidFunction

A function that is called when the tree node is held down.

Defined in ​

profectus/src/features/trees/tree.ts:58

reset ​

• Optional reset: GenericReset

A reset object attached to this node, used for propagating resets through the tree.

Defined in ​

profectus/src/features/trees/tree.ts:54

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Defined in ​

profectus/src/features/trees/tree.ts:50

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this tree node should be visible.

Defined in ​

profectus/src/features/trees/tree.ts:38

- diff --git a/api/interfaces/features/trees/tree.TreeOptions.html b/api/interfaces/features/trees/tree.TreeOptions.html index 5715e88c..79a503f9 100644 --- a/api/interfaces/features/trees/tree.TreeOptions.html +++ b/api/interfaces/features/trees/tree.TreeOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: TreeOptions ​

features/trees/tree.TreeOptions

An object that configures a Tree.

Properties ​

branches ​

• Optional branches: Computable<TreeBranch[]>

The branches between nodes within this tree.

Defined in ​

profectus/src/features/trees/tree.ts:192

leftSideNodes ​

• Optional leftSideNodes: Computable<GenericTreeNode[]>

Nodes to show on the left side of the tree.

Defined in ​

profectus/src/features/trees/tree.ts:188

nodes ​

• nodes: Computable<GenericTreeNode[][]>

The nodes within the tree, in a 2D array.

Defined in ​

profectus/src/features/trees/tree.ts:186

onReset ​

• Optional onReset: (node: GenericTreeNode) => void

Type declaration ​

â–¸ (node): void

A function that is called when a node within the tree is reset.

Parameters ​
NameType
nodeGenericTreeNode
Returns ​

void

Defined in ​

profectus/src/features/trees/tree.ts:196

resetPropagation ​

• Optional resetPropagation: ResetPropagation

How to propagate resets through the tree.

Defined in ​

profectus/src/features/trees/tree.ts:194

rightSideNodes ​

• Optional rightSideNodes: Computable<GenericTreeNode[]>

Nodes to show on the right side of the tree.

Defined in ​

profectus/src/features/trees/tree.ts:190

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this clickable should be visible.

Defined in ​

profectus/src/features/trees/tree.ts:184

- diff --git a/api/interfaces/features/upgrades/upgrade.BaseUpgrade.html b/api/interfaces/features/upgrades/upgrade.BaseUpgrade.html index 49374aea..1bc4da59 100644 --- a/api/interfaces/features/upgrades/upgrade.BaseUpgrade.html +++ b/api/interfaces/features/upgrades/upgrade.BaseUpgrade.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseUpgrade ​

features/upgrades/upgrade.BaseUpgrade

The properties that are added onto a processed UpgradeOptions to create an Upgrade.

Properties ​

[Component] ​

• [Component]: GenericComponent

The Vue component used to render this feature.

Defined in ​

profectus/src/features/upgrades/upgrade.ts:87

[GatherProps] ​

• [GatherProps]: () => Record<string, unknown>

Type declaration ​

â–¸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns ​

Record<string, unknown>

Defined in ​

profectus/src/features/upgrades/upgrade.ts:89

bought ​

• bought: Persistent<boolean>

Whether or not this upgrade has been purchased.

Defined in ​

profectus/src/features/upgrades/upgrade.ts:79

canPurchase ​

• canPurchase: Ref<boolean>

Whether or not the upgrade can currently be purchased.

Defined in ​

profectus/src/features/upgrades/upgrade.ts:81

id ​

• id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Defined in ​

profectus/src/features/upgrades/upgrade.ts:77

purchase ​

• purchase: VoidFunction

Purchase the upgrade

Defined in ​

profectus/src/features/upgrades/upgrade.ts:83

type ​

• type: typeof UpgradeType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/upgrades/upgrade.ts:85

- diff --git a/api/interfaces/features/upgrades/upgrade.UpgradeOptions.html b/api/interfaces/features/upgrades/upgrade.UpgradeOptions.html index eca4e834..b17e559d 100644 --- a/api/interfaces/features/upgrades/upgrade.UpgradeOptions.html +++ b/api/interfaces/features/upgrades/upgrade.UpgradeOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: UpgradeOptions ​

features/upgrades/upgrade.UpgradeOptions

An object that configures a Upgrade.

Properties ​

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Defined in ​

profectus/src/features/upgrades/upgrade.ts:49

display ​

• Optional display: Computable<CoercableComponent | { description: CoercableComponent ; effectDisplay?: CoercableComponent ; title?: CoercableComponent }>

The display to use for this clickable.

Defined in ​

profectus/src/features/upgrades/upgrade.ts:55

mark ​

• Optional mark: Computable<string | boolean>

Shows a marker on the corner of the feature.

Defined in ​

profectus/src/features/upgrades/upgrade.ts:53

onPurchase ​

• Optional onPurchase: VoidFunction

A function that is called when the upgrade is purchased.

Defined in ​

profectus/src/features/upgrades/upgrade.ts:69

requirements ​

• requirements: Requirements

The requirements to purchase this upgrade.

Defined in ​

profectus/src/features/upgrades/upgrade.ts:67

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Defined in ​

profectus/src/features/upgrades/upgrade.ts:51

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this clickable should be visible.

Defined in ​

profectus/src/features/upgrades/upgrade.ts:47

- diff --git a/api/interfaces/game/events.GlobalEvents.html b/api/interfaces/game/events.GlobalEvents.html index 0038cd55..75584c67 100644 --- a/api/interfaces/game/events.GlobalEvents.html +++ b/api/interfaces/game/events.GlobalEvents.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: GlobalEvents ​

game/events.GlobalEvents

All types of events able to be sent or emitted from the global event bus.

Properties ​

addLayer ​

• addLayer: (layer: GenericLayer, saveData: Record<string, unknown>) => void

Type declaration ​

â–¸ (layer, saveData): void

Sent whenever a layer is added.

Parameters ​
NameTypeDescription
layerGenericLayerThe layer being added.
saveDataRecord<string, unknown>The layer's save data object within player.
Returns ​

void

Defined in ​

profectus/src/game/events.ts:13

fontsLoaded ​

• fontsLoaded: VoidFunction

Using document.fonts.ready returns too early on firefox, so we use document.fonts.onloadingdone instead, which doesn't accept multiple listeners. This event fires when that callback is called.

Defined in ​

profectus/src/game/events.ts:51

gameWon ​

• gameWon: VoidFunction

Sent when the game has ended.

Defined in ​

profectus/src/game/events.ts:35

loadSettings ​

• loadSettings: (settings: Partial<Settings>) => void

Type declaration ​

â–¸ (settings): void

Sent when constructing the Settings object. Use it to add default values for custom properties to the object.

See

features/features.setDefault for setting default values.

Parameters ​
NameTypeDescription
settingsPartial<Settings>The settings object being constructed.
Returns ​

void

Defined in ​

profectus/src/game/events.ts:31

onLoad ​

• onLoad: VoidFunction

Sent whenever a save has finished loading. Happens when the page is opened and upon switching saves in the saves manager.

Defined in ​

profectus/src/game/events.ts:46

removeLayer ​

• removeLayer: (layer: GenericLayer) => void

Type declaration ​

â–¸ (layer): void

Sent whenever a layer is removed.

Parameters ​
NameTypeDescription
layerGenericLayerThe layer being removed.
Returns ​

void

Defined in ​

profectus/src/game/events.ts:18

reset ​

• reset: (reset: GenericReset) => void

Type declaration ​

â–¸ (reset): void

Parameters ​
NameType
resetGenericReset
Returns ​

void

Defined in ​

profectus/src/features/reset.ts:117

setupVue ​

• setupVue: (vue: App<any>) => void

Type declaration ​

â–¸ (vue): void

Sent when setting up the Vue Application instance. Use it to register global components or otherwise set up things that should affect Vue globally.

Parameters ​
NameTypeDescription
vueApp<any>The Vue App being constructed.
Returns ​

void

Defined in ​

profectus/src/game/events.ts:41

update ​

• update: (diff: number, trueDiff: number) => void

Type declaration ​

â–¸ (diff, trueDiff): void

Sent every game tick. Runs the life cycle of the project.

Parameters ​
NameTypeDescription
diffnumberThe delta time since last tick, in ms.
trueDiffnumberThe delta time since last tick, in ms. Unaffected by time modifiers like devSpeed or offlineTime. Intended for things like updating animations.
Returns ​

void

Defined in ​

profectus/src/game/events.ts:24

- diff --git a/api/interfaces/game/layers.BaseLayer.html b/api/interfaces/game/layers.BaseLayer.html index 3ef3e78e..83b178df 100644 --- a/api/interfaces/game/layers.BaseLayer.html +++ b/api/interfaces/game/layers.BaseLayer.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: BaseLayer ​

game/layers.BaseLayer

The properties that are added onto a processed LayerOptions to create a Layer

Properties ​

emit ​

• emit: <K>(...args: [K, ...Parameters<LayerEvents[K]>[]]) => void

Type declaration ​

â–¸ <K>(...args): void

A function to emit a LayerEvents event to this layer.

Type parameters ​
NameType
Kextends keyof LayerEvents
Parameters ​
NameType
...args[K, ...Parameters<LayerEvents[K]>[]]
Returns ​

void

Defined in ​

profectus/src/game/layers.tsx:162

emitter ​

• emitter: Emitter<LayerEvents>

An emitter for sending LayerEvents events for this layer.

Defined in ​

profectus/src/game/layers.tsx:158

id ​

• id: string

The ID of the layer. Populated from the createLayer parameters. Used for saving and tracking open tabs.

Defined in ​

profectus/src/game/layers.tsx:154

minimized ​

• minimized: Persistent<boolean>

A persistent ref tracking if the tab is minimized or not.

Defined in ​

profectus/src/game/layers.tsx:156

nodes ​

• nodes: Ref<Record<string, undefined | FeatureNode>>

A map of FeatureNodes present in this layer's ContextComponent component.

Defined in ​

profectus/src/game/layers.tsx:164

on ​

• on: (...args: [event: keyof LayerEvents, cb: Function | Function | Function]) => Unsubscribe

Type declaration ​

â–¸ (...args): Unsubscribe

A function to register an event listener on emitter.

Parameters ​
NameType
...args[event: keyof LayerEvents, cb: Function | Function | Function]
Returns ​

Unsubscribe

Defined in ​

profectus/src/game/layers.tsx:160

- diff --git a/api/interfaces/game/layers.FeatureNode.html b/api/interfaces/game/layers.FeatureNode.html index 9a829a09..733219b8 100644 --- a/api/interfaces/game/layers.FeatureNode.html +++ b/api/interfaces/game/layers.FeatureNode.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: FeatureNode ​

game/layers.FeatureNode

A feature's node in the DOM that has its size tracked.

Properties ​

element ​

• element: HTMLElement

Defined in ​

profectus/src/game/layers.tsx:31

observer ​

• observer: MutationObserver

Defined in ​

profectus/src/game/layers.tsx:30

rect ​

• rect: DOMRect

Defined in ​

profectus/src/game/layers.tsx:29

- diff --git a/api/interfaces/game/layers.LayerEvents.html b/api/interfaces/game/layers.LayerEvents.html index a1ad5f03..045a6132 100644 --- a/api/interfaces/game/layers.LayerEvents.html +++ b/api/interfaces/game/layers.LayerEvents.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: LayerEvents ​

game/layers.LayerEvents

All types of events able to be sent or emitted from a layer's emitter.

Properties ​

postUpdate ​

• postUpdate: (diff: number) => void

Type declaration ​

â–¸ (diff): void

Sent every game tick, after the update event. Intended for checking state.

Parameters ​
NameTypeDescription
diffnumberThe delta time since last tick, in ms.
Returns ​

void

Defined in ​

profectus/src/game/layers.tsx:70

preUpdate ​

• preUpdate: (diff: number) => void

Type declaration ​

â–¸ (diff): void

Sent every game tick, before the update event. Intended for "generation" type actions.

Parameters ​
NameTypeDescription
diffnumberThe delta time since last tick, in ms.
Returns ​

void

Defined in ​

profectus/src/game/layers.tsx:60

update ​

• update: (diff: number) => void

Type declaration ​

â–¸ (diff): void

Sent every game tick. Intended for "automation" type actions.

Parameters ​
NameTypeDescription
diffnumberThe delta time since last tick, in ms.
Returns ​

void

Defined in ​

profectus/src/game/layers.tsx:65

- diff --git a/api/interfaces/game/layers.LayerOptions.html b/api/interfaces/game/layers.LayerOptions.html index 5a536f13..14b2b39d 100644 --- a/api/interfaces/game/layers.LayerOptions.html +++ b/api/interfaces/game/layers.LayerOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: LayerOptions ​

game/layers.LayerOptions

An object that configures a Layer. Even moreso than features, the developer is expected to include extra properties in this object. All Persistent refs must be included somewhere within the layer object.

Properties ​

classes ​

• Optional classes: Computable<Record<string, boolean>>

An object of classes that should be applied to the display.

Defined in ​

profectus/src/game/layers.tsx:116

color ​

• Optional color: Computable<string>

The color of the layer, used to theme the entire layer's display.

Defined in ​

profectus/src/game/layers.tsx:109

display ​

• display: Computable<CoercableComponent>

The layout of this layer's features. When the layer is open in game/player.PlayerData.tabs, this is the content that is displayed.

Defined in ​

profectus/src/game/layers.tsx:114

forceHideGoBack ​

• Optional forceHideGoBack: Computable<boolean>

Whether or not to force the go back button to be hidden. If true, go back will be hidden regardless of data/projInfo.allowGoBack.

Defined in ​

profectus/src/game/layers.tsx:138

minWidth ​

• Optional minWidth: Computable<string | number>

A CSS min-width value that is applied to the layer. Can be a number, in which case the unit is assumed to be px. Defaults to 600px.

Defined in ​

profectus/src/game/layers.tsx:144

minimizable ​

• Optional minimizable: Computable<boolean>

Whether or not the layer can be minimized. Defaults to true.

Defined in ​

profectus/src/game/layers.tsx:128

minimizedDisplay ​

• Optional minimizedDisplay: Computable<CoercableComponent>

The layout of this layer's features. When the layer is open in game/player.PlayerData.tabs, but the tab is Layer.minimized this is the content that is displayed.

Defined in ​

profectus/src/game/layers.tsx:133

name ​

• Optional name: Computable<string>

The name of the layer, used on minimized tabs. Defaults to id.

Defined in ​

profectus/src/game/layers.tsx:123

style ​

• Optional style: Computable<StyleValue>

Styles that should be applied to the display.

Defined in ​

profectus/src/game/layers.tsx:118

- diff --git a/api/interfaces/game/layers.Position.html b/api/interfaces/game/layers.Position.html index 1589aa24..f8f77615 100644 --- a/api/interfaces/game/layers.Position.html +++ b/api/interfaces/game/layers.Position.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: Position ​

game/layers.Position

An object representing the position of some entity.

Properties ​

x ​

• x: number

The X component of the entity's position.

Defined in ​

profectus/src/game/layers.tsx:97

y ​

• y: number

The Y component of the entity's position.

Defined in ​

profectus/src/game/layers.tsx:99

- diff --git a/api/interfaces/game/modifiers.AdditiveModifierOptions.html b/api/interfaces/game/modifiers.AdditiveModifierOptions.html index 0662640f..36cf96a5 100644 --- a/api/interfaces/game/modifiers.AdditiveModifierOptions.html +++ b/api/interfaces/game/modifiers.AdditiveModifierOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: AdditiveModifierOptions ​

game/modifiers.AdditiveModifierOptions

An object that configures an additive modifier via createAdditiveModifier.

Properties ​

addend ​

• addend: Computable<DecimalSource>

The amount to add to the input value.

Defined in ​

profectus/src/game/modifiers.tsx:51

description ​

• Optional description: Computable<CoercableComponent>

Description of what this modifier is doing.

Defined in ​

profectus/src/game/modifiers.tsx:53

enabled ​

• Optional enabled: Computable<boolean>

A computable that will be processed and passed directly into the returned modifier.

Defined in ​

profectus/src/game/modifiers.tsx:55

smallerIsBetter ​

• Optional smallerIsBetter: boolean

Determines if numbers larger or smaller than 0 should be displayed as red.

Defined in ​

profectus/src/game/modifiers.tsx:57

- diff --git a/api/interfaces/game/modifiers.ExponentialModifierOptions.html b/api/interfaces/game/modifiers.ExponentialModifierOptions.html index 5cb4f4b0..79b57ce7 100644 --- a/api/interfaces/game/modifiers.ExponentialModifierOptions.html +++ b/api/interfaces/game/modifiers.ExponentialModifierOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: ExponentialModifierOptions ​

game/modifiers.ExponentialModifierOptions

An object that configures an exponential modifier via createExponentialModifier.

Properties ​

description ​

• Optional description: Computable<CoercableComponent>

Description of what this modifier is doing.

Defined in ​

profectus/src/game/modifiers.tsx:174

enabled ​

• Optional enabled: Computable<boolean>

A computable that will be processed and passed directly into the returned modifier.

Defined in ​

profectus/src/game/modifiers.tsx:176

exponent ​

• exponent: Computable<DecimalSource>

The amount to raise the input value to the power of.

Defined in ​

profectus/src/game/modifiers.tsx:172

smallerIsBetter ​

• Optional smallerIsBetter: boolean

Determines if numbers larger or smaller than 1 should be displayed as red.

Defined in ​

profectus/src/game/modifiers.tsx:180

supportLowNumbers ​

• Optional supportLowNumbers: boolean

Add 1 before calculating, then remove it afterwards. This prevents low numbers from becoming lower.

Defined in ​

profectus/src/game/modifiers.tsx:178

- diff --git a/api/interfaces/game/modifiers.Modifier.html b/api/interfaces/game/modifiers.Modifier.html index 330de4b5..f2dfd3d1 100644 --- a/api/interfaces/game/modifiers.Modifier.html +++ b/api/interfaces/game/modifiers.Modifier.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: Modifier ​

game/modifiers.Modifier

An object that can be used to apply or unapply some modification to a number. Being reversible requires the operation being invertible, but some features may rely on that. Descriptions can be optionally included for displaying them to the player. The built-in modifier creators are designed to display the modifiers using createModifierSection.

Properties ​

apply ​

• apply: (gain: DecimalSource) => DecimalSource

Type declaration ​

â–¸ (gain): DecimalSource

Applies some operation on the input and returns the result.

Parameters ​
NameType
gainDecimalSource
Returns ​

DecimalSource

Defined in ​

profectus/src/game/modifiers.tsx:22

description ​

• Optional description: ProcessedComputable<CoercableComponent>

A description of this modifier.

See

createModifierSection.

Defined in ​

profectus/src/game/modifiers.tsx:34

enabled ​

• Optional enabled: ProcessedComputable<boolean>

Whether or not this modifier should be considered enabled. Typically for use with modifiers passed into createSequentialModifier.

Defined in ​

profectus/src/game/modifiers.tsx:29

revert ​

• Optional revert: (gain: DecimalSource) => DecimalSource

Type declaration ​

â–¸ (gain): DecimalSource

Reverses the operation applied by the apply property. Required by some features.

Parameters ​
NameType
gainDecimalSource
Returns ​

DecimalSource

Defined in ​

profectus/src/game/modifiers.tsx:24

- diff --git a/api/interfaces/game/modifiers.ModifierSectionOptions.html b/api/interfaces/game/modifiers.ModifierSectionOptions.html index 2271168f..b21554c8 100644 --- a/api/interfaces/game/modifiers.ModifierSectionOptions.html +++ b/api/interfaces/game/modifiers.ModifierSectionOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: ModifierSectionOptions ​

game/modifiers.ModifierSectionOptions

An object that configures a modifier section via createModifierSection.

Properties ​

base ​

• Optional base: DecimalSource

The base value that'll be passed into the modifier. Defaults to 1.

Defined in ​

profectus/src/game/modifiers.tsx:305

baseText ​

• Optional baseText: CoercableComponent

The label to use for the base value. Defaults to "Base".

Defined in ​

profectus/src/game/modifiers.tsx:309

modifier ​

• modifier: WithRequired<Modifier, "description">

The modifier to render.

Defined in ​

profectus/src/game/modifiers.tsx:303

smallerIsBetter ​

• Optional smallerIsBetter: boolean

Determines if numbers larger or smaller than the base should be displayed as red.

Defined in ​

profectus/src/game/modifiers.tsx:311

subtitle ​

• Optional subtitle: string

Smaller text that appears in the header after the title.

Defined in ​

profectus/src/game/modifiers.tsx:301

title ​

• title: string

The header for the section.

Defined in ​

profectus/src/game/modifiers.tsx:299

unit ​

• Optional unit: string

The unit of the value being modified, if any.

Defined in ​

profectus/src/game/modifiers.tsx:307

- diff --git a/api/interfaces/game/modifiers.MultiplicativeModifierOptions.html b/api/interfaces/game/modifiers.MultiplicativeModifierOptions.html index 284b97eb..7bc27027 100644 --- a/api/interfaces/game/modifiers.MultiplicativeModifierOptions.html +++ b/api/interfaces/game/modifiers.MultiplicativeModifierOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: MultiplicativeModifierOptions ​

game/modifiers.MultiplicativeModifierOptions

An object that configures an multiplicative modifier via createMultiplicativeModifier.

Properties ​

description ​

• Optional description: Computable<CoercableComponent>

Description of what this modifier is doing.

Defined in ​

profectus/src/game/modifiers.tsx:114

enabled ​

• Optional enabled: Computable<boolean>

A computable that will be processed and passed directly into the returned modifier.

Defined in ​

profectus/src/game/modifiers.tsx:116

multiplier ​

• multiplier: Computable<DecimalSource>

The amount to multiply the input value by.

Defined in ​

profectus/src/game/modifiers.tsx:112

smallerIsBetter ​

• Optional smallerIsBetter: boolean

Determines if numbers larger or smaller than 1 should be displayed as red.

Defined in ​

profectus/src/game/modifiers.tsx:118

- diff --git a/api/interfaces/game/player.Player.html b/api/interfaces/game/player.Player.html index 2c75d1c3..561d0901 100644 --- a/api/interfaces/game/player.Player.html +++ b/api/interfaces/game/player.Player.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: Player ​

game/player.Player

The player save data object.

Properties ​

autosave ​

• autosave: boolean

Whether or not to automatically save every couple of seconds and on tab close.

Defined in ​

profectus/src/game/player.ts:17

devSpeed ​

• devSpeed: null | number

A multiplier for time passing. Set to 0 when the game is paused.

Defined in ​

profectus/src/game/player.ts:9

id ​

• id: string

The ID of this save.

Defined in ​

profectus/src/game/player.ts:7

keepGoing ​

• keepGoing: boolean

Whether or not to continue playing after hasWon is true.

Defined in ​

profectus/src/game/player.ts:25

layers ​

• layers: Record<string, LayerData<unknown>>

A dictionary of layer save data.

Defined in ​

profectus/src/game/player.ts:31

modID ​

• modID: string

The ID of this project, to make sure saves aren't imported into the wrong project.

Defined in ​

profectus/src/game/player.ts:27

modVersion ​

• modVersion: string

The version of the project this save was created by. Used for upgrading saves for new versions.

Defined in ​

profectus/src/game/player.ts:29

name ​

• name: string

The display name of this save.

Defined in ​

profectus/src/game/player.ts:11

offlineProd ​

• offlineProd: boolean

Whether or not to apply offline time when loading this save.

Defined in ​

profectus/src/game/player.ts:19

offlineTime ​

• offlineTime: null | number

How much offline time has been accumulated and not yet processed.

Defined in ​

profectus/src/game/player.ts:21

tabs ​

• tabs: string[]

The open tabs.

Defined in ​

profectus/src/game/player.ts:13

time ​

• time: number

The current time this save was last opened at, in ms since the unix epoch.

Defined in ​

profectus/src/game/player.ts:15

timePlayed ​

• timePlayed: number

How long, in ms, this game has been played.

Defined in ​

profectus/src/game/player.ts:23

- diff --git a/api/interfaces/game/requirements.CostRequirementOptions.html b/api/interfaces/game/requirements.CostRequirementOptions.html index f6255ed6..ff273f41 100644 --- a/api/interfaces/game/requirements.CostRequirementOptions.html +++ b/api/interfaces/game/requirements.CostRequirementOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: CostRequirementOptions ​

game/requirements.CostRequirementOptions

An object that configures a Requirement based on a resource cost.

Properties ​

cost ​

• cost: Computable<DecimalSource> | GenericFormula

The amount of resource that must be met for this requirement. You can pass a formula, in which case maximizing will work out of the box (assuming its invertible and, for more accurate calculations, its integral is invertible). If you don't pass a formula then you can still support maximizing by passing a custom pay function.

Defined in ​

profectus/src/game/requirements.tsx:75

pay ​

• Optional pay: (amount?: DecimalSource) => void

Type declaration ​

â–¸ (amount?): void

Pass-through to pay. May be required for maximizing support.

See

cost for restrictions on maximizing support.

Parameters ​
NameType
amount?DecimalSource
Returns ​

void

Defined in ​

profectus/src/game/requirements.tsx:93

requiresPay ​

• Optional requiresPay: Computable<boolean>

Pass-through to requiresPay. If not set to false, the default pay function will remove cost from resource.

Defined in ​

profectus/src/game/requirements.tsx:83

resource ​

• resource: Resource<DecimalSource>

The resource that will be checked for meeting the cost.

Defined in ​

profectus/src/game/requirements.tsx:71

spendResources ​

• Optional spendResources: Computable<boolean>

When calculating multiple levels to be handled at once, whether it should consider resources used for each level as spent. Setting this to false causes calculations to be faster with larger numbers and supports more math functions.

See

Defined in ​

profectus/src/game/requirements.tsx:88

visibility ​

• Optional visibility: Computable<boolean | Visible | None>

Pass-through to visibility.

Defined in ​

profectus/src/game/requirements.tsx:79

- diff --git a/api/interfaces/game/requirements.Requirement.html b/api/interfaces/game/requirements.Requirement.html index 7badcf43..e400ad2d 100644 --- a/api/interfaces/game/requirements.Requirement.html +++ b/api/interfaces/game/requirements.Requirement.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: Requirement ​

game/requirements.Requirement

An object that can be used to describe a requirement to perform some purchase or other action.

See

createCostRequirement

Properties ​

canMaximize ​

• Optional canMaximize: ProcessedComputable<boolean>

Whether or not this requirement can have multiple levels of requirements that can be met at once. Requirement is assumed to not have multiple levels if this property not present.

Defined in ​

profectus/src/game/requirements.tsx:53

display ​

• Optional display: (amount?: DecimalSource) => Element

Type declaration ​

â–¸ (amount?): Element

The display for this specific requirement. Required if visibility can be Visibility.Visible.

Parameters ​
NameType
amount?DecimalSource
Returns ​

Element

Defined in ​

profectus/src/game/requirements.tsx:37

partialDisplay ​

• Optional partialDisplay: (amount?: DecimalSource) => Element

Type declaration ​

â–¸ (amount?): Element

The display for this specific requirement. This is used for displays multiple requirements condensed. Required if visibility can be Visibility.Visible.

Parameters ​
NameType
amount?DecimalSource
Returns ​

Element

Defined in ​

profectus/src/game/requirements.tsx:33

pay ​

• Optional pay: (amount?: DecimalSource) => void

Type declaration ​

â–¸ (amount?): void

Perform any effects to the game state that should happen when the requirement gets triggered.

Parameters ​
NameTypeDescription
amount?DecimalSourceThe amount of levels of requirements to pay for.
Returns ​

void

Defined in ​

profectus/src/game/requirements.tsx:58

requirementMet ​

• requirementMet: ProcessedComputable<boolean | DecimalSource>

Whether or not this requirement has been met.

Defined in ​

profectus/src/game/requirements.tsx:45

requiresPay ​

• requiresPay: ProcessedComputable<boolean>

Whether or not this requirement will need to affect the game state when whatever is using this requirement gets triggered.

Defined in ​

profectus/src/game/requirements.tsx:49

visibility ​

• visibility: ProcessedComputable<boolean | Visible | None>

Whether or not this requirement should be displayed in Vue Features. displayRequirements will respect this property.

Defined in ​

profectus/src/game/requirements.tsx:41

- diff --git a/api/interfaces/game/settings.Settings.html b/api/interfaces/game/settings.Settings.html index 03e8766a..02132d0d 100644 --- a/api/interfaces/game/settings.Settings.html +++ b/api/interfaces/game/settings.Settings.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: Settings ​

game/settings.Settings

The player's settings object.

Properties ​

active ​

• active: string

The ID of the active save.

Defined in ​

profectus/src/game/settings.ts:12

alignUnits ​

• alignUnits: boolean

Whether to align modifiers to the unit.

Defined in ​

profectus/src/game/settings.ts:22

hideChallenges ​

• hideChallenges: boolean

Defined in ​

profectus/src/features/challenges/challenge.tsx:345

msDisplay ​

• msDisplay: AchievementDisplay

Defined in ​

profectus/src/features/achievements/achievement.tsx:270

saves ​

• saves: string[]

The IDs of all created saves.

Defined in ​

profectus/src/game/settings.ts:14

showTPS ​

• showTPS: boolean

Whether or not to show the current ticks per second in the lower left corner of the page.

Defined in ​

profectus/src/game/settings.ts:16

theme ​

• theme: Themes

The current theme to display the game in.

Defined in ​

profectus/src/game/settings.ts:18

unthrottled ​

• unthrottled: boolean

Whether or not to cap the project at 20 ticks per second.

Defined in ​

profectus/src/game/settings.ts:20

- diff --git a/api/interfaces/game/state.Transient.html b/api/interfaces/game/state.Transient.html index bb5c1f0c..24c637a2 100644 --- a/api/interfaces/game/state.Transient.html +++ b/api/interfaces/game/state.Transient.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: Transient ​

game/state.Transient

An object of global data that is not persistent.

Properties ​

NaNPath ​

• Optional NaNPath: string[]

The location within the player save data object of the NaN value.

Defined in ​

profectus/src/game/state.ts:12

NaNPersistent ​

• Optional NaNPersistent: Persistent<DecimalSource>

The ref that was being set to NaN.

Defined in ​

profectus/src/game/state.ts:14

hasNaN ​

• hasNaN: boolean

Whether or not a NaN value has been detected and undealt with.

Defined in ​

profectus/src/game/state.ts:10

lastTenTicks ​

• lastTenTicks: number[]

A list of the duration, in ms, of the last 10 game ticks. Used for calculating TPS.

Defined in ​

profectus/src/game/state.ts:8

- diff --git a/api/interfaces/lib/pwa-register.RegisterSWOptions.html b/api/interfaces/lib/pwa-register.RegisterSWOptions.html index e1ac1944..a2c8414a 100644 --- a/api/interfaces/lib/pwa-register.RegisterSWOptions.html +++ b/api/interfaces/lib/pwa-register.RegisterSWOptions.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: RegisterSWOptions ​

lib/pwa-register.RegisterSWOptions

Properties ​

immediate ​

• Optional immediate: boolean

Defined in ​

profectus/src/lib/pwa-register.d.ts:5

onNeedRefresh ​

• Optional onNeedRefresh: () => void

Type declaration ​

â–¸ (): void

Returns ​

void

Defined in ​

profectus/src/lib/pwa-register.d.ts:6

onOfflineReady ​

• Optional onOfflineReady: () => void

Type declaration ​

â–¸ (): void

Returns ​

void

Defined in ​

profectus/src/lib/pwa-register.d.ts:7

onRegisterError ​

• Optional onRegisterError: (error: any) => void

Type declaration ​

â–¸ (error): void

Parameters ​
NameType
errorany
Returns ​

void

Defined in ​

profectus/src/lib/pwa-register.d.ts:9

onRegistered ​

• Optional onRegistered: (registration: undefined | ServiceWorkerRegistration) => void

Type declaration ​

â–¸ (registration): void

Parameters ​
NameType
registrationundefined | ServiceWorkerRegistration
Returns ​

void

Defined in ​

profectus/src/lib/pwa-register.d.ts:8

- diff --git a/api/interfaces/util/vue.VueFeature.html b/api/interfaces/util/vue.VueFeature.html index 71a79e2d..35620647 100644 --- a/api/interfaces/util/vue.VueFeature.html +++ b/api/interfaces/util/vue.VueFeature.html @@ -22,7 +22,7 @@
Profectus
On this page

Interface: VueFeature ​

util/vue.VueFeature

Properties ​

[Component] ​

• [Component]: GenericComponent

Defined in ​

profectus/src/util/vue.tsx:47

[GatherProps] ​

• [GatherProps]: () => Record<string, unknown>

Type declaration ​

â–¸ (): Record<string, unknown>

Returns ​

Record<string, unknown>

Defined in ​

profectus/src/util/vue.tsx:48

- diff --git a/api/modules/data/common.html b/api/modules/data/common.html index d135550b..2f6936b3 100644 --- a/api/modules/data/common.html +++ b/api/modules/data/common.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: data/common ​

Interfaces ​

Type Aliases ​

GenericLayerTreeNode ​

Ƭ GenericLayerTreeNode: Replace<LayerTreeNode<LayerTreeNodeOptions>, { append?: ProcessedComputable<boolean> ; display: ProcessedComputable<CoercableComponent> }>

A type that matches any valid LayerTreeNode object.

Defined in ​

profectus/src/data/common.tsx:201

GenericResetButton ​

Ƭ GenericResetButton: Replace<GenericClickable & ResetButton<ResetButtonOptions>, { canClick: ProcessedComputable<boolean> ; display: ProcessedComputable<CoercableComponent> ; minimumGain: ProcessedComputable<DecimalSource> ; resetDescription: ProcessedComputable<string> ; showNextAt: ProcessedComputable<boolean> }>

A type that matches any valid ResetButton object.

Defined in ​

profectus/src/data/common.tsx:84

LayerTreeNode ​

Ƭ LayerTreeNode<T>: Replace<TreeNode<T>, { append: GetComputableType<T["append"]> ; display: GetComputableTypeWithDefault<T["display"], T["layerID"]> }>

A tree node that is associated with a given layer, and which opens the layer when clicked.

Type parameters ​

NameType
Textends LayerTreeNodeOptions

Defined in ​

profectus/src/data/common.tsx:193

ResetButton ​

Ƭ ResetButton<T>: Replace<Clickable<T>, { canClick: GetComputableTypeWithDefault<T["canClick"], Ref<boolean>> ; display: GetComputableTypeWithDefault<T["display"], Ref<JSX.Element>> ; minimumGain: GetComputableTypeWithDefault<T["minimumGain"], 1> ; onClick: (event?: MouseEvent | TouchEvent) => void ; resetDescription: GetComputableTypeWithDefault<T["resetDescription"], Ref<string>> ; showNextAt: GetComputableTypeWithDefault<T["showNextAt"], true> }>

A button that is used to control a conversion. It will show how much can be converted currently, and can show when that amount will go up, as well as handle only being clickable when a sufficient amount of currency can be gained. Assumes this button is associated with a specific node on a tree, and triggers that tree's reset propagation.

Type parameters ​

NameType
Textends ResetButtonOptions

Defined in ​

profectus/src/data/common.tsx:71

Functions ​

colorText ​

â–¸ colorText(textToColor, color?): JSX.Element

Creates an HTML string for a span that writes some given text in a given color.

Parameters ​

NameTypeDefault valueDescription
textToColorstringundefinedThe content to change the color of
colorstring"var(--accent2)"The color to change the content to look like. Defaults to the current theme's accent 2 variable.

Returns ​

JSX.Element

Defined in ​

profectus/src/data/common.tsx:382

createCollapsibleAchievements ​

â–¸ createCollapsibleAchievements(achievements): Object

Creates a collapsible display of a list of achievements

Parameters ​

NameTypeDescription
achievementsRecord<string, GenericAchievement>A dictionary of the achievements to display, inserted in the order from easiest to hardest

Returns ​

Object

NameType
collapseAchievementsPersistent<boolean>
displayJSXFunction

Defined in ​

profectus/src/data/common.tsx:390

createCollapsibleModifierSections ​

â–¸ createCollapsibleModifierSections(sectionsFunc, smallerIsBetter?): [JSXFunction, Persistent<Record<number, boolean>>]

Takes an array of modifier "sections", and creates a JSXFunction that can render all those sections, and allow each section to be collapsed. Also returns a list of persistent refs that are used to control which sections are currently collapsed.

Parameters ​

NameTypeDefault valueDescription
sectionsFunc() => Section[]undefinedA function that returns the sections to display.
smallerIsBetterbooleanfalseDetermines whether numbers larger or smaller than the base should be displayed as red.

Returns ​

[JSXFunction, Persistent<Record<number, boolean>>]

Defined in ​

profectus/src/data/common.tsx:264

createFormulaPreview ​

â–¸ createFormulaPreview(formula, showPreview, previewAmount?): ComputedRef<CoercableComponent>

Utility function for displaying the result of a formula such that it will, when told to, preview how the formula's result will change. Requires a formula with a single variable inside.

Parameters ​

NameTypeDefault valueDescription
formulaGenericFormulaundefinedThe formula to display the result of.
showPreviewComputable<boolean>undefinedWhether or not to preview how the formula's result will change.
previewAmountComputable<DecimalSource>1The amount to add to the current formula's variable amount to preview the change in result.

Returns ​

ComputedRef<CoercableComponent>

Defined in ​

profectus/src/data/common.tsx:460

createLayerTreeNode ​

â–¸ createLayerTreeNode<T>(optionsFunc): LayerTreeNode<T>

Lazily creates a tree node that's associated with a specific layer, with the given options.

Type parameters ​

NameType
Textends LayerTreeNodeOptions

Parameters ​

NameTypeDescription
optionsFuncOptionsFunc<T, Record<string, unknown>, Record<string, unknown>>A function that returns the options object for this tree node.

Returns ​

LayerTreeNode<T>

Defined in ​

profectus/src/data/common.tsx:213

createResetButton ​

â–¸ createResetButton<T>(optionsFunc): ResetButton<T>

Lazily creates a reset button with the given options.

Type parameters ​

NameType
Textends ClickableOptions & ResetButtonOptions

Parameters ​

NameTypeDescription
optionsFuncOptionsFunc<T, Record<string, unknown>, Record<string, unknown>>A function that returns the options object for this reset button.

Returns ​

ResetButton<T>

Defined in ​

profectus/src/data/common.tsx:99

estimateTime ​

â–¸ estimateTime(resource, rate, target): ComputedRef<string>

Utility function for getting an ETA for when a target will be reached by a resource with a known (and assumed consistent) gain.

Parameters ​

NameTypeDescription
resourceResource<DecimalSource>The resource that will be increasing over time.
rateComputable<DecimalSource>The rate at which the resource is increasing.
targetComputable<DecimalSource>The target amount of the resource to estimate the duration until.

Returns ​

ComputedRef<string>

Defined in ​

profectus/src/data/common.tsx:434

modifierToFormula ​

â–¸ modifierToFormula<T>(modifier, base): T

Utility for converting a modifier into a formula. Takes the input for this formula as the base parameter.

Type parameters ​

NameType
Textends default<any, T>

Parameters ​

NameTypeDescription
modifierWithRequired<Modifier, "revert">The modifier to convert to the formula
baseTAn existing formula or processed DecimalSource that will be the input to the formula

Returns ​

T

Defined in ​

profectus/src/data/common.tsx:500

â–¸ modifierToFormula(modifier, base): GenericFormula

Parameters ​

NameType
modifierModifier
baseFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/data/common.tsx:504

- diff --git a/api/modules/data/projEntry.html b/api/modules/data/projEntry.html index 87a7e867..ad883d03 100644 --- a/api/modules/data/projEntry.html +++ b/api/modules/data/projEntry.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: data/projEntry ​

Variables ​

hasWon ​

• Const hasWon: ComputedRef<boolean>

A computed ref whose value is true whenever the game is over.

Defined in ​

profectus/src/data/projEntry.tsx:88

Functions ​

fixOldSave ​

â–¸ fixOldSave(oldVersion, player): void

Given a player save data object being loaded with a different version, update the save data object to match the structure of the current version.

Parameters ​

NameTypeDescription
oldVersionundefined | stringThe version of the save being loaded in
playerPartial<Player>The save data being loaded in

Returns ​

void

Defined in ​

profectus/src/data/projEntry.tsx:98

getInitialLayers ​

â–¸ getInitialLayers(player): GenericLayer[]

Given a player save data object being loaded, return a list of layers that should currently be enabled. If your project does not use dynamic layers, this should just return all layers.

Parameters ​

NameType
playerPartial<Player>

Returns ​

GenericLayer[]

Defined in ​

profectus/src/data/projEntry.tsx:80

- diff --git a/api/modules/data/themes.html b/api/modules/data/themes.html index c8fb77b4..4612a3bd 100644 --- a/api/modules/data/themes.html +++ b/api/modules/data/themes.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: data/themes ​

Enumerations ​

Interfaces ​

Variables ​

default ​

• default: Record<Themes, Theme>

A dictionary of all available themes.

Defined in ​

profectus/src/data/themes.ts:81

- diff --git a/api/modules/features/achievements/AchievementComponent.html b/api/modules/features/achievements/AchievementComponent.html index a99dab72..e7cacd4e 100644 --- a/api/modules/features/achievements/AchievementComponent.html +++ b/api/modules/features/achievements/AchievementComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Achievement ​

Props ​

NameTypes
visibility
*
processedPropType<Visibility | boolean>(Number, Boolean)
display
processedPropType<UnwrapRef<GenericAchievement["display"]>>(Object, String, Function)
earned
*
processedPropType<boolean>(Boolean)
requirements
processedPropType<Requirements>(Object, Array)
image
processedPropType<string>(String)
style
processedPropType<StyleValue>(String, Object, Array)
classes
processedPropType<Record<string, boolean>>(Object)
mark
processedPropType<boolean | string>(Boolean, String)
small
processedPropType<boolean>(Boolean)
id
*
string
- diff --git a/api/modules/features/achievements/achievement.html b/api/modules/features/achievements/achievement.html index 0ab64a47..db70d6d2 100644 --- a/api/modules/features/achievements/achievement.html +++ b/api/modules/features/achievements/achievement.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/achievements/achievement ​

Components ​

Enumerations ​

Interfaces ​

Type Aliases ​

Achievement ​

Ƭ Achievement<T>: Replace<T & BaseAchievement, { classes: GetComputableType<T["classes"]> ; display: GetComputableType<T["display"]> ; image: GetComputableType<T["image"]> ; mark: GetComputableType<T["mark"]> ; showPopups: GetComputableTypeWithDefault<T["showPopups"], true> ; style: GetComputableType<T["style"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>

An object that represents a feature with requirements that is passively earned upon meeting certain requirements.

Type parameters ​

NameType
Textends AchievementOptions

Defined in ​

profectus/src/features/achievements/achievement.tsx:113

GenericAchievement ​

Ƭ GenericAchievement: Replace<Achievement<AchievementOptions>, { showPopups: ProcessedComputable<boolean> ; visibility: ProcessedComputable<Visibility | boolean> }>

A type that matches any valid Achievement object.

Defined in ​

profectus/src/features/achievements/achievement.tsx:127

Variables ​

AchievementType ​

• Const AchievementType: typeof AchievementType

A symbol used to identify Achievement features.

Defined in ​

profectus/src/features/achievements/achievement.tsx:47

Functions ​

createAchievement ​

â–¸ createAchievement<T>(optionsFunc?): Achievement<T>

Lazily creates an achievement with the given options.

Type parameters ​

NameType
Textends AchievementOptions

Parameters ​

NameTypeDescription
optionsFunc?OptionsFunc<T, BaseAchievement, GenericAchievement>Achievement options.

Returns ​

Achievement<T>

Defined in ​

profectus/src/features/achievements/achievement.tsx:139

- diff --git a/api/modules/features/action.html b/api/modules/features/action.html index 80fa9690..87ffe0e3 100644 --- a/api/modules/features/action.html +++ b/api/modules/features/action.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/action ​

Interfaces ​

Type Aliases ​

Action ​

Ƭ Action<T>: Replace<T & BaseAction, { autoStart: GetComputableTypeWithDefault<T["autoStart"], false> ; canClick: GetComputableTypeWithDefault<T["canClick"], true> ; classes: GetComputableType<T["classes"]> ; display: JSXFunction ; duration: GetComputableType<T["duration"]> ; mark: GetComputableType<T["mark"]> ; onClick: VoidFunction ; style: GetComputableType<T["style"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>

An object that represens a feature that can be clicked upon, and then have a cooldown before they can be clicked again.

Type parameters ​

NameType
Textends ActionOptions

Defined in ​

profectus/src/features/action.tsx:75

GenericAction ​

Ƭ GenericAction: Replace<Action<ActionOptions>, { autoStart: ProcessedComputable<boolean> ; canClick: ProcessedComputable<boolean> ; visibility: ProcessedComputable<Visibility | boolean> }>

A type that matches any valid Action object.

Defined in ​

profectus/src/features/action.tsx:91

Variables ​

ActionType ​

• Const ActionType: typeof ActionType

A symbol used to identify Action features.

Defined in ​

profectus/src/features/action.tsx:36

Functions ​

createAction ​

â–¸ createAction<T>(optionsFunc?): Action<T>

Lazily creates an action with the given options.

Type parameters ​

NameType
Textends ActionOptions<T>

Parameters ​

NameTypeDescription
optionsFunc?OptionsFunc<T, BaseAction, GenericAction>Action options.

Returns ​

Action<T>

Defined in ​

profectus/src/features/action.tsx:104

- diff --git a/api/modules/features/bars/BarComponent.html b/api/modules/features/bars/BarComponent.html index a0f39c01..2f7661dc 100644 --- a/api/modules/features/bars/BarComponent.html +++ b/api/modules/features/bars/BarComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Bar ​

Props ​

NameTypes
progress
*
processedPropType<DecimalSource>(String, Object, Number)
width
*
processedPropType<number>(Number)
height
*
processedPropType<number>(Number)
direction
*
processedPropType<Direction>(String)
display
processedPropType<CoercableComponent>(Object, String, Function)
visibility
*
processedPropType<Visibility | boolean>(Number, Boolean)
style
processedPropType<StyleValue>(Object, String, Array)
classes
processedPropType<Record<string, boolean>>(Object)
borderStyle
processedPropType<StyleValue>(Object, String, Array)
textStyle
processedPropType<StyleValue>(Object, String, Array)
baseStyle
processedPropType<StyleValue>(Object, String, Array)
fillStyle
processedPropType<StyleValue>(Object, String, Array)
mark
processedPropType<boolean | string>(Boolean, String)
id
*
string
- diff --git a/api/modules/features/bars/bar.html b/api/modules/features/bars/bar.html index 09c9cf75..ae0290e0 100644 --- a/api/modules/features/bars/bar.html +++ b/api/modules/features/bars/bar.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/bars/bar ​

Components ​

Interfaces ​

Type Aliases ​

Bar ​

Ƭ Bar<T>: Replace<T & BaseBar, { baseStyle: GetComputableType<T["baseStyle"]> ; borderStyle: GetComputableType<T["borderStyle"]> ; classes: GetComputableType<T["classes"]> ; direction: GetComputableType<T["direction"]> ; display: GetComputableType<T["display"]> ; fillStyle: GetComputableType<T["fillStyle"]> ; height: GetComputableType<T["height"]> ; mark: GetComputableType<T["mark"]> ; progress: GetComputableType<T["progress"]> ; style: GetComputableType<T["style"]> ; textStyle: GetComputableType<T["textStyle"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> ; width: GetComputableType<T["width"]> }>

An object that represents a feature that displays some sort of progress or completion or resource with a cap.

Type parameters ​

NameType
Textends BarOptions

Defined in ​

profectus/src/features/bars/bar.ts:72

GenericBar ​

Ƭ GenericBar: Replace<Bar<BarOptions>, { visibility: ProcessedComputable<Visibility | boolean> }>

A type that matches any valid Bar object.

Defined in ​

profectus/src/features/bars/bar.ts:92

Variables ​

BarType ​

• Const BarType: typeof BarType

A symbol used to identify Bar features.

Defined in ​

profectus/src/features/bars/bar.ts:23

Functions ​

createBar ​

â–¸ createBar<T>(optionsFunc): Bar<T>

Lazily creates a bar with the given options.

Type parameters ​

NameType
Textends BarOptions

Parameters ​

NameTypeDescription
optionsFuncOptionsFunc<T, BaseBar, GenericBar>Bar options.

Returns ​

Bar<T>

Defined in ​

profectus/src/features/bars/bar.ts:103

- diff --git a/api/modules/features/boards/BoardComponent.html b/api/modules/features/boards/BoardComponent.html index 6e427c22..8ce4f1cb 100644 --- a/api/modules/features/boards/BoardComponent.html +++ b/api/modules/features/boards/BoardComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Board ​

Props ​

NameTypes
nodes
*
Ref
types
*
Record
state
*
Ref
visibility
*
ProcessedComputable
width
ProcessedComputable
height
ProcessedComputable
style
ProcessedComputable
classes
ProcessedComputable
links
*
Ref
selectedAction
*
Ref
selectedNode
*
Ref
mousePosition
*
Ref
- diff --git a/api/modules/features/boards/BoardLinkComponent.html b/api/modules/features/boards/BoardLinkComponent.html index b3c5cfbd..566a0556 100644 --- a/api/modules/features/boards/BoardLinkComponent.html +++ b/api/modules/features/boards/BoardLinkComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: BoardLink ​

Props ​

NameTypes
link
*
BoardNodeLink
- diff --git a/api/modules/features/boards/BoardNodeComponent.html b/api/modules/features/boards/BoardNodeComponent.html index c1e05292..a11874d8 100644 --- a/api/modules/features/boards/BoardNodeComponent.html +++ b/api/modules/features/boards/BoardNodeComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: BoardNode ​

Props ​

NameTypes
node
*
BoardNode
nodeType
*
GenericNodeType
dragging
BoardNode
dragged
{
 x: number;
 y: number;
}
hasDragged
boolean
receivingNode
boolean
selectedNode
BoardNode | null
selectedAction
GenericBoardNodeAction | null

Events ​

Name
mouseDown
endDragging
- diff --git a/api/modules/features/boards/board.html b/api/modules/features/boards/board.html index 39da1dd4..c8df964f 100644 --- a/api/modules/features/boards/board.html +++ b/api/modules/features/boards/board.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/boards/board ​

Components ​

Enumerations ​

Interfaces ​

Type Aliases ​

Board ​

Ƭ Board<T>: Replace<T & BaseBoard, { classes: GetComputableType<T["classes"]> ; height: GetComputableType<T["height"]> ; links: GetComputableTypeWithDefault<T["links"], Ref<BoardNodeLink[] | null>> ; state: GetComputableTypeWithDefault<T["state"], Persistent<BoardData>> ; style: GetComputableType<T["style"]> ; types: Record<string, GenericNodeType> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> ; width: GetComputableType<T["width"]> }>

An object that represents a feature that is a zoomable, pannable board with various nodes upon it.

Type parameters ​

NameType
Textends BoardOptions

Defined in ​

profectus/src/features/boards/board.ts:260

BoardData ​

Ƭ BoardData: Object

The persistent data for a board.

Type declaration ​

NameType
nodesBoardNode[]
selectedActionstring | null
selectedNodenumber | null

Defined in ​

profectus/src/features/boards/board.ts:77

BoardNodeAction ​

Ƭ BoardNodeAction<T>: Replace<T & BaseBoardNodeAction, { fillColor: GetComputableType<T["fillColor"]> ; icon: GetComputableType<T["icon"]> ; links: GetComputableType<T["links"]> ; tooltip: GetComputableType<T["tooltip"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>

An object that represents an action that can be taken upon a node.

Type parameters ​

NameType
Textends BoardNodeActionOptions

Defined in ​

profectus/src/features/boards/board.ts:194

GenericBoard ​

Ƭ GenericBoard: Replace<Board<BoardOptions>, { links: ProcessedComputable<BoardNodeLink[] | null> ; state: ProcessedComputable<BoardData> ; visibility: ProcessedComputable<Visibility | boolean> }>

A type that matches any valid Board object.

Defined in ​

profectus/src/features/boards/board.ts:275

GenericBoardNodeAction ​

Ƭ GenericBoardNodeAction: Replace<BoardNodeAction<BoardNodeActionOptions>, { visibility: NodeComputable<Visibility | boolean> }>

A type that matches any valid BoardNodeAction object.

Defined in ​

profectus/src/features/boards/board.ts:206

GenericNodeType ​

Ƭ GenericNodeType: Replace<NodeType<NodeTypeOptions>, { actionDistance: NodeComputable<number> ; canAccept: NodeComputable<boolean> ; draggable: NodeComputable<boolean> ; progressColor: NodeComputable<string> ; progressDisplay: NodeComputable<ProgressDisplay> ; shape: NodeComputable<Shape> ; size: NodeComputable<number> }>

A type that matches any valid NodeType object.

Defined in ​

profectus/src/features/boards/board.ts:153

NodeComputable ​

Ƭ NodeComputable<T>: Computable<T> | (node: BoardNode) => T

A type representing a computable value for a node on the board. Used for node types to return different values based on the given node and the state of the board.

Type parameters ​

Name
T

Defined in ​

profectus/src/features/boards/board.ts:36

NodeType ​

Ƭ NodeType<T>: Replace<T & BaseNodeType, { actionDistance: GetComputableTypeWithDefault<T["actionDistance"], number> ; actions?: GenericBoardNodeAction[] ; canAccept: GetComputableTypeWithDefault<T["canAccept"], false> ; draggable: GetComputableTypeWithDefault<T["draggable"], false> ; fillColor: GetComputableType<T["fillColor"]> ; label: GetComputableType<T["label"]> ; outlineColor: GetComputableType<T["outlineColor"]> ; progress: GetComputableType<T["progress"]> ; progressColor: GetComputableTypeWithDefault<T["progressColor"], "none"> ; progressDisplay: GetComputableTypeWithDefault<T["progressDisplay"], Fill> ; shape: GetComputableTypeWithDefault<T["shape"], Circle> ; size: GetComputableTypeWithDefault<T["size"], 50> ; title: GetComputableType<T["title"]> ; titleColor: GetComputableType<T["titleColor"]> }>

An object that represents a type of node that can appear on a board. It will handle getting properties and callbacks for every node of that type.

Type parameters ​

NameType
Textends NodeTypeOptions

Defined in ​

profectus/src/features/boards/board.ts:132

Variables ​

BoardType ​

• Const BoardType: typeof BoardType

A symbol used to identify Board features.

Defined in ​

profectus/src/features/boards/board.ts:31

Functions ​

createBoard ​

â–¸ createBoard<T>(optionsFunc): Board<T>

Lazily creates a board with the given options.

Type parameters ​

NameType
Textends BoardOptions

Parameters ​

NameTypeDescription
optionsFuncOptionsFunc<T, BaseBoard, GenericBoard>Board options.

Returns ​

Board<T>

Defined in ​

profectus/src/features/boards/board.ts:288

getNodeProperty ​

â–¸ getNodeProperty<T>(property, node): T

Gets the value of a property for a specified node.

Type parameters ​

Name
T

Parameters ​

NameTypeDescription
propertyNodeComputable<T>The property to find the value of
nodeBoardNodeThe node to get the property of

Returns ​

T

Defined in ​

profectus/src/features/boards/board.ts:456

getUniqueNodeID ​

â–¸ getUniqueNodeID(board): number

Utility to get an ID for a node that is guaranteed unique.

Parameters ​

NameTypeDescription
boardGenericBoardThe board feature to generate an ID for

Returns ​

number

Defined in ​

profectus/src/features/boards/board.ts:464

- diff --git a/api/modules/features/challenges/ChallengeComponent.html b/api/modules/features/challenges/ChallengeComponent.html index 8a47ca5d..6c4cf2d7 100644 --- a/api/modules/features/challenges/ChallengeComponent.html +++ b/api/modules/features/challenges/ChallengeComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Challenge ​

Props ​

NameTypes
active
*
processedPropType<boolean>(Boolean)
maxed
*
processedPropType<boolean>(Boolean)
canComplete
*
processedPropType<boolean>(Boolean)
display
processedPropType<UnwrapRef<GenericChallenge["display"]>>(
 String,
 Object,
 Function
)
requirements
processedPropType<Requirements>(Object, Array)
visibility
*
processedPropType<Visibility | boolean>(Number, Boolean)
style
processedPropType<StyleValue>(String, Object, Array)
classes
processedPropType<Record<string, boolean>>(Object)
completed
*
processedPropType<boolean>(Boolean)
canStart
*
processedPropType<boolean>(Boolean)
mark
processedPropType<boolean | string>(Boolean, String)
id
*
string
toggle
*
VoidFunction
- diff --git a/api/modules/features/challenges/challenge.html b/api/modules/features/challenges/challenge.html index 0dad2ea0..3b58ae74 100644 --- a/api/modules/features/challenges/challenge.html +++ b/api/modules/features/challenges/challenge.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/challenges/challenge ​

Components ​

Interfaces ​

Type Aliases ​

Challenge ​

Ƭ Challenge<T>: Replace<T & BaseChallenge, { canStart: GetComputableTypeWithDefault<T["canStart"], true> ; classes: GetComputableType<T["classes"]> ; completionLimit: GetComputableTypeWithDefault<T["completionLimit"], 1> ; display: GetComputableType<T["display"]> ; mark: GetComputableTypeWithDefault<T["mark"], Ref<boolean>> ; maximize: GetComputableType<T["maximize"]> ; requirements: GetComputableType<T["requirements"]> ; style: GetComputableType<T["style"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>

An object that represents a feature that can be entered and exited, and have one or more completions with scaling requirements.

Type parameters ​

NameType
Textends ChallengeOptions

Defined in ​

profectus/src/features/challenges/challenge.tsx:120

GenericChallenge ​

Ƭ GenericChallenge: Replace<Challenge<ChallengeOptions>, { canStart: ProcessedComputable<boolean> ; completionLimit: ProcessedComputable<DecimalSource> ; mark: ProcessedComputable<boolean> ; visibility: ProcessedComputable<Visibility | boolean> }>

A type that matches any valid Challenge object.

Defined in ​

profectus/src/features/challenges/challenge.tsx:136

Variables ​

ChallengeType ​

• Const ChallengeType: typeof ChallengeType

A symbol used to identify Challenge features.

Defined in ​

profectus/src/features/challenges/challenge.tsx:40

Functions ​

createActiveChallenge ​

â–¸ createActiveChallenge(challenges): Ref<GenericChallenge | null>

Utility for taking an array of challenges where only one may be active at a time, and giving a ref to the one currently active (or null if none are active)

Parameters ​

NameTypeDescription
challengesGenericChallenge[]The list of challenges that are mutually exclusive

Returns ​

Ref<GenericChallenge | null>

Defined in ​

profectus/src/features/challenges/challenge.tsx:324

createChallenge ​

â–¸ createChallenge<T>(optionsFunc): Challenge<T>

Lazily creates a challenge with the given options.

Type parameters ​

NameType
Textends ChallengeOptions

Parameters ​

NameTypeDescription
optionsFuncOptionsFunc<T, BaseChallenge, GenericChallenge>Challenge options.

Returns ​

Challenge<T>

Defined in ​

profectus/src/features/challenges/challenge.tsx:150

isAnyChallengeActive ​

â–¸ isAnyChallengeActive(challenges): Ref<boolean>

Utility for reporting if any challenge in a list is currently active. Intended for preventing entering a challenge if another is already active.

Parameters ​

NameTypeDescription
challengesGenericChallenge[] | Ref<null | GenericChallenge>List of challenges that are mutually exclusive

Returns ​

Ref<boolean>

Defined in ​

profectus/src/features/challenges/challenge.tsx:334

setupAutoComplete ​

â–¸ setupAutoComplete(challenge, autoActive?, exitOnComplete?): WatchStopHandle

This will automatically complete a challenge when it's requirements are met.

Parameters ​

NameTypeDefault valueDescription
challengeGenericChallengeundefinedThe challenge to auto-complete
autoActiveComputable<boolean>trueWhether or not auto-completing should currently occur
exitOnCompletebooleantrueWhether or not to exit the challenge after auto-completion

Returns ​

WatchStopHandle

Defined in ​

profectus/src/features/challenges/challenge.tsx:304

- diff --git a/api/modules/features/clickables/ClickableComponent.html b/api/modules/features/clickables/ClickableComponent.html index ce868428..7c13d9c9 100644 --- a/api/modules/features/clickables/ClickableComponent.html +++ b/api/modules/features/clickables/ClickableComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Clickable ​

Props ​

NameTypes
display
*
processedPropType<UnwrapRef<GenericClickable["display"]>>(
 Object,
 String,
 Function
)
visibility
*
processedPropType<Visibility | boolean>(Number, Boolean)
style
processedPropType<StyleValue>(Object, String, Array)
classes
processedPropType<Record<string, boolean>>(Object)
onClick
(e?: MouseEvent | TouchEvent) => void
onHold
VoidFunction
canClick
*
processedPropType<boolean>(Boolean)
small
boolean
mark
processedPropType<boolean | string>(Boolean, String)
id
*
string
- diff --git a/api/modules/features/clickables/clickable.html b/api/modules/features/clickables/clickable.html index be6528ee..9208170c 100644 --- a/api/modules/features/clickables/clickable.html +++ b/api/modules/features/clickables/clickable.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/clickables/clickable ​

Components ​

Interfaces ​

Type Aliases ​

Clickable ​

Ƭ Clickable<T>: Replace<T & BaseClickable, { canClick: GetComputableTypeWithDefault<T["canClick"], true> ; classes: GetComputableType<T["classes"]> ; display: GetComputableType<T["display"]> ; mark: GetComputableType<T["mark"]> ; style: GetComputableType<T["style"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>

An object that represents a feature that can be clicked or held down.

Type parameters ​

NameType
Textends ClickableOptions

Defined in ​

profectus/src/features/clickables/clickable.ts:72

GenericClickable ​

Ƭ GenericClickable: Replace<Clickable<ClickableOptions>, { canClick: ProcessedComputable<boolean> ; visibility: ProcessedComputable<Visibility | boolean> }>

A type that matches any valid Clickable object.

Defined in ​

profectus/src/features/clickables/clickable.ts:85

Variables ​

ClickableType ​

• Const ClickableType: typeof ClickableType

A symbol used to identify Clickable features.

Defined in ​

profectus/src/features/clickables/clickable.ts:23

Functions ​

createClickable ​

â–¸ createClickable<T>(optionsFunc?): Clickable<T>

Lazily creates a clickable with the given options.

Type parameters ​

NameType
Textends ClickableOptions

Parameters ​

NameTypeDescription
optionsFunc?OptionsFunc<T, BaseClickable, GenericClickable>Clickable options.

Returns ​

Clickable<T>

Defined in ​

profectus/src/features/clickables/clickable.ts:97

setupAutoClick ​

â–¸ setupAutoClick(layer, clickable, autoActive?): Unsubscribe

Utility to auto click a clickable whenever it can be.

Parameters ​

NameTypeDefault valueDescription
layerBaseLayerundefinedThe layer the clickable is apart of
clickableGenericClickableundefinedThe clicker to click automatically
autoActiveComputable<boolean>trueWhether or not the clickable should currently be auto-clicking

Returns ​

Unsubscribe

Defined in ​

profectus/src/features/clickables/clickable.ts:169

- diff --git a/api/modules/features/conversion.html b/api/modules/features/conversion.html index 9f28e66d..29966b8e 100644 --- a/api/modules/features/conversion.html +++ b/api/modules/features/conversion.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/conversion ​

Interfaces ​

Type Aliases ​

Conversion ​

Ƭ Conversion<T>: Replace<T & BaseConversion, { actualGain: GetComputableTypeWithDefault<T["actualGain"], Ref<DecimalSource>> ; buyMax: GetComputableTypeWithDefault<T["buyMax"], true> ; currentAt: GetComputableTypeWithDefault<T["currentAt"], Ref<DecimalSource>> ; currentGain: GetComputableTypeWithDefault<T["currentGain"], Ref<DecimalSource>> ; formula: InvertibleFormula ; nextAt: GetComputableTypeWithDefault<T["nextAt"], Ref<DecimalSource>> ; spend: undefined extends T["spend"] ? (amountGained: DecimalSource) => void : T["spend"] }>

An object that converts one Resource into another at a given rate.

Type parameters ​

NameType
Textends ConversionOptions

Defined in ​

profectus/src/features/conversion.ts:92

GenericConversion ​

Ƭ GenericConversion: Replace<Conversion<ConversionOptions>, { actualGain: ProcessedComputable<DecimalSource> ; buyMax: ProcessedComputable<boolean> ; currentAt: ProcessedComputable<DecimalSource> ; currentGain: ProcessedComputable<DecimalSource> ; nextAt: ProcessedComputable<DecimalSource> ; spend: (amountGained: DecimalSource) => void }>

A type that matches any valid Conversion object.

Defined in ​

profectus/src/features/conversion.ts:106

Functions ​

createConversion ​

â–¸ createConversion<T>(optionsFunc): Conversion<T>

Lazily creates a conversion with the given options. You typically shouldn't use this function directly. Instead use one of the other conversion constructors, which will then call this.

See

Type parameters ​

NameType
Textends ConversionOptions

Parameters ​

NameTypeDescription
optionsFuncOptionsFunc<T, BaseConversion, GenericConversion>Conversion options.

Returns ​

Conversion<T>

Defined in ​

profectus/src/features/conversion.ts:125

createCumulativeConversion ​

â–¸ createCumulativeConversion<S>(optionsFunc): Conversion<S>

Creates a conversion that simply adds to the gainResource amount upon converting. This is similar to the behavior of "normal" layers in The Modding Tree. This is equivalent to just calling createConversion directly.

Type parameters ​

NameType
Sextends ConversionOptions

Parameters ​

NameTypeDescription
optionsFuncOptionsFunc<S, BaseConversion, GenericConversion>Conversion options.

Returns ​

Conversion<S>

Defined in ​

profectus/src/features/conversion.ts:200

createIndependentConversion ​

â–¸ createIndependentConversion<S>(optionsFunc): Conversion<S>

Creates a conversion that will replace the gainResource amount with the new amount upon converting. This is similar to the behavior of "static" layers in The Modding Tree.

Type parameters ​

NameType
Sextends ConversionOptions

Parameters ​

NameTypeDescription
optionsFuncOptionsFunc<S, BaseConversion, GenericConversion>Converison options.

Returns ​

Conversion<S>

Defined in ​

profectus/src/features/conversion.ts:211

setupPassiveGeneration ​

â–¸ setupPassiveGeneration(layer, conversion, rate?, cap?): void

This will automatically increase the value of conversion.gainResource without lowering the value of the input resource. It will by default perform 100% of a conversion's currentGain per second. If you use a ref for the rate you can set it's value to 0 when passive generation should be disabled.

Parameters ​

NameTypeDefault valueDescription
layerBaseLayerundefinedThe layer this passive generation will be associated with. Typically this when calling this function from inside a layer's options function.
conversionGenericConversionundefinedThe conversion that will determine how much generation there is.
rateComputable<DecimalSource>1A multiplier to multiply against the conversion's currentGain.
capComputable<DecimalSource>Decimal.dInfA value that should not be passed via passive generation.

Returns ​

void

Defined in ​

profectus/src/features/conversion.ts:271

- diff --git a/api/modules/features/feature.html b/api/modules/features/feature.html index 10873708..fa345673 100644 --- a/api/modules/features/feature.html +++ b/api/modules/features/feature.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/feature ​

Enumerations ​

Type Aliases ​

CoercableComponent ​

Ƭ CoercableComponent: string | DefineComponent | JSXFunction

Any value that can be coerced into (or is) a vue component

Defined in ​

profectus/src/features/feature.ts:25

GenericComponent ​

Ƭ GenericComponent: DefineComponent<any, any, any>

A type that refers to any vue component

Defined in ​

profectus/src/features/feature.ts:35

JSXFunction ​

Ƭ JSXFunction: () => JSX.Element & { [DoNotCache]: true }

A type referring to a function that returns JSX and is marked that it shouldn't be wrapped in a ComputedRef

See

jsx

Defined in ​

profectus/src/features/feature.ts:21

OptionsFunc ​

Ƭ OptionsFunc<T, R, S>: () => T & Partial<R> & ThisType<T & S>

Type parameters ​

NameType
TT
RRecord<string, unknown>
SR

Type declaration ​

â–¸ (): T & Partial<R> & ThisType<T & S>

Utility function for a function that returns an object of a given type, with "this" bound to what the type will eventually be processed into. Intended for making lazily evaluated objects.

Returns ​

T & Partial<R> & ThisType<T & S>

Defined in ​

profectus/src/features/feature.ts:45

Replace ​

Ƭ Replace<T, S>: S & Omit<T, keyof S>

Utility type that is S, with any properties from T that aren't already present in S

Type parameters ​

Name
T
S

Defined in ​

profectus/src/features/feature.ts:38

StyleValue ​

Ƭ StyleValue: string | CSSProperties | (string | CSSProperties)[]

Any value that can be passed into an HTML element's style attribute. Note that Profectus uses its own StyleValue and CSSProperties that are extended, in order to have additional properties added to them, such as variable CSS variables.

Defined in ​

profectus/src/features/feature.ts:31

Variables ​

Component ​

• Const Component: typeof Component

A symbol to use as a key for a vue component a feature can be rendered with

See

VueFeature

Defined in ​

profectus/src/features/feature.ts:10

GatherProps ​

• Const GatherProps: typeof GatherProps

A symbol to use as a key for a prop gathering function that a feature can use to send to its component

See

VueFeature

Defined in ​

profectus/src/features/feature.ts:15

Functions ​

excludeFeatures ​

â–¸ excludeFeatures(obj, ...types): unknown[]

Traverses an object and returns all features that are not any of the given types. Features are any object with a "type" property that has a symbol value.

Parameters ​

NameTypeDescription
objRecord<string, unknown>The object to traverse
...typessymbol[]The feature types that will be skipped over

Returns ​

unknown[]

Defined in ​

profectus/src/features/feature.ts:130

findFeatures ​

â–¸ findFeatures(obj, ...types): unknown[]

Traverses an object and returns all features of the given type(s)

Parameters ​

NameTypeDescription
objRecord<string, unknown>The object to traverse
...typessymbol[]The feature types that will be searched for

Returns ​

unknown[]

Defined in ​

profectus/src/features/feature.ts:105

getUniqueID ​

â–¸ getUniqueID(prefix?): string

Gets a unique ID to give to each feature, used for any sort of system that needs to identify elements in the DOM rather than references to the feature itself. (For example, branches) IDs are guaranteed unique, but NOT persistent - they likely will change between updates.

Parameters ​

NameTypeDefault valueDescription
prefixstring"feature-"A string to prepend to the id to make it more readable in the inspector tools

Returns ​

string

Defined in ​

profectus/src/features/feature.ts:56

isHidden ​

â–¸ isHidden(visibility): boolean

Parameters ​

NameType
visibilityProcessedComputable<boolean | Visibility>

Returns ​

boolean

Defined in ​

profectus/src/features/feature.ts:75

isVisible ​

â–¸ isVisible(visibility): boolean

Parameters ​

NameType
visibilityProcessedComputable<boolean | Visibility>

Returns ​

boolean

Defined in ​

profectus/src/features/feature.ts:70

jsx ​

â–¸ jsx(func): JSXFunction

Takes a function and marks it as JSX so it won't get auto-wrapped into a ComputedRef. The function may also return empty string as empty JSX tags cause issues.

Parameters ​

NameType
func() => "" | Element

Returns ​

JSXFunction

Defined in ​

profectus/src/features/feature.ts:84

setDefault ​

â–¸ setDefault<T, K>(object, key, value): asserts object is Exclude<T, K> & Required<Pick<T, K>>

Utility function to set a property on an object if and only if it doesn't already exist

Type parameters ​

NameType
TT
Kextends string | number | symbol

Parameters ​

NameType
objectT
keyK
valueT[K]

Returns ​

asserts object is Exclude<T, K> & Required<Pick<T, K>>

Defined in ​

profectus/src/features/feature.ts:90

- diff --git a/api/modules/features/grids/GridCellComponent.html b/api/modules/features/grids/GridCellComponent.html index 06ef6d24..42a96d36 100644 --- a/api/modules/features/grids/GridCellComponent.html +++ b/api/modules/features/grids/GridCellComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: GridCell ​

Props ​

NameTypes
visibility
*
processedPropType<Visibility | boolean>(Number, Boolean)
onClick
(e?: MouseEvent | TouchEvent) => void
onHold
VoidFunction
display
*
processedPropType<CoercableComponent>(Object, String, Function)
title
processedPropType<CoercableComponent>(Object, String, Function)
style
processedPropType<StyleValue>(String, Object, Array)
canClick
*
processedPropType<boolean>(Boolean)
id
*
string
- diff --git a/api/modules/features/grids/GridComponent.html b/api/modules/features/grids/GridComponent.html index baae29de..9dec1842 100644 --- a/api/modules/features/grids/GridComponent.html +++ b/api/modules/features/grids/GridComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Grid ​

Props ​

NameTypes
visibility
*
processedPropType<Visibility | boolean>(Number, Boolean)
rows
*
processedPropType<number>(Number)
cols
*
processedPropType<number>(Number)
cells
*
processedPropType<Record<string, GridCell>>(Object)
- diff --git a/api/modules/features/grids/grid.html b/api/modules/features/grids/grid.html index 76cced8b..e0012e96 100644 --- a/api/modules/features/grids/grid.html +++ b/api/modules/features/grids/grid.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/grids/grid ​

Components ​

Interfaces ​

Type Aliases ​

CellComputable ​

Ƭ CellComputable<T>: Computable<T> | (id: string | number, state: State) => T

A type representing a computable value for a cell in the grid.

Type parameters ​

Name
T

Defined in ​

profectus/src/features/grids/grid.ts:28

GenericGrid ​

Ƭ GenericGrid: Replace<Grid<GridOptions>, { getCanClick: ProcessedComputable<boolean> ; getVisibility: ProcessedComputable<Visibility | boolean> ; visibility: ProcessedComputable<Visibility | boolean> }>

A type that matches any valid Grid object.

Defined in ​

profectus/src/features/grids/grid.ts:293

Grid ​

Ƭ Grid<T>: Replace<T & BaseGrid, { cols: GetComputableType<T["cols"]> ; getCanClick: GetComputableTypeWithDefault<T["getCanClick"], true> ; getClasses: GetComputableType<T["getClasses"]> ; getDisplay: GetComputableType<T["getDisplay"]> ; getStartState: GetComputableType<T["getStartState"]> ; getStyle: GetComputableType<T["getStyle"]> ; getTitle: GetComputableType<T["getTitle"]> ; getVisibility: GetComputableTypeWithDefault<T["getVisibility"], Visible> ; rows: GetComputableType<T["rows"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>

An object that represents a feature that is a grid of cells that all behave according to the same rules.

Type parameters ​

NameType
Textends GridOptions

Defined in ​

profectus/src/features/grids/grid.ts:276

Variables ​

GridType ​

• Const GridType: typeof GridType

A symbol used to identify Grid features.

Defined in ​

profectus/src/features/grids/grid.ts:25

Functions ​

createGrid ​

â–¸ createGrid<T>(optionsFunc): Grid<T>

Lazily creates a grid with the given options.

Type parameters ​

NameType
Textends GridOptions

Parameters ​

NameTypeDescription
optionsFuncOptionsFunc<T, BaseGrid, GenericGrid>Grid options.

Returns ​

Grid<T>

Defined in ​

profectus/src/features/grids/grid.ts:306

- diff --git a/api/modules/features/hotkey.html b/api/modules/features/hotkey.html index 9bcae367..2cca4af7 100644 --- a/api/modules/features/hotkey.html +++ b/api/modules/features/hotkey.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/hotkey ​

Interfaces ​

Type Aliases ​

GenericHotkey ​

Ƭ GenericHotkey: Replace<Hotkey<HotkeyOptions>, { enabled: ProcessedComputable<boolean> }>

A type that matches any valid Hotkey object.

Defined in ​

profectus/src/features/hotkey.tsx:55

Hotkey ​

Ƭ Hotkey<T>: Replace<T & BaseHotkey, { description: GetComputableType<T["description"]> ; enabled: GetComputableTypeWithDefault<T["enabled"], true> }>

An object that represents a hotkey shortcut that performs an action upon a key sequence being pressed.

Type parameters ​

NameType
Textends HotkeyOptions

Defined in ​

profectus/src/features/hotkey.tsx:46

Variables ​

HotkeyType ​

• Const HotkeyType: typeof HotkeyType

A symbol used to identify Hotkey features.

Defined in ​

profectus/src/features/hotkey.tsx:21

hotkeys ​

• Const hotkeys: Record<string, GenericHotkey | undefined>

A dictionary of all hotkeys.

Defined in ​

profectus/src/features/hotkey.tsx:19

Functions ​

createHotkey ​

â–¸ createHotkey<T>(optionsFunc): Hotkey<T>

Lazily creates a hotkey with the given options.

Type parameters ​

NameType
Textends HotkeyOptions

Parameters ​

NameTypeDescription
optionsFuncOptionsFunc<T, BaseHotkey, GenericHotkey>Hotkey options.

Returns ​

Hotkey<T>

Defined in ​

profectus/src/features/hotkey.tsx:68

- diff --git a/api/modules/features/infoboxes/InfoboxComponent.html b/api/modules/features/infoboxes/InfoboxComponent.html index 47744324..40959adb 100644 --- a/api/modules/features/infoboxes/InfoboxComponent.html +++ b/api/modules/features/infoboxes/InfoboxComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Infobox ​

Props ​

NameTypes
visibility
*
processedPropType<Visibility | boolean>(Number, Boolean)
display
*
processedPropType<CoercableComponent>(Object, String, Function)
title
*
processedPropType<CoercableComponent>(Object, String, Function)
color
processedPropType<string>(String)
collapsed
*
Ref<boolean>
style
processedPropType<StyleValue>(Object, String, Array)
titleStyle
processedPropType<StyleValue>(Object, String, Array)
bodyStyle
processedPropType<StyleValue>(Object, String, Array)
classes
processedPropType<Record<string, boolean>>(Object)
id
*
string
- diff --git a/api/modules/features/infoboxes/infobox.html b/api/modules/features/infoboxes/infobox.html index bcd8f117..722e3a06 100644 --- a/api/modules/features/infoboxes/infobox.html +++ b/api/modules/features/infoboxes/infobox.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/infoboxes/infobox ​

Components ​

Interfaces ​

Type Aliases ​

GenericInfobox ​

Ƭ GenericInfobox: Replace<Infobox<InfoboxOptions>, { visibility: ProcessedComputable<Visibility | boolean> }>

A type that matches any valid Infobox object.

Defined in ​

profectus/src/features/infoboxes/infobox.ts:79

Infobox ​

Ƭ Infobox<T>: Replace<T & BaseInfobox, { bodyStyle: GetComputableType<T["bodyStyle"]> ; classes: GetComputableType<T["classes"]> ; color: GetComputableType<T["color"]> ; display: GetComputableType<T["display"]> ; style: GetComputableType<T["style"]> ; title: GetComputableType<T["title"]> ; titleStyle: GetComputableType<T["titleStyle"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>

An object that represents a feature that displays information in a collapsible way.

Type parameters ​

NameType
Textends InfoboxOptions

Defined in ​

profectus/src/features/infoboxes/infobox.ts:64

Variables ​

InfoboxType ​

• Const InfoboxType: typeof InfoboxType

A symbol used to identify Infobox features.

Defined in ​

profectus/src/features/infoboxes/infobox.ts:23

Functions ​

createInfobox ​

â–¸ createInfobox<T>(optionsFunc): Infobox<T>

Lazily creates an infobox with the given options.

Type parameters ​

NameType
Textends InfoboxOptions

Parameters ​

NameTypeDescription
optionsFuncOptionsFunc<T, BaseInfobox, GenericInfobox>Infobox options.

Returns ​

Infobox<T>

Defined in ​

profectus/src/features/infoboxes/infobox.ts:90

- diff --git a/api/modules/features/links/LinkComponent.html b/api/modules/features/links/LinkComponent.html index 766c96a2..beae3fa8 100644 --- a/api/modules/features/links/LinkComponent.html +++ b/api/modules/features/links/LinkComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Link ​

Props ​

NameTypes
link
*
Link
startNode
*
FeatureNode
endNode
*
FeatureNode
boundingRect
*
DOMRect | undefined
- diff --git a/api/modules/features/links/LinksComponent.html b/api/modules/features/links/LinksComponent.html index 5ab683f2..3eadcb6e 100644 --- a/api/modules/features/links/LinksComponent.html +++ b/api/modules/features/links/LinksComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Links ​

Props ​

NameTypes
links
Link[]
- diff --git a/api/modules/features/links/links.html b/api/modules/features/links/links.html index 6e179256..d9ab0c86 100644 --- a/api/modules/features/links/links.html +++ b/api/modules/features/links/links.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/links/links ​

Components ​

Interfaces ​

Type Aliases ​

Ƭ GenericLinks: Replace<Links<LinksOptions>, { links: ProcessedComputable<Link[]> }>

A type that matches any valid Links object.

Defined in ​

profectus/src/features/links/links.ts:48

Ƭ Links<T>: Replace<T & BaseLinks, { links: GetComputableType<T["links"]> }>

An object that represents a list of links between nodes, which are the elements in the DOM for any renderable feature.

Type parameters ​

NameType
Textends LinksOptions

Defined in ​

profectus/src/features/links/links.ts:40

Variables ​

LinksType ​

• Const LinksType: typeof LinksType

A symbol used to identify Links features.

Defined in ​

profectus/src/features/links/links.ts:11

Functions ​

â–¸ createLinks<T>(optionsFunc): Links<T>

Lazily creates links with the given options.

Type parameters ​

NameType
Textends LinksOptions

Parameters ​

NameTypeDescription
optionsFuncOptionsFunc<T, BaseLinks, GenericLinks>Links options.

Returns ​

Links<T>

Defined in ​

profectus/src/features/links/links.ts:59

- diff --git a/api/modules/features/particles/ParticlesComponent.html b/api/modules/features/particles/ParticlesComponent.html index e90d4bdc..36fa0580 100644 --- a/api/modules/features/particles/ParticlesComponent.html +++ b/api/modules/features/particles/ParticlesComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Particles ​

Props ​

NameTypes
style
processedPropType<StyleValue>(String, Object, Array)
classes
processedPropType<Record<string, boolean>>(Object)
onInit
*
(app: Application) => void
id
*
string
onContainerResized
(rect: DOMRect) => void
onHotReload
VoidFunction
- diff --git a/api/modules/features/particles/particles.html b/api/modules/features/particles/particles.html index 35257fc1..a6fd94b5 100644 --- a/api/modules/features/particles/particles.html +++ b/api/modules/features/particles/particles.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/particles/particles ​

Components ​

Interfaces ​

Type Aliases ​

GenericParticles ​

Ƭ GenericParticles: Particles<ParticlesOptions>

A type that matches any valid Particles object.

Defined in ​

profectus/src/features/particles/particles.tsx:63

Particles ​

Ƭ Particles<T>: Replace<T & BaseParticles, { classes: GetComputableType<T["classes"]> ; style: GetComputableType<T["style"]> }>

An object that represents a feature that display particle effects on the screen. The config should typically be gotten by designing the effect using the online particle effect editor and passing it into the upgradeConfig from @pixi/particle-emitter.

Type parameters ​

NameType
Textends ParticlesOptions

Defined in ​

profectus/src/features/particles/particles.tsx:54

Variables ​

ParticlesType ​

• Const ParticlesType: typeof ParticlesType

A symbol used to identify Particles features.

Defined in ​

profectus/src/features/particles/particles.tsx:12

Functions ​

createParticles ​

â–¸ createParticles<T>(optionsFunc?): Particles<T>

Lazily creates particles with the given options.

Type parameters ​

NameType
Textends ParticlesOptions

Parameters ​

NameTypeDescription
optionsFunc?OptionsFunc<T, BaseParticles, GenericParticles>Particles options.

Returns ​

Particles<T>

Defined in ​

profectus/src/features/particles/particles.tsx:69

- diff --git a/api/modules/features/repeatable.html b/api/modules/features/repeatable.html index 5683998e..fb5d6329 100644 --- a/api/modules/features/repeatable.html +++ b/api/modules/features/repeatable.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/repeatable ​

Interfaces ​

Type Aliases ​

GenericRepeatable ​

Ƭ GenericRepeatable: Replace<Repeatable<RepeatableOptions>, { limit: ProcessedComputable<DecimalSource> ; visibility: ProcessedComputable<Visibility | boolean> }>

A type that matches any valid Repeatable object.

Defined in ​

profectus/src/features/repeatable.tsx:119

Repeatable ​

Ƭ Repeatable<T>: Replace<T & BaseRepeatable, { classes: GetComputableType<T["classes"]> ; display: Ref<CoercableComponent> ; limit: GetComputableTypeWithDefault<T["limit"], default> ; mark: GetComputableType<T["mark"]> ; maximize: GetComputableType<T["maximize"]> ; requirements: GetComputableType<T["requirements"]> ; small: GetComputableType<T["small"]> ; style: GetComputableType<T["style"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>

An object that represents a feature with multiple "levels" with scaling requirements.

Type parameters ​

NameType
Textends RepeatableOptions

Defined in ​

profectus/src/features/repeatable.tsx:103

RepeatableDisplay ​

Ƭ RepeatableDisplay: CoercableComponent | { description?: CoercableComponent ; effectDisplay?: CoercableComponent ; showAmount?: boolean ; title?: CoercableComponent }

A type that can be used to customize the Repeatable display.

Defined in ​

profectus/src/features/repeatable.tsx:38

Variables ​

RepeatableType ​

• Const RepeatableType: typeof RepeatableType

A symbol used to identify Repeatable features.

Defined in ​

profectus/src/features/repeatable.tsx:35

Functions ​

createRepeatable ​

â–¸ createRepeatable<T>(optionsFunc): Repeatable<T>

Lazily creates a repeatable with the given options.

Type parameters ​

NameType
Textends RepeatableOptions

Parameters ​

NameTypeDescription
optionsFuncOptionsFunc<T, BaseRepeatable, GenericRepeatable>Repeatable options.

Returns ​

Repeatable<T>

Defined in ​

profectus/src/features/repeatable.tsx:131

- diff --git a/api/modules/features/reset.html b/api/modules/features/reset.html index 90290b23..cbec459f 100644 --- a/api/modules/features/reset.html +++ b/api/modules/features/reset.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/reset ​

Interfaces ​

Type Aliases ​

GenericReset ​

Ƭ GenericReset: Reset<ResetOptions>

A type that matches any valid Reset object.

Defined in ​

profectus/src/features/reset.ts:48

Reset ​

Ƭ Reset<T>: Replace<T & BaseReset, { thingsToReset: GetComputableType<T["thingsToReset"]> }>

An object that represents a reset mechanic, which resets progress back to its initial state.

Type parameters ​

NameType
Textends ResetOptions

Defined in ​

profectus/src/features/reset.ts:40

Variables ​

ResetType ​

• Const ResetType: typeof ResetType

A symbol used to identify Reset features.

Defined in ​

profectus/src/features/reset.ts:15

Functions ​

createReset ​

â–¸ createReset<T>(optionsFunc): Reset<T>

Lazily creates a reset with the given options.

Type parameters ​

NameType
Textends ResetOptions

Parameters ​

NameTypeDescription
optionsFuncOptionsFunc<T, BaseReset, GenericReset>Reset options.

Returns ​

Reset<T>

Defined in ​

profectus/src/features/reset.ts:54

trackResetTime ​

â–¸ trackResetTime(layer, reset): Persistent<default>

Track the time since the specified reset last occured.

Parameters ​

NameTypeDescription
layerBaseLayerThe layer the reset is attached to
resetGenericResetThe reset mechanic to track the time since

Returns ​

Persistent<default>

Defined in ​

profectus/src/features/reset.ts:92

- diff --git a/api/modules/features/resources/MainDisplayComponent.html b/api/modules/features/resources/MainDisplayComponent.html index 1b8edcc7..f9e8a7d0 100644 --- a/api/modules/features/resources/MainDisplayComponent.html +++ b/api/modules/features/resources/MainDisplayComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: MainDisplay ​

Props ​

NameTypes
resource
*
Resource
color
string
classes
Record
style
StyleValue
effectDisplay
CoercableComponent
- diff --git a/api/modules/features/resources/ResourceComponent.html b/api/modules/features/resources/ResourceComponent.html index a7f836f5..36fe46b0 100644 --- a/api/modules/features/resources/ResourceComponent.html +++ b/api/modules/features/resources/ResourceComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Resource ​

Props ​

NameTypes
resource
*
Resource
color
*
string
- diff --git a/api/modules/features/resources/resource.html b/api/modules/features/resources/resource.html index 8584915a..6cb3c72a 100644 --- a/api/modules/features/resources/resource.html +++ b/api/modules/features/resources/resource.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/resources/resource ​

Components ​

Interfaces ​

Functions ​

createResource ​

â–¸ createResource<T>(defaultValue, displayName?, precision?, small?): Resource<T> & Persistent<T> & { [NonPersistent]: Resource<T> }

Creates a resource.

Type parameters ​

NameType
Textends State

Parameters ​

NameTypeDescription
defaultValueTThe initial value of the resource
displayName?stringThe human readable name of this resource
precision?numberThe number of significant digits to display by default
small?booleanWhether or not to display very small values or round to 0, by default

Returns ​

Resource<T> & Persistent<T> & { [NonPersistent]: Resource<T> }

Defined in ​

profectus/src/features/resources/resource.ts:28

â–¸ createResource<T>(defaultValue, displayName?, precision?, small?): Resource<T>

Type parameters ​

NameType
Textends State

Parameters ​

NameType
defaultValueRef<T>
displayName?string
precision?number
small?boolean

Returns ​

Resource<T>

Defined in ​

profectus/src/features/resources/resource.ts:34

displayResource ​

â–¸ displayResource(resource, overrideAmount?): string

Utility for displaying a resource with the correct precision.

Parameters ​

NameType
resourceResource<DecimalSource>
overrideAmount?DecimalSource

Returns ​

string

Defined in ​

profectus/src/features/resources/resource.ts:153

trackBest ​

â–¸ trackBest(resource): Ref<DecimalSource>

Returns a reference to the highest amount of the resource ever owned, which is updated automatically.

Parameters ​

NameType
resourceResource<DecimalSource>

Returns ​

Ref<DecimalSource>

Defined in ​

profectus/src/features/resources/resource.ts:64

trackOOMPS ​

â–¸ trackOOMPS(resource, pointGain?): Ref<string>

Returns a reference to the amount of resource being gained in terms of orders of magnitude per second, calcualted over the last tick. Useful for situations where the gain rate is increasing very rapidly.

Parameters ​

NameType
resourceResource<DecimalSource>
pointGain?ComputedRef<DecimalSource>

Returns ​

Ref<string>

Defined in ​

profectus/src/features/resources/resource.ts:94

trackTotal ​

â–¸ trackTotal(resource): Ref<DecimalSource>

Returns a reference to the total amount of the resource gained, updated automatically. "Refunds" count as gain.

Parameters ​

NameType
resourceResource<DecimalSource>

Returns ​

Ref<DecimalSource>

Defined in ​

profectus/src/features/resources/resource.ts:78

unwrapResource ​

â–¸ unwrapResource(resource): Resource

Utility for unwrapping a resource that may or may not be inside a ref.

Parameters ​

NameType
resourceProcessedComputable<Resource<DecimalSource>>

Returns ​

Resource

Defined in ​

profectus/src/features/resources/resource.ts:162

- diff --git a/api/modules/features/tabs/TabButtonComponent.html b/api/modules/features/tabs/TabButtonComponent.html index af909bdb..4a75b6de 100644 --- a/api/modules/features/tabs/TabButtonComponent.html +++ b/api/modules/features/tabs/TabButtonComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: TabButton ​

Props ​

NameTypes
visibility
*
processedPropType<Visibility | boolean>(Number, Boolean)
display
*
processedPropType<CoercableComponent>(Object, String, Function)
style
processedPropType<StyleValue>(String, Object, Array)
classes
processedPropType<Record<string, boolean>>(Object)
glowColor
processedPropType<string>(String)
active
boolean
floating
boolean

Events ​

Name
selectTab
- diff --git a/api/modules/features/tabs/TabComponent.html b/api/modules/features/tabs/TabComponent.html index b060228f..e02ec954 100644 --- a/api/modules/features/tabs/TabComponent.html +++ b/api/modules/features/tabs/TabComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Tab ​

Props ​

NameTypes
display
*
CoercableComponent
- diff --git a/api/modules/features/tabs/TabFamilyComponent.html b/api/modules/features/tabs/TabFamilyComponent.html index 00be2c16..f8e8ddb9 100644 --- a/api/modules/features/tabs/TabFamilyComponent.html +++ b/api/modules/features/tabs/TabFamilyComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: TabFamily ​

Props ​

NameTypes
visibility
*
processedPropType<Visibility | boolean>(Number, Boolean)
activeTab
*
processedPropType<GenericTab | CoercableComponent | null>(Object)
selected
*
Ref<string>
tabs
*
processedPropType<Record<string, GenericTabButton>>(Object)
style
processedPropType<StyleValue>(String, Object, Array)
classes
processedPropType<Record<string, boolean>>(Object)
buttonContainerStyle
processedPropType<StyleValue>(String, Object, Array)
buttonContainerClasses
processedPropType<Record<string, boolean>>(Object)
- diff --git a/api/modules/features/tabs/tab.html b/api/modules/features/tabs/tab.html index a69759c4..d33aa069 100644 --- a/api/modules/features/tabs/tab.html +++ b/api/modules/features/tabs/tab.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/tabs/tab ​

Components ​

Interfaces ​

Type Aliases ​

GenericTab ​

Ƭ GenericTab: Tab<TabOptions>

A type that matches any valid Tab object.

Defined in ​

profectus/src/features/tabs/tab.ts:56

Tab ​

Ƭ Tab<T>: Replace<T & BaseTab, { classes: GetComputableType<T["classes"]> ; display: GetComputableType<T["display"]> ; style: GetComputableType<T["style"]> }>

An object representing a tab of content in a tabbed interface.

See

TabFamily

Type parameters ​

NameType
Textends TabOptions

Defined in ​

profectus/src/features/tabs/tab.ts:46

Variables ​

TabType ​

• Const TabType: typeof TabType

A symbol used to identify Tab features.

Defined in ​

profectus/src/features/tabs/tab.ts:14

Functions ​

createTab ​

â–¸ createTab<T>(optionsFunc): Tab<T>

Lazily creates a tab with the given options.

Type parameters ​

NameType
Textends TabOptions

Parameters ​

NameTypeDescription
optionsFuncOptionsFunc<T, BaseTab, GenericTab>Tab options.

Returns ​

Tab<T>

Defined in ​

profectus/src/features/tabs/tab.ts:62

- diff --git a/api/modules/features/tabs/tabFamily.html b/api/modules/features/tabs/tabFamily.html index b510a021..481c9e9e 100644 --- a/api/modules/features/tabs/tabFamily.html +++ b/api/modules/features/tabs/tabFamily.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/tabs/tabFamily ​

Components ​

Interfaces ​

Type Aliases ​

GenericTabButton ​

Ƭ GenericTabButton: Replace<TabButton<TabButtonOptions>, { visibility: ProcessedComputable<Visibility | boolean> }>

A type that matches any valid TabButton object.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:82

GenericTabFamily ​

Ƭ GenericTabFamily: Replace<TabFamily<TabFamilyOptions>, { visibility: ProcessedComputable<Visibility | boolean> }>

A type that matches any valid TabFamily object.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:138

TabButton ​

Ƭ TabButton<T>: Replace<T & BaseTabButton, { classes: GetComputableType<T["classes"]> ; display: GetComputableType<T["display"]> ; glowColor: GetComputableType<T["glowColor"]> ; style: GetComputableType<T["style"]> ; tab: GetComputableType<T["tab"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>

An object that represents a button that can be clicked to change tabs in a tabbed interface.

See

TabFamily

Type parameters ​

NameType
Textends TabButtonOptions

Defined in ​

profectus/src/features/tabs/tabFamily.ts:69

TabFamily ​

Ƭ TabFamily<T>: Replace<T & BaseTabFamily, { tabs: Record<string, GenericTabButton> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>

An object that represents a tabbed interface.

See

TabFamily

Type parameters ​

NameType
Textends TabFamilyOptions

Defined in ​

profectus/src/features/tabs/tabFamily.ts:129

Variables ​

TabButtonType ​

• Const TabButtonType: typeof TabButtonType

A symbol used to identify TabButton features.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:33

TabFamilyType ​

• Const TabFamilyType: typeof TabFamilyType

A symbol used to identify TabFamily features.

Defined in ​

profectus/src/features/tabs/tabFamily.ts:35

Functions ​

createTabFamily ​

â–¸ createTabFamily<T>(tabs, optionsFunc?): TabFamily<T>

Lazily creates a tab family with the given options.

Type parameters ​

NameType
Textends TabFamilyOptions

Parameters ​

NameTypeDescription
tabsRecord<string, () => TabButtonOptions>-
optionsFunc?OptionsFunc<T, BaseTabFamily, GenericTabFamily>Tab family options.

Returns ​

TabFamily<T>

Defined in ​

profectus/src/features/tabs/tabFamily.ts:149

- diff --git a/api/modules/features/tooltips/TooltipComponent.html b/api/modules/features/tooltips/TooltipComponent.html index 724118fb..a5cced45 100644 --- a/api/modules/features/tooltips/TooltipComponent.html +++ b/api/modules/features/tooltips/TooltipComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Tooltip ​

Props ​

NameTypes
element
VueFeature
display
*
processedPropType<CoercableComponent>(Object, String, Function)
style
processedPropType<StyleValue>(Object, String, Array)
classes
processedPropType<Record<string, boolean>>(Object)
direction
processedPropType<Direction>(String)
xoffset
processedPropType<string>(String)
yoffset
processedPropType<string>(String)
pinned
Persistent<boolean>

Slots ​

Name
default
- diff --git a/api/modules/features/tooltips/tooltip.html b/api/modules/features/tooltips/tooltip.html index 09a84818..6f173918 100644 --- a/api/modules/features/tooltips/tooltip.html +++ b/api/modules/features/tooltips/tooltip.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/tooltips/tooltip ​

Components ​

Interfaces ​

Type Aliases ​

GenericTooltip ​

Ƭ GenericTooltip: Replace<Tooltip<TooltipOptions>, { direction: ProcessedComputable<Direction> ; pinnable: boolean ; pinned: Ref<boolean> | undefined }>

A type that matches any valid Tooltip object.

Defined in ​

profectus/src/features/tooltips/tooltip.ts:67

Tooltip ​

Ƭ Tooltip<T>: Replace<T & BaseTooltip, { classes: GetComputableType<T["classes"]> ; direction: GetComputableTypeWithDefault<T["direction"], Up> ; display: GetComputableType<T["display"]> ; pinnable: T["pinnable"] extends undefined ? false : T["pinnable"] ; pinned: T["pinnable"] extends true ? Ref<boolean> : undefined ; style: GetComputableType<T["style"]> ; xoffset: GetComputableType<T["xoffset"]> ; yoffset: GetComputableType<T["yoffset"]> }>

An object that represents a tooltip that appears when hovering over an element.

Type parameters ​

NameType
Textends TooltipOptions

Defined in ​

profectus/src/features/tooltips/tooltip.ts:52

Functions ​

addTooltip ​

â–¸ addTooltip<T>(element, options): Tooltip<T>

Creates a tooltip on the given element with the given options.

Type parameters ​

NameType
Textends TooltipOptions

Parameters ​

NameTypeDescription
elementVueFeatureThe renderable feature to display the tooltip on.
optionsT & ThisType<Tooltip<T>> & Partial<BaseTooltip>Tooltip options.

Returns ​

Tooltip<T>

Defined in ​

profectus/src/features/tooltips/tooltip.ts:81

- diff --git a/api/modules/features/trees/TreeComponent.html b/api/modules/features/trees/TreeComponent.html index f81bea45..fb9cb723 100644 --- a/api/modules/features/trees/TreeComponent.html +++ b/api/modules/features/trees/TreeComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Tree ​

Props ​

NameTypes
nodes
*
processedPropType<GenericTreeNode[][]>(Array)
leftSideNodes
processedPropType<GenericTreeNode[]>(Array)
rightSideNodes
processedPropType<GenericTreeNode[]>(Array)
branches
processedPropType<TreeBranch[]>(Array)
- diff --git a/api/modules/features/trees/TreeNodeComponent.html b/api/modules/features/trees/TreeNodeComponent.html index 98cfed84..7d9a5bcb 100644 --- a/api/modules/features/trees/TreeNodeComponent.html +++ b/api/modules/features/trees/TreeNodeComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: TreeNode ​

Props ​

NameTypes
display
processedPropType<CoercableComponent>(Object, String, Function)
visibility
*
processedPropType<Visibility | boolean>(Number, Boolean)
style
processedPropType<StyleValue>(String, Object, Array)
classes
processedPropType<Record<string, boolean>>(Object)
onClick
(e?: MouseEvent | TouchEvent) => void
onHold
VoidFunction
color
processedPropType<string>(String)
glowColor
processedPropType<string>(String)
canClick
*
processedPropType<boolean>(Boolean)
mark
processedPropType<boolean | string>(Boolean, String)
id
*
string
- diff --git a/api/modules/features/trees/tree.html b/api/modules/features/trees/tree.html index ed4cbbb5..7f12bcca 100644 --- a/api/modules/features/trees/tree.html +++ b/api/modules/features/trees/tree.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/trees/tree ​

Components ​

Interfaces ​

Type Aliases ​

GenericTree ​

Ƭ GenericTree: Replace<Tree<TreeOptions>, { visibility: ProcessedComputable<Visibility | boolean> }>

A type that matches any valid Tree object.

Defined in ​

profectus/src/features/trees/tree.ts:231

GenericTreeNode ​

Ƭ GenericTreeNode: Replace<TreeNode<TreeNodeOptions>, { canClick: ProcessedComputable<boolean> ; visibility: ProcessedComputable<Visibility | boolean> }>

A type that matches any valid TreeNode object.

Defined in ​

profectus/src/features/trees/tree.ts:91

ResetPropagation ​

Ƭ ResetPropagation: (tree: GenericTree, resettingNode: GenericTreeNode) => void

Type declaration ​

â–¸ (tree, resettingNode): void

A function that is used to propagate resets through a tree.

Parameters ​
NameType
treeGenericTree
resettingNodeGenericTreeNode
Returns ​

void

Defined in ​

profectus/src/features/trees/tree.ts:285

Tree ​

Ƭ Tree<T>: Replace<T & BaseTree, { branches: GetComputableType<T["branches"]> ; leftSideNodes: GetComputableType<T["leftSideNodes"]> ; nodes: GetComputableType<T["nodes"]> ; rightSideNodes: GetComputableType<T["rightSideNodes"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>

An object that represents a feature that is a tree of nodes with branches between them. Contains support for reset mechanics that can propagate through the tree.

Type parameters ​

NameType
Textends TreeOptions

Defined in ​

profectus/src/features/trees/tree.ts:219

TreeNode ​

Ƭ TreeNode<T>: Replace<T & BaseTreeNode, { canClick: GetComputableTypeWithDefault<T["canClick"], true> ; classes: GetComputableType<T["classes"]> ; color: GetComputableType<T["color"]> ; display: GetComputableType<T["display"]> ; glowColor: GetComputableType<T["glowColor"]> ; mark: GetComputableType<T["mark"]> ; style: GetComputableType<T["style"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>

An object that represents a node on a tree.

Type parameters ​

NameType
Textends TreeNodeOptions

Defined in ​

profectus/src/features/trees/tree.ts:76

Variables ​

TreeNodeType ​

• Const TreeNodeType: typeof TreeNodeType

A symbol used to identify TreeNode features.

Defined in ​

profectus/src/features/trees/tree.ts:29

TreeType ​

• Const TreeType: typeof TreeType

A symbol used to identify Tree features.

Defined in ​

profectus/src/features/trees/tree.ts:31

Functions ​

branchedResetPropagation ​

â–¸ branchedResetPropagation(tree, resettingNode): void

Propagate resets down the branches of the tree.

Parameters ​

NameType
treeGenericTree
resettingNodeGenericTreeNode

Returns ​

void

Defined in ​

profectus/src/features/trees/tree.ts:314

createResourceTooltip ​

â–¸ createResourceTooltip(resource, requiredResource?, requirement?): Ref<string>

Utility for creating a tooltip for a tree node that displays a resource-based unlock requirement, and after unlock shows the amount of another resource. It sounds oddly specific, but comes up a lot.

Parameters ​

NameTypeDefault value
resourceResource<DecimalSource>undefined
requiredResourcenull | Resource<DecimalSource>null
requirementComputable<DecimalSource>0

Returns ​

Ref<string>

Defined in ​

profectus/src/features/trees/tree.ts:353

createTree ​

â–¸ createTree<T>(optionsFunc): Tree<T>

Lazily creates a tree with the given options.

Type parameters ​

NameType
Textends TreeOptions

Parameters ​

NameTypeDescription
optionsFuncOptionsFunc<T, BaseTree, GenericTree>Tree options.

Returns ​

Tree<T>

Defined in ​

profectus/src/features/trees/tree.ts:242

createTreeNode ​

â–¸ createTreeNode<T>(optionsFunc?): TreeNode<T>

Lazily creates a tree node with the given options.

Type parameters ​

NameType
Textends TreeNodeOptions

Parameters ​

NameTypeDescription
optionsFunc?OptionsFunc<T, BaseTreeNode, GenericTreeNode>Tree Node options.

Returns ​

TreeNode<T>

Defined in ​

profectus/src/features/trees/tree.ts:103

defaultResetPropagation ​

â–¸ defaultResetPropagation(tree, resettingNode): void

Propagate resets down the tree by resetting every node in a lower row.

Parameters ​

NameType
treeGenericTree
resettingNodeGenericTreeNode

Returns ​

void

Defined in ​

profectus/src/features/trees/tree.ts:290

invertedResetPropagation ​

â–¸ invertedResetPropagation(tree, resettingNode): void

Propagate resets down the tree by resetting every node in a lower row.

Parameters ​

NameType
treeGenericTree
resettingNodeGenericTreeNode

Returns ​

void

Defined in ​

profectus/src/features/trees/tree.ts:302

- diff --git a/api/modules/features/upgrades/UpgradeComponent.html b/api/modules/features/upgrades/UpgradeComponent.html index f6b119b6..a1c6351d 100644 --- a/api/modules/features/upgrades/UpgradeComponent.html +++ b/api/modules/features/upgrades/UpgradeComponent.html @@ -22,7 +22,7 @@
Profectus
On this page

Component: Upgrade ​

Props ​

NameTypes
display
*
processedPropType<UnwrapRef<GenericUpgrade["display"]>>(String, Object, Function)
visibility
*
processedPropType<Visibility | boolean>(Number, Boolean)
style
processedPropType<StyleValue>(String, Object, Array)
classes
processedPropType<Record<string, boolean>>(Object)
requirements
*
Requirements
canPurchase
*
processedPropType<boolean>(Boolean)
bought
*
processedPropType<boolean>(Boolean)
mark
processedPropType<boolean | string>(Boolean, String)
id
*
string
purchase
*
VoidFunction
- diff --git a/api/modules/features/upgrades/upgrade.html b/api/modules/features/upgrades/upgrade.html index 869cdc7f..66f70815 100644 --- a/api/modules/features/upgrades/upgrade.html +++ b/api/modules/features/upgrades/upgrade.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: features/upgrades/upgrade ​

Components ​

Interfaces ​

Type Aliases ​

GenericUpgrade ​

Ƭ GenericUpgrade: Replace<Upgrade<UpgradeOptions>, { visibility: ProcessedComputable<Visibility | boolean> }>

A type that matches any valid Upgrade object.

Defined in ​

profectus/src/features/upgrades/upgrade.ts:106

Upgrade ​

Ƭ Upgrade<T>: Replace<T & BaseUpgrade, { classes: GetComputableType<T["classes"]> ; display: GetComputableType<T["display"]> ; mark: GetComputableType<T["mark"]> ; requirements: GetComputableType<T["requirements"]> ; style: GetComputableType<T["style"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>

An object that represents a feature that can be purchased a single time.

Type parameters ​

NameType
Textends UpgradeOptions

Defined in ​

profectus/src/features/upgrades/upgrade.ts:93

Variables ​

UpgradeType ​

• Const UpgradeType: typeof UpgradeType

A symbol used to identify Upgrade features.

Defined in ​

profectus/src/features/upgrades/upgrade.ts:40

Functions ​

createUpgrade ​

â–¸ createUpgrade<T>(optionsFunc): Upgrade<T>

Lazily creates an upgrade with the given options.

Type parameters ​

NameType
Textends UpgradeOptions

Parameters ​

NameTypeDescription
optionsFuncOptionsFunc<T, BaseUpgrade, GenericUpgrade>Upgrade options.

Returns ​

Upgrade<T>

Defined in ​

profectus/src/features/upgrades/upgrade.ts:117

setupAutoPurchase ​

â–¸ setupAutoPurchase(layer, autoActive, upgrades?): void

Utility to auto purchase a list of upgrades whenever they're affordable.

Parameters ​

NameTypeDefault valueDescription
layerGenericLayerundefinedThe layer the upgrades are apart of
autoActiveComputable<boolean>undefinedWhether or not the upgrades should currently be auto-purchasing
upgradesGenericUpgrade[][]The specific upgrades to upgrade. If unspecified, uses all upgrades on the layer.

Returns ​

void

Defined in ​

profectus/src/features/upgrades/upgrade.ts:190

- diff --git a/api/modules/game/events.html b/api/modules/game/events.html index f5540835..77e3e35f 100644 --- a/api/modules/game/events.html +++ b/api/modules/game/events.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: game/events ​

Interfaces ​

Variables ​

globalBus ​

• Const globalBus: Emitter<GlobalEvents>

A global event bus for hooking into GlobalEvents.

Defined in ​

profectus/src/game/events.ts:55

- diff --git a/api/modules/game/formulas/formulas.html b/api/modules/game/formulas/formulas.html index b0e1bc28..33765d0c 100644 --- a/api/modules/game/formulas/formulas.html +++ b/api/modules/game/formulas/formulas.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: game/formulas/formulas ​

Classes ​

Functions ​

calculateCost ​

â–¸ calculateCost(formula, amountToBuy, spendResources?, summedPurchases?): DecimalSource

Utility for calculating the cost of a formula for a given amount of purchases. If spendResources is changed to false, the calculation will be much faster with higher numbers.

Parameters ​

NameTypeDescription
formulaInvertibleFormulaThe formula to use for calculating buy max from
amountToBuyDecimalSourceThe amount of purchases to calculate the cost for
spendResources?trueWhether or not to count spent resources on each purchase or not. If true, costs will be approximated for performance, skewing towards higher cost
summedPurchases?numberHow many purchases to manually sum for improved accuracy. If not specified, defaults to 10 when spending resources and 0 when not

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/formulas.ts:1433

â–¸ calculateCost(formula, amountToBuy, spendResources, summedPurchases?): DecimalSource

Parameters ​

NameType
formulaInvertibleIntegralFormula
amountToBuyDecimalSource
spendResourcesboolean
summedPurchases?number

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/formulas.ts:1439

calculateMaxAffordable ​

â–¸ calculateMaxAffordable(formula, resource, spendResources?, summedPurchases?): ComputedRef<DecimalSource>

Utility for calculating the maximum amount of purchases possible with a given formula and resource. If spendResources is changed to false, the calculation will be much faster with higher numbers.

Parameters ​

NameTypeDescription
formulaInvertibleFormulaThe formula to use for calculating buy max from
resourceResource<DecimalSource>The resource used when purchasing (is only read from)
spendResources?trueWhether or not to count spent resources on each purchase or not. If true, costs will be approximated for performance, skewing towards fewer purchases
summedPurchases?numberHow many of the most expensive purchases should be manually summed for better accuracy. If unspecified uses 10 when spending resources and 0 when not

Returns ​

ComputedRef<DecimalSource>

Defined in ​

profectus/src/game/formulas/formulas.ts:1365

â–¸ calculateMaxAffordable(formula, resource, spendResources, summedPurchases?): ComputedRef<DecimalSource>

Parameters ​

NameType
formulaInvertibleIntegralFormula
resourceResource<DecimalSource>
spendResourcesComputable<boolean>
summedPurchases?number

Returns ​

ComputedRef<DecimalSource>

Defined in ​

profectus/src/game/formulas/formulas.ts:1371

findNonInvertible ​

â–¸ findNonInvertible(formula): GenericFormula | null

Utility for recursively searching through a formula for the cause of non-invertibility.

Parameters ​

NameTypeDescription
formulaGenericFormulaThe formula to search for a non-invertible formula within

Returns ​

GenericFormula | null

Defined in ​

profectus/src/game/formulas/formulas.ts:1322

hasVariable ​

â–¸ hasVariable(value): value is InvertibleFormula

Parameters ​

NameType
valueFormulaSource

Returns ​

value is InvertibleFormula

Defined in ​

profectus/src/game/formulas/formulas.ts:23

printFormula ​

â–¸ printFormula(formula): string

Stringifies a formula so it's more easy to read in the console

Parameters ​

NameTypeDescription
formulaFormulaSourceThe formula to print

Returns ​

string

Defined in ​

profectus/src/game/formulas/formulas.ts:1340

unrefFormulaSource ​

â–¸ unrefFormulaSource(value, variable?): DecimalSource

Parameters ​

NameType
valueFormulaSource
variable?DecimalSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/formulas.ts:27

- diff --git a/api/modules/game/formulas/operations.html b/api/modules/game/formulas/operations.html index 16a35744..ce5f70dc 100644 --- a/api/modules/game/formulas/operations.html +++ b/api/modules/game/formulas/operations.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: game/formulas/operations ​

Functions ​

applySubstitutionDiv ​

â–¸ applySubstitutionDiv(value, lhs, rhs): GenericFormula

Parameters ​

NameType
valueGenericFormula
lhsFormulaSource
rhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:152

applySubstitutionMul ​

â–¸ applySubstitutionMul(value, lhs, rhs): GenericFormula

Parameters ​

NameType
valueGenericFormula
lhsFormulaSource
rhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:119

applySubstitutionNeg ​

â–¸ applySubstitutionNeg(value): GenericFormula

Parameters ​

NameType
valueGenericFormula

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:25

createPassthroughBinaryFormula ​

â–¸ createPassthroughBinaryFormula(operation): (value: FormulaSource, other: FormulaSource) => default<[FormulaSource, FormulaSource]>

Parameters ​

NameType
operation(a: DecimalSource, b: DecimalSource) => DecimalSource

Returns ​

fn

â–¸ (value, other): default<[FormulaSource, FormulaSource]>

Parameters ​
NameType
valueFormulaSource
otherFormulaSource
Returns ​

default<[FormulaSource, FormulaSource]>

Defined in ​

profectus/src/game/formulas/operations.ts:696

integrateAcos ​

â–¸ integrateAcos(stack, lhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:575

integrateAcosh ​

â–¸ integrateAcosh(stack, lhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:669

integrateAdd ​

â–¸ integrateAdd(stack, lhs, rhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource
rhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:38

integrateAsin ​

â–¸ integrateAsin(stack, lhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:558

integrateAsinh ​

â–¸ integrateAsinh(stack, lhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:654

integrateAtan ​

â–¸ integrateAtan(stack, lhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:592

integrateAtanh ​

â–¸ integrateAtanh(stack, lhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:686

integrateCos ​

â–¸ integrateCos(stack, lhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:528

integrateCosh ​

â–¸ integrateCosh(stack, lhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:624

integrateDiv ​

â–¸ integrateDiv(stack, lhs, rhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource
rhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:141

integrateExp ​

â–¸ integrateExp(stack, lhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:382

integrateInnerAdd ​

â–¸ integrateInnerAdd(stack, lhs, rhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource
rhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:49

integrateInnerSub ​

â–¸ integrateInnerSub(stack, lhs, rhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource
rhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:84

integrateLn ​

â–¸ integrateLn(stack, lhs): default<[GenericFormula]>

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource

Returns ​

default<[GenericFormula]>

Defined in ​

profectus/src/game/formulas/operations.ts:290

integrateLog ​

â–¸ integrateLog(stack, lhs, rhs): default<[GenericFormula, FormulaSource]>

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource
rhsFormulaSource

Returns ​

default<[GenericFormula, FormulaSource]>

Defined in ​

profectus/src/game/formulas/operations.ts:231

integrateLog10 ​

â–¸ integrateLog10(stack, lhs): default<[GenericFormula]>

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource

Returns ​

default<[GenericFormula]>

Defined in ​

profectus/src/game/formulas/operations.ts:199

integrateLog2 ​

â–¸ integrateLog2(stack, lhs): default<[GenericFormula]>

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource

Returns ​

default<[GenericFormula]>

Defined in ​

profectus/src/game/formulas/operations.ts:261

integrateMul ​

â–¸ integrateMul(stack, lhs, rhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource
rhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:108

integrateNeg ​

â–¸ integrateNeg(stack, lhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:18

integratePow ​

â–¸ integratePow(stack, lhs, rhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource
rhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:310

integratePow10 ​

â–¸ integratePow10(stack, lhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:329

integratePowBase ​

â–¸ integratePowBase(stack, lhs, rhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource
rhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:346

integrateRecip ​

â–¸ integrateRecip(stack, lhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:172

integrateRoot ​

â–¸ integrateRoot(stack, lhs, rhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource
rhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:367

integrateSin ​

â–¸ integrateSin(stack, lhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:513

integrateSinh ​

â–¸ integrateSinh(stack, lhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:609

integrateSub ​

â–¸ integrateSub(stack, lhs, rhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource
rhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:73

integrateTan ​

â–¸ integrateTan(stack, lhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:543

integrateTanh ​

â–¸ integrateTanh(stack, lhs): GenericFormula

Parameters ​

NameType
stackSubstitutionStack
lhsFormulaSource

Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/operations.ts:639

invertAcos ​

â–¸ invertAcos(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:568

invertAcosh ​

â–¸ invertAcosh(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:662

invertAdd ​

â–¸ invertAdd(value, lhs, rhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource
rhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:29

invertAsin ​

â–¸ invertAsin(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:551

invertAsinh ​

â–¸ invertAsinh(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:647

invertAtan ​

â–¸ invertAtan(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:585

invertAtanh ​

â–¸ invertAtanh(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:679

invertCos ​

â–¸ invertCos(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:521

invertCosh ​

â–¸ invertCosh(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:617

invertDiv ​

â–¸ invertDiv(value, lhs, rhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource
rhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:132

invertExp ​

â–¸ invertExp(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:375

invertIteratedExp ​

â–¸ invertIteratedExp(value, lhs, height, payload): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource
heightFormulaSource
payloadFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:421

invertLambertw ​

â–¸ invertLambertw(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:487

invertLayeradd ​

â–¸ invertLayeradd(value, lhs, diff, base): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource
diffFormulaSource
baseFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:469

invertLn ​

â–¸ invertLn(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:272

invertLog ​

â–¸ invertLog(value, lhs, rhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource
rhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:210

invertLog10 ​

â–¸ invertLog10(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:180

invertLog2 ​

â–¸ invertLog2(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:242

invertMul ​

â–¸ invertMul(value, lhs, rhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource
rhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:99

invertNeg ​

â–¸ invertNeg(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:11

invertPow ​

â–¸ invertPow(value, lhs, rhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource
rhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:301

invertPow10 ​

â–¸ invertPow10(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:322

invertPowBase ​

â–¸ invertPowBase(value, lhs, rhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource
rhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:337

invertRecip ​

â–¸ invertRecip(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:165

invertRoot ​

â–¸ invertRoot(value, lhs, rhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource
rhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:358

invertSin ​

â–¸ invertSin(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:506

invertSinh ​

â–¸ invertSinh(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:602

invertSlog ​

â–¸ invertSlog(value, lhs, rhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource
rhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:454

invertSsqrt ​

â–¸ invertSsqrt(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:494

invertSub ​

â–¸ invertSub(value, lhs, rhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource
rhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:64

invertTan ​

â–¸ invertTan(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:536

invertTanh ​

â–¸ invertTanh(value, lhs): DecimalSource

Parameters ​

NameType
valueDecimalSource
lhsFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:632

invertTetrate ​

â–¸ invertTetrate(value, base, height, payload): DecimalSource

Parameters ​

NameType
valueDecimalSource
baseFormulaSource
heightFormulaSource
payloadFormulaSource

Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/operations.ts:399

iteratedLog ​

â–¸ iteratedLog(value, lhs?, times?): default

Parameters ​

NameTypeDefault value
valueDecimalSourceundefined
lhsDecimalSource10
timesDecimalSource2

Returns ​

default

Defined in ​

profectus/src/game/formulas/operations.ts:440

iteratedexp ​

â–¸ iteratedexp(value, height?, payload?): default

Parameters ​

NameTypeDefault value
valueDecimalSourceundefined
heightDecimalSource2
payloadDecimalSourceundefined

Returns ​

default

Defined in ​

profectus/src/game/formulas/operations.ts:412

layeradd ​

â–¸ layeradd(value, diff, base): default

Parameters ​

NameType
valueDecimalSource
diffDecimalSource
baseDecimalSource

Returns ​

default

Defined in ​

profectus/src/game/formulas/operations.ts:464

passthrough ​

â–¸ passthrough<T>(value): T

Type parameters ​

NameType
Textends DecimalSource | GenericFormula

Parameters ​

NameType
valueT

Returns ​

T

Defined in ​

profectus/src/game/formulas/operations.ts:7

pentate ​

â–¸ pentate(value, height, payload): default

Parameters ​

NameType
valueDecimalSource
heightDecimalSource
payloadDecimalSource

Returns ​

default

Defined in ​

profectus/src/game/formulas/operations.ts:501

slog ​

â–¸ slog(value, lhs?): default

Parameters ​

NameTypeDefault value
valueDecimalSourceundefined
lhsDecimalSource10

Returns ​

default

Defined in ​

profectus/src/game/formulas/operations.ts:449

tetrate ​

â–¸ tetrate(value, height?, payload?): default

Parameters ​

NameTypeDefault value
valueDecimalSourceundefined
heightDecimalSource2
payloadDecimalSourceundefined

Returns ​

default

Defined in ​

profectus/src/game/formulas/operations.ts:390

- diff --git a/api/modules/game/formulas/types.html b/api/modules/game/formulas/types.html index 3c1298ab..cfd1693c 100644 --- a/api/modules/game/formulas/types.html +++ b/api/modules/game/formulas/types.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: game/formulas/types ​

Type Aliases ​

ConstantFormulaOptions ​

Ƭ ConstantFormulaOptions: Object

Type declaration ​

NameType
inputs[FormulaSource]

Defined in ​

profectus/src/game/formulas/types.d.ts:35

EvaluateFunction ​

Ƭ EvaluateFunction<T>: (this: default<T>, ...inputs: GuardedFormulasToDecimals<T>) => DecimalSource

Type parameters ​

Name
T

Type declaration ​

â–¸ (this, ...inputs): DecimalSource

Parameters ​
NameType
thisdefault<T>
...inputsGuardedFormulasToDecimals<T>
Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/types.d.ts:18

FormulaOptions ​

Ƭ FormulaOptions<T>: VariableFormulaOptions | ConstantFormulaOptions | GeneralFormulaOptions<T>

Type parameters ​

NameType
Textends [FormulaSource] | FormulaSource[]

Defined in ​

profectus/src/game/formulas/types.d.ts:46

FormulaSource ​

Ƭ FormulaSource: ProcessedComputable<DecimalSource> | GenericFormula

Defined in ​

profectus/src/game/formulas/types.d.ts:7

FormulasToDecimals ​

Ƭ FormulasToDecimals<T>:

Type parameters ​

NameType
Textends FormulaSource[]

Defined in ​

profectus/src/game/formulas/types.d.ts:65

GeneralFormulaOptions ​

Ƭ GeneralFormulaOptions<T>: Object

Type parameters ​

NameType
Textends [FormulaSource] | FormulaSource[]

Type declaration ​

NameType
applySubstitution?SubstitutionFunction<T>
evaluateEvaluateFunction<T>
inputsT
integrate?IntegrateFunction<T>
integrateInner?IntegrateFunction<T>
invert?InvertFunction<T>

Defined in ​

profectus/src/game/formulas/types.d.ts:38

GenericFormula ​

Ƭ GenericFormula: default<any>

Defined in ​

profectus/src/game/formulas/types.d.ts:6

GuardedFormulasToDecimals ​

Ƭ GuardedFormulasToDecimals<T>: TupleGuard<T>

Type parameters ​

NameType
Textends FormulaSource[]

Defined in ​

profectus/src/game/formulas/types.d.ts:70

IntegrableFormula ​

Ƭ IntegrableFormula: GenericFormula & { evaluateIntegral: (variable?: DecimalSource) => DecimalSource }

Defined in ​

profectus/src/game/formulas/types.d.ts:11

IntegrateFunction ​

Ƭ IntegrateFunction<T>: (this: default<T>, stack: SubstitutionStack | undefined, ...inputs: T) => GenericFormula

Type parameters ​

Name
T

Type declaration ​

â–¸ (this, stack, ...inputs): GenericFormula

Parameters ​
NameType
thisdefault<T>
stackSubstitutionStack | undefined
...inputsT
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/types.d.ts:23

InternalFormulaProperties ​

Ƭ InternalFormulaProperties<T>: Object

Type parameters ​

NameType
Textends [FormulaSource] | FormulaSource[]

Type declaration ​

NameType
applySubstitution?SubstitutionFunction<T>
innermostVariable?ProcessedComputable<DecimalSource>
inputsT
internalEvaluate?EvaluateFunction<T>
internalIntegrate?IntegrateFunction<T>
internalIntegrateInner?IntegrateFunction<T>
internalInvert?InvertFunction<T>
internalVariablesnumber

Defined in ​

profectus/src/game/formulas/types.d.ts:51

InvertFunction ​

Ƭ InvertFunction<T>: (this: default<T>, value: DecimalSource, ...inputs: T) => DecimalSource

Type parameters ​

Name
T

Type declaration ​

â–¸ (this, value, ...inputs): DecimalSource

Parameters ​
NameType
thisdefault<T>
valueDecimalSource
...inputsT
Returns ​

DecimalSource

Defined in ​

profectus/src/game/formulas/types.d.ts:22

InvertibleFormula ​

Ƭ InvertibleFormula: GenericFormula & { invert: (value: DecimalSource) => DecimalSource }

Defined in ​

profectus/src/game/formulas/types.d.ts:8

InvertibleIntegralFormula ​

Ƭ InvertibleIntegralFormula: GenericFormula & { invertIntegral: (value: DecimalSource) => DecimalSource }

Defined in ​

profectus/src/game/formulas/types.d.ts:14

SubstitutionFunction ​

Ƭ SubstitutionFunction<T>: (this: default<T>, variable: GenericFormula, ...inputs: T) => GenericFormula

Type parameters ​

Name
T

Type declaration ​

â–¸ (this, variable, ...inputs): GenericFormula

Parameters ​
NameType
thisdefault<T>
variableGenericFormula
...inputsT
Returns ​

GenericFormula

Defined in ​

profectus/src/game/formulas/types.d.ts:28

SubstitutionStack ​

Ƭ SubstitutionStack: (value: GenericFormula) => GenericFormula[] | undefined

Defined in ​

profectus/src/game/formulas/types.d.ts:62

TupleGuard ​

Ƭ TupleGuard<T>: T extends any[] ? FormulasToDecimals<T> : never

Type parameters ​

NameType
Textends any[]

Defined in ​

profectus/src/game/formulas/types.d.ts:69

VariableFormulaOptions ​

Ƭ VariableFormulaOptions: Object

Type declaration ​

NameType
variableProcessedComputable<DecimalSource>

Defined in ​

profectus/src/game/formulas/types.d.ts:34

- diff --git a/api/modules/game/gameLoop.html b/api/modules/game/gameLoop.html index a41acfca..c71abb0d 100644 --- a/api/modules/game/gameLoop.html +++ b/api/modules/game/gameLoop.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: game/gameLoop ​

Functions ​

startGameLoop ​

â–¸ startGameLoop(): Promise<void>

Starts the game loop for the project, which updates the game in ticks.

Returns ​

Promise<void>

Defined in ​

profectus/src/game/gameLoop.ts:97

- diff --git a/api/modules/game/layers.html b/api/modules/game/layers.html index 10e866e0..34243239 100644 --- a/api/modules/game/layers.html +++ b/api/modules/game/layers.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: game/layers ​

Interfaces ​

Type Aliases ​

GenericLayer ​

Ƭ GenericLayer: Replace<Layer<LayerOptions>, { minWidth: ProcessedComputable<number> ; minimizable: ProcessedComputable<boolean> ; name: ProcessedComputable<string> }>

A type that matches any valid Layer object.

Defined in ​

profectus/src/game/layers.tsx:184

Layer ​

Ƭ Layer<T>: Replace<T & BaseLayer, { classes: GetComputableType<T["classes"]> ; color: GetComputableType<T["color"]> ; display: GetComputableType<T["display"]> ; forceHideGoBack: GetComputableType<T["forceHideGoBack"]> ; minWidth: GetComputableTypeWithDefault<T["minWidth"], 600> ; minimizable: GetComputableTypeWithDefault<T["minimizable"], true> ; minimizedDisplay: GetComputableType<T["minimizedDisplay"]> ; name: GetComputableTypeWithDefault<T["name"], string> ; style: GetComputableType<T["style"]> }>

An unit of game content. Displayed to the user as a tab or modal.

Type parameters ​

NameType
Textends LayerOptions

Defined in ​

profectus/src/game/layers.tsx:168

Variables ​

BoundsInjectionKey ​

• Const BoundsInjectionKey: InjectionKey<Ref<DOMRect | undefined>>

An injection key that a ContextComponent will use to provide a ref to a bounding rect of the Context.

Defined in ​

profectus/src/game/layers.tsx:52

NodesInjectionKey ​

• Const NodesInjectionKey: InjectionKey<Ref<Record<string, FeatureNode | undefined>>>

An injection key that a ContextComponent will use to provide a ref to a map of all currently registered FeatureNodes.

Defined in ​

profectus/src/game/layers.tsx:47

RegisterNodeInjectionKey ​

• Const RegisterNodeInjectionKey: InjectionKey<(id: string, element: HTMLElement) => void>

An injection key that a ContextComponent will use to provide a function that registers a FeatureNode with the given id and HTML element.

Defined in ​

profectus/src/game/layers.tsx:37

UnregisterNodeInjectionKey ​

• Const UnregisterNodeInjectionKey: InjectionKey<(id: string) => void>

An injection key that a ContextComponent will use to provide a function that unregisters a FeatureNode with the given id.

Defined in ​

profectus/src/game/layers.tsx:42

addingLayers ​

• Const addingLayers: string[] = []

When creating layers, this array stores the layers currently being created, as a stack.

Defined in ​

profectus/src/game/layers.tsx:200

layers ​

• Const layers: Record<string, Readonly<GenericLayer> | undefined>

A reference to all the current layers. It is shallow reactive so it will update when layers are added or removed, but not interfere with the existing refs within each layer.

Defined in ​

profectus/src/game/layers.tsx:77

persistentRefs ​

• Const persistentRefs: Record<string, Set<Persistent>> = {}

When creating layers, this object a map of layer ID to a set of any created persistent refs in order to check they're all included in the final layer object.

Defined in ​

profectus/src/game/layers.tsx:196

Functions ​

addLayer ​

â–¸ addLayer(layer, player): void

Enables a layer object, so it will be updated every tick. Note that accessing a layer/its properties does NOT require it to be enabled. For dynamic layers you can call this function and removeLayer as necessary. Just make sure getInitialLayers will provide an accurate list of layers based on the player data object. For static layers just make getInitialLayers return all the layers.

Parameters ​

NameTypeDescription
layerGenericLayerThe layer to add.
playerObjectThe player data object, which will have a data object for this layer.
player.layers?Record<string, Record<string, unknown>>-

Returns ​

void

Defined in ​

profectus/src/game/layers.tsx:284

createLayer ​

â–¸ createLayer<T>(id, optionsFunc): Layer<T>

Lazily creates a layer with the given options.

Type parameters ​

NameType
Textends LayerOptions

Parameters ​

NameTypeDescription
idstringThe ID this layer will have. See id.
optionsFuncOptionsFunc<T, BaseLayer, BaseLayer>Layer options.

Returns ​

Layer<T>

Defined in ​

profectus/src/game/layers.tsx:206

getLayer ​

â–¸ getLayer<T>(layerID): T

Convenience method for getting a layer by its ID with correct typing.

Type parameters ​

NameType
Textends GenericLayer

Parameters ​

NameTypeDescription
layerIDstringThe ID of the layer to get.

Returns ​

T

Defined in ​

profectus/src/game/layers.tsx:311

reloadLayer ​

â–¸ reloadLayer(layer): void

Convenience method for removing and immediately re-adding a layer. This is useful for layers with dynamic content, to ensure persistent refs are correctly configured.

Parameters ​

NameTypeDescription
layerGenericLayerLayer to remove and then re-add

Returns ​

void

Defined in ​

profectus/src/game/layers.tsx:332

removeLayer ​

â–¸ removeLayer(layer): void

Disables a layer, so it will no longer be updated every tick. Note that accessing a layer/its properties does NOT require it to be enabled.

Parameters ​

NameTypeDescription
layerGenericLayerThe layer to remove.

Returns ​

void

Defined in ​

profectus/src/game/layers.tsx:320

setupLayerModal ​

â–¸ setupLayerModal(layer): Object

Utility function for creating a modal that display's a display. Returns the modal itself, which can be rendered anywhere you need, as well as a function to open the modal.

Parameters ​

NameTypeDescription
layerGenericLayerThe layer to display in the modal.

Returns ​

Object

NameType
modalJSXFunction
openModalVoidFunction

Defined in ​

profectus/src/game/layers.tsx:344

- diff --git a/api/modules/game/modifiers.html b/api/modules/game/modifiers.html index 9fcbd9de..f937dd3c 100644 --- a/api/modules/game/modifiers.html +++ b/api/modules/game/modifiers.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: game/modifiers ​

Interfaces ​

Type Aliases ​

ModifierFromOptionalParams ​

Ƭ ModifierFromOptionalParams<T, S>: T extends undefined ? S extends undefined ? Omit<WithRequired<Modifier, "revert">, "description" | "enabled"> : Omit<WithRequired<Modifier, "revert" | "enabled">, "description"> : S extends undefined ? Omit<WithRequired<Modifier, "revert" | "description">, "enabled"> : WithRequired<Modifier, "revert" | "enabled" | "description">

Utility type used to narrow down a modifier type that will have a description and/or enabled property based on optional parameters, T and S (respectively).

Type parameters ​

Name
T
S

Defined in ​

profectus/src/game/modifiers.tsx:40

Functions ​

createAdditiveModifier ​

â–¸ createAdditiveModifier<T>(optionsFunc): ModifierFromOptionalParams<T["description"], T["enabled"]>

Create a modifier that adds some value to the input value.

Type parameters ​

NameType
Textends AdditiveModifierOptions

Parameters ​

NameTypeDescription
optionsFunc() => TAdditive modifier options.

Returns ​

ModifierFromOptionalParams<T["description"], T["enabled"]>

Defined in ​

profectus/src/game/modifiers.tsx:64

createExponentialModifier ​

â–¸ createExponentialModifier<T>(optionsFunc): ModifierFromOptionalParams<T["description"], T["enabled"]>

Create a modifier that raises the input value to the power of some value.

Type parameters ​

NameType
Textends ExponentialModifierOptions

Parameters ​

NameTypeDescription
optionsFunc() => TExponential modifier options.

Returns ​

ModifierFromOptionalParams<T["description"], T["enabled"]>

Defined in ​

profectus/src/game/modifiers.tsx:187

createModifierSection ​

â–¸ createModifierSection(options): Element

Create a JSX element that displays a modifier. Intended to be used with the output from createSequentialModifier.

Parameters ​

NameTypeDescription
optionsModifierSectionOptionsModifier section options.

Returns ​

Element

Defined in ​

profectus/src/game/modifiers.tsx:319

createMultiplicativeModifier ​

â–¸ createMultiplicativeModifier<T>(optionsFunc): ModifierFromOptionalParams<T["description"], T["enabled"]>

Create a modifier that multiplies the input value by some value.

Type parameters ​

NameType
Textends MultiplicativeModifierOptions

Parameters ​

NameTypeDescription
optionsFunc() => TMultiplicative modifier options.

Returns ​

ModifierFromOptionalParams<T["description"], T["enabled"]>

Defined in ​

profectus/src/game/modifiers.tsx:125

createSequentialModifier ​

â–¸ createSequentialModifier<T, S>(modifiersFunc): S

Takes an array of modifiers and applies and reverses them in order. Modifiers that are not enabled will not be applied nor reversed. Also joins their descriptions together.

See

createModifierSection.

Type parameters ​

NameType
Textends Modifier[]
ST extends WithRequired<Modifier, "revert">[] ? WithRequired<Modifier, "revert" | "description"> : Omit<WithRequired<Modifier, "description">, "revert">

Parameters ​

NameTypeDescription
modifiersFunc() => TThe modifiers to perform sequentially.

Returns ​

S

Defined in ​

profectus/src/game/modifiers.tsx:260

- diff --git a/api/modules/game/notifications.html b/api/modules/game/notifications.html index 54173ed3..fb32f6cc 100644 --- a/api/modules/game/notifications.html +++ b/api/modules/game/notifications.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: game/notifications ​

Functions ​

createDismissableNotify ​

â–¸ createDismissableNotify(element, shouldNotify): Ref<boolean>

Create a boolean ref that will automatically be set based on the given condition, but also dismissed when hovering over a given element, typically the element where acting upon the notification would take place.

Parameters ​

NameTypeDescription
elementVueFeatureThe element that will dismiss the notification on hover.
shouldNotifyRef<boolean> | () => booleanA function or ref that determines if the notif should be active currently or not.

Returns ​

Ref<boolean>

Defined in ​

profectus/src/game/notifications.ts:36

getHighNotifyStyle ​

â–¸ getHighNotifyStyle(): Object

Utility function to call getNotifyStyle with "high importance" parameters.

Returns ​

Object

NameType
borderColorstring
boxShadowstring
transformstring
zIndexnumber

Defined in ​

profectus/src/game/notifications.ts:27

getNotifyStyle ​

â–¸ getNotifyStyle(color?, strength?): Object

Gives a CSSProperties object that makes an object glow, to bring focus to it. Default values are for a "soft" white notif effect.

Parameters ​

NameTypeDefault valueDescription
colorstring"white"The color of the glow effect.
strengthstring"8px"The strength of the glow effect - affects its spread.

Returns ​

Object

NameType
borderColorstring
boxShadowstring
transformstring
zIndexnumber

Defined in ​

profectus/src/game/notifications.ts:17

- diff --git a/api/modules/game/persistence.html b/api/modules/game/persistence.html index 83d60653..66651eb5 100644 --- a/api/modules/game/persistence.html +++ b/api/modules/game/persistence.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: game/persistence ​

Type Aliases ​

NonPersistent ​

Ƭ NonPersistent<T>: WritableComputedRef<T> & { [DefaultValue]: T }

Type parameters ​

NameType
Textends State = State

Defined in ​

profectus/src/game/persistence.ts:37

profectus/src/game/persistence.ts:92

Persistent ​

Ƭ Persistent<T>: Ref<T> & { [CheckNaN]: boolean ; [DefaultValue]: T ; [Deleted]: boolean ; [NonPersistent]: NonPersistent<T> ; [PersistentState]: Ref<T> ; [SaveDataPath]: string[] | undefined ; [StackTrace]: string ; value: T }

A Ref that has been augmented with properties to allow it to be saved and loaded within the player save data object.

Type parameters ​

NameType
Textends State = State

Defined in ​

profectus/src/game/persistence.ts:65

State ​

Ƭ State: string | number | boolean | DecimalSource | { [key: string]: State; } | { [key: number]: State; }

This is a union of things that should be safely stringifiable without needing special processes or knowing what to load them in as.

  • Decimals aren't allowed because we'd need to know to parse them back.
  • DecimalSources are allowed because the string is a valid value for them

Defined in ​

profectus/src/game/persistence.ts:54

Variables ​

CheckNaN ​

• Const CheckNaN: typeof CheckNaN

A symbol used in Persistent objects.

See

[CheckNaN]

Defined in ​

profectus/src/game/persistence.ts:47

DefaultValue ​

• Const DefaultValue: typeof DefaultValue

A symbol used in Persistent objects.

See

[DefaultValue]

Defined in ​

profectus/src/game/persistence.ts:22

Deleted ​

• Const Deleted: typeof Deleted

A symbol used in Persistent objects.

See

[Deleted]

Defined in ​

profectus/src/game/persistence.ts:32

NonPersistent ​

• Const NonPersistent: typeof NonPersistent

A symbol used in Persistent objects.

See

[NonPersistent]

Defined in ​

profectus/src/game/persistence.ts:37

profectus/src/game/persistence.ts:92

PersistentState ​

• Const PersistentState: typeof PersistentState

A symbol used in Persistent objects.

See

[PersistentState]

Defined in ​

profectus/src/game/persistence.ts:17

SaveDataPath ​

• Const SaveDataPath: typeof SaveDataPath

A symbol used in Persistent objects.

See

[SaveDataPath]

Defined in ​

profectus/src/game/persistence.ts:42

StackTrace ​

• Const StackTrace: typeof StackTrace

A symbol used in Persistent objects.

See

[StackTrace]

Defined in ​

profectus/src/game/persistence.ts:27

Functions ​

deletePersistent ​

â–¸ deletePersistent(persistent): void

Mark a Persistent as deleted, so it won't be saved and loaded. Since persistent refs must be created during a layer's options func, features can not create persistent refs after evaluating their own options funcs. As a result, it must create any persistent refs it might need. This function can then be called after the options func is evaluated to mark the persistent ref to not be saved or loaded.

Parameters ​

NameType
persistentPersistent<State>

Returns ​

void

Defined in ​

profectus/src/game/persistence.ts:213

isPersistent ​

â–¸ isPersistent(value): value is Persistent<State>

Type guard for whether an arbitrary value is a persistent ref

Parameters ​

NameTypeDescription
valueunknownThe value that may or may not be a persistent ref

Returns ​

value is Persistent<State>

Defined in ​

profectus/src/game/persistence.ts:193

noPersist ​

â–¸ noPersist<T, S>(persistent): T[typeof NonPersistent]

Unwraps the non-persistent ref inside of persistent refs, to be passed to other features without duplicating values in the save data object.

Type parameters ​

NameType
Textends Ref<S, T> & { [CheckNaN]: boolean ; [DefaultValue]: S ; [Deleted]: boolean ; [NonPersistent]: NonPersistent<S> ; [PersistentState]: Ref<S> ; [SaveDataPath]: undefined | string[] ; [StackTrace]: string ; value: S }
Sextends State

Parameters ​

NameTypeDescription
persistentTThe persistent ref to unwrap

Returns ​

T[typeof NonPersistent]

Defined in ​

profectus/src/game/persistence.ts:201

persistent ​

â–¸ persistent<T>(defaultValue, checkNaN?): Persistent<T>

Create a persistent ref, which can be saved and loaded. All (non-deleted) persistent refs must be included somewhere within the layer object returned by that layer's options func.

Type parameters ​

NameType
Textends State

Parameters ​

NameTypeDefault valueDescription
defaultValueT | Ref<T>undefinedThe value the persistent ref should start at on fresh saves or when reset.
checkNaNbooleantrueWhether or not to check this ref for being NaN on set. Only use on refs that should always be DecimalSources.

Returns ​

Persistent<T>

Defined in ​

profectus/src/game/persistence.ts:129

- diff --git a/api/modules/game/player.html b/api/modules/game/player.html index de7f799b..f85d9d65 100644 --- a/api/modules/game/player.html +++ b/api/modules/game/player.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: game/player ​

Interfaces ​

Type Aliases ​

LayerData ​

Ƭ LayerData<T>: { [P in keyof T]?: T[P] extends (infer U)[] ? Record<string, LayerData<U>> : T[P] extends Record<string, never> ? never : T[P] extends Ref<infer S> ? S : T[P] extends object ? LayerData<T[P]> : T[P] }

A layer's save data. Automatically unwraps refs.

Type parameters ​

Name
T

Defined in ​

profectus/src/game/player.ts:35

Variables ​

default ​

• default: Object

Type declaration ​

NameTypeDescription
autosavebooleanWhether or not to automatically save every couple of seconds and on tab close.
devSpeednull | numberA multiplier for time passing. Set to 0 when the game is paused.
idstringThe ID of this save.
keepGoingbooleanWhether or not to continue playing after hasWon is true.
layersRecord<string, LayerData<unknown>>A dictionary of layer save data.
modIDstringThe ID of this project, to make sure saves aren't imported into the wrong project.
modVersionstringThe version of the project this save was created by. Used for upgrading saves for new versions.
namestringThe display name of this save.
offlineProdbooleanWhether or not to apply offline time when loading this save.
offlineTimenull | numberHow much offline time has been accumulated and not yet processed.
tabsstring[]The open tabs.
timenumberThe current time this save was last opened at, in ms since the unix epoch.
timePlayednumberHow long, in ms, this game has been played.

Defined in ​

profectus/src/game/player.ts:63

Functions ​

stringifySave ​

â–¸ stringifySave(player): string

Convert a player save data object into a JSON string. Unwraps refs.

Parameters ​

NameType
playerPlayer

Returns ​

string

Defined in ​

profectus/src/game/player.ts:66

- diff --git a/api/modules/game/requirements.html b/api/modules/game/requirements.html index 6334a6ce..6bc06628 100644 --- a/api/modules/game/requirements.html +++ b/api/modules/game/requirements.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: game/requirements ​

Interfaces ​

Type Aliases ​

CostRequirement ​

Ƭ CostRequirement: Replace<Requirement & CostRequirementOptions, { cost: ProcessedComputable<DecimalSource> | GenericFormula ; requiresPay: ProcessedComputable<boolean> ; spendResources: ProcessedComputable<boolean> ; visibility: ProcessedComputable<Visible | None | boolean> }>

Defined in ​

profectus/src/game/requirements.tsx:96

Requirements ​

Ƭ Requirements: Requirement | Requirement[]

Utility type for accepting 1 or more Requirements.

Defined in ​

profectus/src/game/requirements.tsx:64

Functions ​

createBooleanRequirement ​

â–¸ createBooleanRequirement(requirement, display?): Requirement

Creates a requirement based on a true/false value

Parameters ​

NameTypeDescription
requirementComputable<boolean>The boolean requirement to use
display?CoercableComponentHow to display this requirement to the user

Returns ​

Requirement

Defined in ​

profectus/src/game/requirements.tsx:205

createCostRequirement ​

â–¸ createCostRequirement<T>(optionsFunc): CostRequirement

Lazily creates a requirement with the given options, that is based on meeting an amount of a resource.

Type parameters ​

NameType
Textends CostRequirementOptions

Parameters ​

NameTypeDescription
optionsFunc() => TCost requirement options.

Returns ​

CostRequirement

Defined in ​

profectus/src/game/requirements.tsx:110

createVisibilityRequirement ​

â–¸ createVisibilityRequirement(feature): Requirement

Utility function for creating a requirement that a specified vue feature is visible

Parameters ​

NameTypeDescription
featureObjectThe feature to check the visibility of
feature.visibilityProcessedComputable<boolean | Visibility>-

Returns ​

Requirement

Defined in ​

profectus/src/game/requirements.tsx:190

displayRequirements ​

â–¸ displayRequirements(requirements, amount?): Element

Utility function for display 1+ requirements compactly.

Parameters ​

NameTypeDefault valueDescription
requirementsRequirementsundefinedThe 1+ requirements to display
amountDecimalSource1The amount of levels earned to be displayed

Returns ​

Element

Defined in ​

profectus/src/game/requirements.tsx:252

maxRequirementsMet ​

â–¸ maxRequirementsMet(requirements): DecimalSource

Calculates the maximum number of levels that could be acquired with the current requirement states. True/false requirements will be counted as Infinity or 0.

Parameters ​

NameTypeDescription
requirementsRequirementsThe 1+ requirements to check

Returns ​

DecimalSource

Defined in ​

profectus/src/game/requirements.tsx:234

payByDivision ​

â–¸ payByDivision(this, amount?): void

Parameters ​

NameType
thisCostRequirement
amount?DecimalSource

Returns ​

void

Defined in ​

profectus/src/game/requirements.tsx:302

payByReset ​

â–¸ payByReset(overrideDefaultValue?): (this: CostRequirement) => void

Parameters ​

NameType
overrideDefaultValue?DecimalSource

Returns ​

fn

â–¸ (this): void

Parameters ​
NameType
thisCostRequirement
Returns ​

void

Defined in ​

profectus/src/game/requirements.tsx:314

payRequirements ​

â–¸ payRequirements(requirements, amount?): void

Utility function for paying the costs for 1+ requirements

Parameters ​

NameTypeDefault valueDescription
requirementsRequirementsundefinedThe 1+ requirements to pay
amountDecimalSource1How many levels to pay for

Returns ​

void

Defined in ​

profectus/src/game/requirements.tsx:294

requirementsMet ​

â–¸ requirementsMet(requirements): boolean

Utility for checking if 1+ requirements are all met

Parameters ​

NameTypeDescription
requirementsRequirementsThe 1+ requirements to check

Returns ​

boolean

Defined in ​

profectus/src/game/requirements.tsx:222

- diff --git a/api/modules/game/settings.html b/api/modules/game/settings.html index 1b8ca282..5531b95b 100644 --- a/api/modules/game/settings.html +++ b/api/modules/game/settings.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: game/settings ​

Interfaces ​

Variables ​

default ​

• default: Settings

The player settings object. Stores data that persists across all saves. Automatically saved to localStorage whenever changed.

Defined in ​

profectus/src/game/settings.ts:56

gameComponents ​

• Const gameComponents: CoercableComponent[]

A list of components to add to the root of the page.

Defined in ​

profectus/src/game/settings.ts:119

infoComponents ​

• Const infoComponents: CoercableComponent[]

A list of components to show in the info modal.

Defined in ​

profectus/src/game/settings.ts:112

settingFields ​

• Const settingFields: CoercableComponent[]

A list of fields to append to the settings modal.

Defined in ​

profectus/src/game/settings.ts:105

Functions ​

hardResetSettings ​

â–¸ hardResetSettings(): void

A function that erases all player settings, including all saves.

Returns ​

void

Defined in ​

profectus/src/game/settings.ts:58

loadSettings ​

â–¸ loadSettings(): void

Loads the player settings from localStorage. Calls the GlobalEvents.loadSettings event for custom properties to be included. Custom properties should be added by the file they relate to, so they won't be included if the file is tree shaken away. Custom properties should also register the field to modify said setting using registerSettingField.

Returns ​

void

Defined in ​

profectus/src/game/settings.ts:77

registerGameComponent ​

â–¸ registerGameComponent(component): void

Register a component to be displayed at the root of the page.

Parameters ​

NameType
componentCoercableComponent

Returns ​

void

Defined in ​

profectus/src/game/settings.ts:121

registerInfoComponent ​

â–¸ registerInfoComponent(component): void

Register a component to be displayed in the info modal.

Parameters ​

NameType
componentCoercableComponent

Returns ​

void

Defined in ​

profectus/src/game/settings.ts:114

registerSettingField ​

â–¸ registerSettingField(component): void

Register a field to be displayed in the settings modal.

Parameters ​

NameType
componentCoercableComponent

Returns ​

void

Defined in ​

profectus/src/game/settings.ts:107

- diff --git a/api/modules/game/state.html b/api/modules/game/state.html index 322496f5..b5628021 100644 --- a/api/modules/game/state.html +++ b/api/modules/game/state.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: game/state ​

Interfaces ​

Variables ​

default ​

• default: ShallowReactive<Transient>

The global transient state object.

Defined in ​

profectus/src/game/state.ts:24

- diff --git a/api/modules/lib/break_eternity.html b/api/modules/lib/break_eternity.html index 3920021f..bb5be831 100644 --- a/api/modules/lib/break_eternity.html +++ b/api/modules/lib/break_eternity.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: lib/break_eternity ​

Classes ​

Type Aliases ​

CompareResult ​

Ƭ CompareResult: -1 | 0 | 1

Defined in ​

profectus/src/lib/break_eternity.ts:5

DecimalSource ​

Ƭ DecimalSource: default | number | string

Defined in ​

profectus/src/lib/break_eternity.ts:341

- diff --git a/api/modules/lib/collapseTransition.html b/api/modules/lib/collapseTransition.html index 66e1edcd..aa2805db 100644 --- a/api/modules/lib/collapseTransition.html +++ b/api/modules/lib/collapseTransition.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: lib/collapseTransition ​

- diff --git a/api/modules/lib/lru-cache.html b/api/modules/lib/lru-cache.html index e7f972c0..4385dab9 100644 --- a/api/modules/lib/lru-cache.html +++ b/api/modules/lib/lru-cache.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: lib/lru-cache ​

Classes ​

- diff --git a/api/modules/lib/pixi.html b/api/modules/lib/pixi.html index 8c21218e..9ca23d4d 100644 --- a/api/modules/lib/pixi.html +++ b/api/modules/lib/pixi.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: lib/pixi ​

- diff --git a/api/modules/lib/pwa-register.html b/api/modules/lib/pwa-register.html index f809048b..3f162435 100644 --- a/api/modules/lib/pwa-register.html +++ b/api/modules/lib/pwa-register.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: lib/pwa-register ​

Interfaces ​

Functions ​

useRegisterSW ​

â–¸ useRegisterSW(options?): Object

Parameters ​

NameType
options?RegisterSWOptions

Returns ​

Object

NameType
needRefreshRef<boolean>
offlineReadyRef<boolean>
updateServiceWorker(reloadPage?: boolean) => Promise<void>

Defined in ​

profectus/src/lib/pwa-register.d.ts:12

- diff --git a/api/modules/lib/vue-panzoom.html b/api/modules/lib/vue-panzoom.html index 665a8b75..1f1f1c4d 100644 --- a/api/modules/lib/vue-panzoom.html +++ b/api/modules/lib/vue-panzoom.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: lib/vue-panzoom ​

- diff --git a/api/modules/lib/vue-textarea-autosize.html b/api/modules/lib/vue-textarea-autosize.html index 31aad799..1129bad4 100644 --- a/api/modules/lib/vue-textarea-autosize.html +++ b/api/modules/lib/vue-textarea-autosize.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: lib/vue-textarea-autosize ​

- diff --git a/api/modules/util/bignum.html b/api/modules/util/bignum.html index 81f5f98c..b1c5c01f 100644 --- a/api/modules/util/bignum.html +++ b/api/modules/util/bignum.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: util/bignum ​

References ​

default ​

Re-exports default

Type Aliases ​

DecimalSource ​

Ƭ DecimalSource: DecimalSource

Defined in ​

profectus/src/util/bignum.ts:18

Functions ​

commaFormat ​

â–¸ commaFormat(num, precision): string

Parameters ​

NameType
numDecimalSource
precisionnumber

Returns ​

string

Defined in ​

profectus/src/util/break_eternity.ts:28

exponentialFormat ​

â–¸ exponentialFormat(num, precision, mantissa?): string

Parameters ​

NameTypeDefault value
numDecimalSourceundefined
precisionnumberundefined
mantissabooleantrue

Returns ​

string

Defined in ​

profectus/src/util/break_eternity.ts:9

format ​

â–¸ format(num, precision?, small?): string

Parameters ​

NameType
numDecimalSource
precision?number
small?boolean

Returns ​

string

Defined in ​

profectus/src/util/break_eternity.ts:69

formatSmall ​

â–¸ formatSmall(x, precision?): string

Parameters ​

NameType
xDecimalSource
precision?number

Returns ​

string

Defined in ​

profectus/src/util/break_eternity.ts:185

formatTime ​

â–¸ formatTime(seconds): string

Parameters ​

NameType
secondsDecimalSource

Returns ​

string

Defined in ​

profectus/src/util/break_eternity.ts:130

formatWhole ​

â–¸ formatWhole(num): string

Parameters ​

NameType
numDecimalSource

Returns ​

string

Defined in ​

profectus/src/util/break_eternity.ts:116

invertOOM ​

â–¸ invertOOM(x): default

Parameters ​

NameType
xDecimalSource

Returns ​

default

Defined in ​

profectus/src/util/break_eternity.ts:189

regularFormat ​

â–¸ regularFormat(num, precision): string

Parameters ​

NameType
numDecimalSource
precisionnumber

Returns ​

string

Defined in ​

profectus/src/util/break_eternity.ts:43

toPlaces ​

â–¸ toPlaces(x, precision, maxAccepted): string

Parameters ​

NameType
xDecimalSource
precisionnumber
maxAcceptedDecimalSource

Returns ​

string

Defined in ​

profectus/src/util/break_eternity.ts:173

- diff --git a/api/modules/util/break_eternity.html b/api/modules/util/break_eternity.html index b6097f3a..a71b516b 100644 --- a/api/modules/util/break_eternity.html +++ b/api/modules/util/break_eternity.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: util/break_eternity ​

References ​

default ​

Re-exports default

Functions ​

commaFormat ​

â–¸ commaFormat(num, precision): string

Parameters ​

NameType
numDecimalSource
precisionnumber

Returns ​

string

Defined in ​

profectus/src/util/break_eternity.ts:28

exponentialFormat ​

â–¸ exponentialFormat(num, precision, mantissa?): string

Parameters ​

NameTypeDefault value
numDecimalSourceundefined
precisionnumberundefined
mantissabooleantrue

Returns ​

string

Defined in ​

profectus/src/util/break_eternity.ts:9

format ​

â–¸ format(num, precision?, small?): string

Parameters ​

NameType
numDecimalSource
precision?number
small?boolean

Returns ​

string

Defined in ​

profectus/src/util/break_eternity.ts:69

formatSmall ​

â–¸ formatSmall(x, precision?): string

Parameters ​

NameType
xDecimalSource
precision?number

Returns ​

string

Defined in ​

profectus/src/util/break_eternity.ts:185

formatTime ​

â–¸ formatTime(seconds): string

Parameters ​

NameType
secondsDecimalSource

Returns ​

string

Defined in ​

profectus/src/util/break_eternity.ts:130

formatWhole ​

â–¸ formatWhole(num): string

Parameters ​

NameType
numDecimalSource

Returns ​

string

Defined in ​

profectus/src/util/break_eternity.ts:116

invertOOM ​

â–¸ invertOOM(x): default

Parameters ​

NameType
xDecimalSource

Returns ​

default

Defined in ​

profectus/src/util/break_eternity.ts:189

regularFormat ​

â–¸ regularFormat(num, precision): string

Parameters ​

NameType
numDecimalSource
precisionnumber

Returns ​

string

Defined in ​

profectus/src/util/break_eternity.ts:43

toPlaces ​

â–¸ toPlaces(x, precision, maxAccepted): string

Parameters ​

NameType
xDecimalSource
precisionnumber
maxAcceptedDecimalSource

Returns ​

string

Defined in ​

profectus/src/util/break_eternity.ts:173

- diff --git a/api/modules/util/common.html b/api/modules/util/common.html index dc7a1f0e..ca6ec9cc 100644 --- a/api/modules/util/common.html +++ b/api/modules/util/common.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: util/common ​

Enumerations ​

Type Aliases ​

ArrayElements ​

Ƭ ArrayElements<T>: T extends ReadonlyArray<infer S> ? S : never

Type parameters ​

NameType
Textends ReadonlyArray<unknown>

Defined in ​

profectus/src/util/common.ts:3

WithRequired ​

Ƭ WithRequired<T, K>: T &

Type parameters ​

NameType
TT
Kextends keyof T

Defined in ​

profectus/src/util/common.ts:1

Functions ​

camelToTitle ​

â–¸ camelToTitle(camel): string

Parameters ​

NameType
camelstring

Returns ​

string

Defined in ​

profectus/src/util/common.ts:9

isFunction ​

â–¸ isFunction<T, S, R>(functionOrValue): functionOrValue is Function

Type parameters ​

NameType
TT
Sextends readonly unknown[]
RR

Parameters ​

NameType
functionOrValueR | (...args: S) => T

Returns ​

functionOrValue is Function

Defined in ​

profectus/src/util/common.ts:15

- diff --git a/api/modules/util/computed.html b/api/modules/util/computed.html index 4aa3c60a..d8a749a2 100644 --- a/api/modules/util/computed.html +++ b/api/modules/util/computed.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: util/computed ​

Type Aliases ​

Computable ​

Ƭ Computable<T>: T | Ref<T> | () => T

Type parameters ​

Name
T

Defined in ​

profectus/src/util/computed.ts:8

ComputableKeysOf ​

Ƭ ComputableKeysOf<T>: Pick<T, { [K in keyof T]: T[K] extends Computable<unknown> ? K : never }[keyof T]>

Type parameters ​

Name
T

Defined in ​

profectus/src/util/computed.ts:22

GetComputableType ​

Ƭ GetComputableType<T>: T extends { [DoNotCache]: true } ? T : T extends () => infer S ? Ref<S> : undefined extends T ? undefined : T

Type parameters ​

Name
T

Defined in ​

profectus/src/util/computed.ts:10

GetComputableTypeWithDefault ​

Ƭ GetComputableTypeWithDefault<T, S>: undefined extends T ? S : GetComputableType<NonNullable<T>>

Type parameters ​

Name
T
S

Defined in ​

profectus/src/util/computed.ts:17

ProcessedComputable ​

Ƭ ProcessedComputable<T>: T | Ref<T>

Type parameters ​

Name
T

Defined in ​

profectus/src/util/computed.ts:9

UnwrapComputableType ​

Ƭ UnwrapComputableType<T>: T extends Ref<infer S> ? S : T extends () => infer S ? S : T

Type parameters ​

Name
T

Defined in ​

profectus/src/util/computed.ts:20

Variables ​

DoNotCache ​

• Const DoNotCache: typeof DoNotCache

Defined in ​

profectus/src/util/computed.ts:6

Functions ​

convertComputable ​

â–¸ convertComputable<T>(obj): ProcessedComputable<T>

Type parameters ​

Name
T

Parameters ​

NameType
objComputable<T>

Returns ​

ProcessedComputable<T>

Defined in ​

profectus/src/util/computed.ts:50

processComputable ​

â–¸ processComputable<T, S>(obj, key): asserts obj is T & { [K in string | number | symbol]: ProcessedComputable<UnwrapComputableType<T[S]>> }

Type parameters ​

NameType
TT
Sextends string | number | symbol

Parameters ​

NameType
objT
keyS

Returns ​

asserts obj is T & { [K in string | number | symbol]: ProcessedComputable<UnwrapComputableType<T[S]>> }

Defined in ​

profectus/src/util/computed.ts:31

- diff --git a/api/modules/util/proxies.html b/api/modules/util/proxies.html index 3857461f..b67acd56 100644 --- a/api/modules/util/proxies.html +++ b/api/modules/util/proxies.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: util/proxies ​

Type Aliases ​

Proxied ​

Ƭ Proxied<T>: NonNullable<T> extends Record<PropertyKey, unknown> ? NonNullable<T> extends Persistent<infer S> ? NonPersistent<S> : NonNullable<T> extends default ? T : { [K in keyof T]: Proxied<T[K]> } & { [ProxyState]: T } : T

Type parameters ​

Name
T

Defined in ​

profectus/src/util/proxies.ts:19

ProxiedWithState ​

Ƭ ProxiedWithState<T>: NonNullable<T> extends Record<PropertyKey, unknown> ? NonNullable<T> extends default ? T : { [K in keyof T]: ProxiedWithState<T[K]> } & { [ProxyPath]: string[] ; [ProxyState]: T } : T

Type parameters ​

Name
T

Defined in ​

profectus/src/util/proxies.ts:8

Variables ​

ProxyPath ​

• Const ProxyPath: typeof ProxyPath

Defined in ​

profectus/src/util/proxies.ts:6

ProxyState ​

• Const ProxyState: typeof ProxyState

Defined in ​

profectus/src/util/proxies.ts:5

Functions ​

createLazyProxy ​

â–¸ createLazyProxy<T, S>(objectFunc, baseObject?): T

Type parameters ​

NameType
Textends object
Sextends object

Parameters ​

NameType
objectFunc(baseObject: S) => T & S
baseObjectS

Returns ​

T

Defined in ​

profectus/src/util/proxies.ts:33

- diff --git a/api/modules/util/save.html b/api/modules/util/save.html index 65c07a2a..504856a0 100644 --- a/api/modules/util/save.html +++ b/api/modules/util/save.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: util/save ​

Variables ​

loadingSave ​

• Const loadingSave: Ref<boolean>

Defined in ​

profectus/src/util/save.ts:89

Functions ​

deleteLowerSaves ​

â–¸ deleteLowerSaves(): void

Returns ​

void

Defined in ​

profectus/src/util/save.ts:155

getUniqueID ​

â–¸ getUniqueID(): string

Returns ​

string

Defined in ​

profectus/src/util/save.ts:80

hardReset ​

â–¸ hardReset(): Promise<void>

Returns ​

Promise<void>

Defined in ​

profectus/src/util/save.ts:152

load ​

â–¸ load(): Promise<void>

Returns ​

Promise<void>

Defined in ​

profectus/src/util/save.ts:35

loadSave ​

â–¸ loadSave(playerObj): Promise<void>

Parameters ​

NameType
playerObjPartial<Player>

Returns ​

Promise<void>

Defined in ​

profectus/src/util/save.ts:91

newSave ​

â–¸ newSave(): Player

Returns ​

Player

Defined in ​

profectus/src/util/save.ts:70

save ​

â–¸ save(playerData?): string

Parameters ​

NameType
playerData?Player

Returns ​

string

Defined in ​

profectus/src/util/save.ts:29

setupInitialStore ​

â–¸ setupInitialStore(player?): Player

Parameters ​

NameType
playerPartial<Player>

Returns ​

Player

Defined in ​

profectus/src/util/save.ts:9

- diff --git a/api/modules/util/vue.html b/api/modules/util/vue.html index c092b000..c3295e74 100644 --- a/api/modules/util/vue.html +++ b/api/modules/util/vue.html @@ -22,7 +22,7 @@
Profectus
On this page

Module: util/vue ​

Interfaces ​

Type Aliases ​

PropTypes ​

Ƭ PropTypes: typeof Boolean | typeof String | typeof Number | typeof Function | typeof Object | typeof Array

Defined in ​

profectus/src/util/vue.tsx:216

Functions ​

coerceComponent ​

â–¸ coerceComponent(component, defaultWrapper?): DefineComponent

Parameters ​

NameTypeDefault value
componentCoercableComponentundefined
defaultWrapperstring"span"

Returns ​

DefineComponent

Defined in ​

profectus/src/util/vue.tsx:25

computeComponent ​

â–¸ computeComponent(component, defaultWrapper?): ShallowRef<Component | "">

Parameters ​

NameTypeDefault value
componentRef<ProcessedComputable<CoercableComponent>>undefined
defaultWrapperstring"div"

Returns ​

ShallowRef<Component | "">

Defined in ​

profectus/src/util/vue.tsx:175

computeOptionalComponent ​

â–¸ computeOptionalComponent(component, defaultWrapper?): ShallowRef<Component | "" | null>

Parameters ​

NameTypeDefault value
componentRef<ProcessedComputable<undefined | CoercableComponent>>undefined
defaultWrapperstring"div"

Returns ​

ShallowRef<Component | "" | null>

Defined in ​

profectus/src/util/vue.tsx:185

getFirstFeature ​

â–¸ getFirstFeature<T>(features, filter): Object

Type parameters ​

NameType
Textends VueFeature & { visibility: ProcessedComputable<boolean | Visibility> }

Parameters ​

NameType
featuresT[]
filter(feature: T) => boolean

Returns ​

Object

NameType
collapsedContentJSXFunction
firstFeatureRef<T | undefined>
hasCollapsedContentRef<boolean>

Defined in ​

profectus/src/util/vue.tsx:155

isCoercableComponent ​

â–¸ isCoercableComponent(component): component is CoercableComponent

Parameters ​

NameType
componentunknown

Returns ​

component is CoercableComponent

Defined in ​

profectus/src/util/vue.tsx:104

joinJSX ​

â–¸ joinJSX(objects, joiner): JSX.Element

Parameters ​

NameType
objectsElement[]
joinerElement

Returns ​

JSX.Element

Defined in ​

profectus/src/util/vue.tsx:94

processedPropType ​

â–¸ processedPropType<T>(...types): PropType<ProcessedComputable<T>>

Type parameters ​

Name
T

Parameters ​

NameType
...typesPropTypes[]

Returns ​

PropType<ProcessedComputable<T>>

Defined in ​

profectus/src/util/vue.tsx:225

render ​

â–¸ render(object): JSX.Element | DefineComponent

Parameters ​

NameType
objectCoercableComponent | VueFeature

Returns ​

JSX.Element | DefineComponent

Defined in ​

profectus/src/util/vue.tsx:51

renderCol ​

â–¸ renderCol(...objects): JSX.Element

Parameters ​

NameType
...objects(CoercableComponent | VueFeature)[]

Returns ​

JSX.Element

Defined in ​

profectus/src/util/vue.tsx:66

renderColJSX ​

â–¸ renderColJSX(...objects): JSX.Element

Parameters ​

NameType
...objects(CoercableComponent | VueFeature)[]

Returns ​

JSX.Element

Defined in ​

profectus/src/util/vue.tsx:90

renderJSX ​

â–¸ renderJSX(object): JSX.Element

Parameters ​

NameType
objectCoercableComponent | VueFeature

Returns ​

JSX.Element

Defined in ​

profectus/src/util/vue.tsx:70

renderRow ​

â–¸ renderRow(...objects): JSX.Element

Parameters ​

NameType
...objects(CoercableComponent | VueFeature)[]

Returns ​

JSX.Element

Defined in ​

profectus/src/util/vue.tsx:62

renderRowJSX ​

â–¸ renderRowJSX(...objects): JSX.Element

Parameters ​

NameType
...objects(CoercableComponent | VueFeature)[]

Returns ​

JSX.Element

Defined in ​

profectus/src/util/vue.tsx:86

setRefValue ​

â–¸ setRefValue<T>(ref, value): void

Type parameters ​

Name
T

Parameters ​

NameType
refRef<T | Ref<T>>
valueT

Returns ​

void

Defined in ​

profectus/src/util/vue.tsx:208

setupHoldToClick ​

â–¸ setupHoldToClick(onClick?, onHold?): Object

Parameters ​

NameType
onClick?Ref<undefined | (e?: MouseEvent | TouchEvent) => void>
onHold?Ref<undefined | VoidFunction>

Returns ​

Object

NameType
handleHoldingVoidFunction
start(e: MouseEvent | TouchEvent) => void
stopVoidFunction

Defined in ​

profectus/src/util/vue.tsx:119

trackHover ​

â–¸ trackHover(element): Ref<boolean>

Parameters ​

NameType
elementVueFeature

Returns ​

Ref<boolean>

Defined in ​

profectus/src/util/vue.tsx:232

unwrapRef ​

â–¸ unwrapRef<T>(ref): T

Type parameters ​

Name
T

Parameters ​

NameType
refRef<ProcessedComputable<T>>

Returns ​

T

Defined in ​

profectus/src/util/vue.tsx:204

wrapRef ​

â–¸ wrapRef<T>(ref): ComputedRef<T>

Type parameters ​

Name
T

Parameters ​

NameType
refRef<ProcessedComputable<T>>

Returns ​

ComputedRef<T>

Defined in ​

profectus/src/util/vue.tsx:200

- diff --git a/api/overview.html b/api/overview.html index 9fde6b9f..eb9c37ea 100644 --- a/api/overview.html +++ b/api/overview.html @@ -22,7 +22,7 @@
Profectus
On this page

Profectus API ​

This section of the docs is generated via the doc comments inside the Profectus source code. While it can be used as a reference, the comments themselves should show up in your IDE when relevant, which is probably a better way to get help. The guide has longer-form explanations of key concepts and is more likely to be of use to new developers.

- diff --git a/assets/guide_advanced-concepts_creating-features.md.426efab2.js b/assets/guide_advanced-concepts_creating-features.md.4c37639d.js similarity index 99% rename from assets/guide_advanced-concepts_creating-features.md.426efab2.js rename to assets/guide_advanced-concepts_creating-features.md.4c37639d.js index 9d0e5c13..85baafef 100644 --- a/assets/guide_advanced-concepts_creating-features.md.426efab2.js +++ b/assets/guide_advanced-concepts_creating-features.md.4c37639d.js @@ -1,4 +1,4 @@ -import{_ as s,c as e,o as a,N as n}from"./chunks/framework.0799945b.js";const d=JSON.parse('{"title":"Creating Features","description":"","frontmatter":{},"headers":[],"relativePath":"guide/advanced-concepts/creating-features.md","lastUpdated":1681094412000}'),o={name:"guide/advanced-concepts/creating-features.md"},t=n(`

Creating Features ​

Profectus is designed to encourage the developer to eventually start designing their own features for use in specific games. Features are designed to work where they require minimal (and typically zero) modifications around the code base - you simply write a single file for the feature, and any vue components it needs, and the act of importing that feature will set everything up. This also means you can share these features with others in entire collections, and any they don't use won't be present in the build output, won't be loaded, and won't affect the project in any way.

Creating the Feature ​

Every feature has a couple of types. They have the feature themselves, a generic version for convenience, and any constructor typically has an options type and a type that gets "added" to it to create the feature itself. These typically involve replacing some types to denote how various properties change from, for example, Computable<X> to ProcessedComputable<X>. You should be able to use any of the existing features as a reference for how these types look and work.

Most significantly, the base type should typically always have a type property pointing to a symbol unique to this feature, so they can be easily differentiated at runtime. If it's a feature that should be renderable, then it'll also need [Component] and [GatherProps] properties, which describe the vue component to use and how to get the props for it from this feature, as well as a unique ID for the feature's node. You cna use the getUniqueID utility to help.

The constructor itself should do several things. They should take their options within a function, so that they're not resolved when the object is constructed. It should return a lazy proxy of the feature, which allows features to reference each other and only resolve themselves once every feature is defined. The constructor should create any persistent refs it may require outside of the lazy proxy - it won't have access to the options at this point, so it should make any it potentially may require. Any that turn out not being needed can be deleted. Inside the lazy proxy the constructor should create the options object, assign onto it every property from the base type, call processComputable on every computable type, and setDefault on any property with a default value. Then you should be able to simply return the options object, likely with a type cast, and the constructor will be complete.

Because typescript does not emit JS, if a property is supposed to be a function it is impossible to differentiate between a function that is itself the intended value or a function that returns the actual value. For this reason it is not recommended for any feature types to include properties that are Computable<Function>s, and all functions will be wrapped in computed. The notable exception to this is JSX, which uses a utility function to mark that a function should not be wrapped.

Vue Components ​

Any vue components you write need to do a couple things. Typically they'll need to type any props that come from computed properties appropriately, for which you can use the processedPropType utility - using it will look something like style: processedPropType<StyleValue>(String, Object, Array). You'll also want to make sure to unref any of these props you use in the template. The template should make sure to include a Node component with the feature's ID. Also, if there are custom displays this feature may have, you'll want to convert the CoercableComponent into a Vue component inside the setup function, typically using the computeComponent or computeOptionalComponent utilities.

Custom Settings ​

To add a setting to the options menu specific to this feature, you'll need to do three things, all inside the feature's file. First, extend the settings type with the name of the new setting. For example, here's how the challenge feature adds a setting to hide completed challenges:

ts
declare module "game/settings" {
+import{_ as s,c as e,o as a,N as n}from"./chunks/framework.0799945b.js";const d=JSON.parse('{"title":"Creating Features","description":"","frontmatter":{},"headers":[],"relativePath":"guide/advanced-concepts/creating-features.md","lastUpdated":1681131771000}'),o={name:"guide/advanced-concepts/creating-features.md"},t=n(`
Creating Features ​
Profectus is designed to encourage the developer to eventually start designing their own features for use in specific games. Features are designed to work where they require minimal (and typically zero) modifications around the code base - you simply write a single file for the feature, and any vue components it needs, and the act of importing that feature will set everything up. This also means you can share these features with others in entire collections, and any they don't use won't be present in the build output, won't be loaded, and won't affect the project in any way.
Creating the Feature ​
Every feature has a couple of types. They have the feature themselves, a generic version for convenience, and any constructor typically has an options type and a type that gets "added" to it to create the feature itself. These typically involve replacing some types to denote how various properties change from, for example, Computable<X> to ProcessedComputable<X>. You should be able to use any of the existing features as a reference for how these types look and work.
Most significantly, the base type should typically always have a type property pointing to a symbol unique to this feature, so they can be easily differentiated at runtime. If it's a feature that should be renderable, then it'll also need [Component] and [GatherProps] properties, which describe the vue component to use and how to get the props for it from this feature, as well as a unique ID for the feature's node. You cna use the getUniqueID utility to help.
The constructor itself should do several things. They should take their options within a function, so that they're not resolved when the object is constructed. It should return a lazy proxy of the feature, which allows features to reference each other and only resolve themselves once every feature is defined. The constructor should create any persistent refs it may require outside of the lazy proxy - it won't have access to the options at this point, so it should make any it potentially may require. Any that turn out not being needed can be deleted. Inside the lazy proxy the constructor should create the options object, assign onto it every property from the base type, call processComputable on every computable type, and setDefault on any property with a default value. Then you should be able to simply return the options object, likely with a type cast, and the constructor will be complete.
Because typescript does not emit JS, if a property is supposed to be a function it is impossible to differentiate between a function that is itself the intended value or a function that returns the actual value. For this reason it is not recommended for any feature types to include properties that are Computable<Function>s, and all functions will be wrapped in computed. The notable exception to this is JSX, which uses a utility function to mark that a function should not be wrapped.
Vue Components ​
Any vue components you write need to do a couple things. Typically they'll need to type any props that come from computed properties appropriately, for which you can use the processedPropType utility - using it will look something like style: processedPropType<StyleValue>(String, Object, Array). You'll also want to make sure to unref any of these props you use in the template. The template should make sure to include a Node component with the feature's ID. Also, if there are custom displays this feature may have, you'll want to convert the CoercableComponent into a Vue component inside the setup function, typically using the computeComponent or computeOptionalComponent utilities.
Custom Settings ​
To add a setting to the options menu specific to this feature, you'll need to do three things, all inside the feature's file. First, extend the settings type with the name of the new setting. For example, here's how the challenge feature adds a setting to hide completed challenges:
ts
declare module "game/settings" {
     interface Settings {
         hideChallenges: boolean;
     }
diff --git a/assets/guide_advanced-concepts_creating-features.md.426efab2.lean.js b/assets/guide_advanced-concepts_creating-features.md.4c37639d.lean.js
similarity index 85%
rename from assets/guide_advanced-concepts_creating-features.md.426efab2.lean.js
rename to assets/guide_advanced-concepts_creating-features.md.4c37639d.lean.js
index 0f8ac931..da360e31 100644
--- a/assets/guide_advanced-concepts_creating-features.md.426efab2.lean.js
+++ b/assets/guide_advanced-concepts_creating-features.md.4c37639d.lean.js
@@ -1 +1 @@
-import{_ as s,c as e,o as a,N as n}from"./chunks/framework.0799945b.js";const d=JSON.parse('{"title":"Creating Features","description":"","frontmatter":{},"headers":[],"relativePath":"guide/advanced-concepts/creating-features.md","lastUpdated":1681094412000}'),o={name:"guide/advanced-concepts/creating-features.md"},t=n("",19),l=[t];function p(r,c,y,i,F,D){return a(),e("div",null,l)}const C=s(o,[["render",p]]);export{d as __pageData,C as default};
+import{_ as s,c as e,o as a,N as n}from"./chunks/framework.0799945b.js";const d=JSON.parse('{"title":"Creating Features","description":"","frontmatter":{},"headers":[],"relativePath":"guide/advanced-concepts/creating-features.md","lastUpdated":1681131771000}'),o={name:"guide/advanced-concepts/creating-features.md"},t=n("",19),l=[t];function p(r,c,y,i,F,D){return a(),e("div",null,l)}const C=s(o,[["render",p]]);export{d as __pageData,C as default};
diff --git a/assets/guide_advanced-concepts_dynamic-layers.md.a5b2ad1d.js b/assets/guide_advanced-concepts_dynamic-layers.md.f71d038a.js
similarity index 98%
rename from assets/guide_advanced-concepts_dynamic-layers.md.a5b2ad1d.js
rename to assets/guide_advanced-concepts_dynamic-layers.md.f71d038a.js
index 98b2a52b..dadf08bd 100644
--- a/assets/guide_advanced-concepts_dynamic-layers.md.a5b2ad1d.js
+++ b/assets/guide_advanced-concepts_dynamic-layers.md.f71d038a.js
@@ -1,4 +1,4 @@
-import{_ as a,c as s,o as e,N as n}from"./chunks/framework.0799945b.js";const D=JSON.parse('{"title":"Dynamic Layers","description":"","frontmatter":{},"headers":[],"relativePath":"guide/advanced-concepts/dynamic-layers.md","lastUpdated":1681094412000}'),o={name:"guide/advanced-concepts/dynamic-layers.md"},l=n(`
Dynamic Layers ​
You can dynamically add and remove layers using the addLayer and removeLayer functions. It's important to note that removing a layer does not affect the player's save data. You can safely add and remove the same layer without losing any progress. For instances where the structure of a layer changes, such as when adding a new feature, use the reloadLayer function.
When procedurally generating layers with similar structures, consider using a utility function like the one below. This function allows you to access a correctly typed reference to a layer with a specified ID easily:
ts
function getDynLayer(id: string): DynamicLayer {
+import{_ as a,c as s,o as e,N as n}from"./chunks/framework.0799945b.js";const D=JSON.parse('{"title":"Dynamic Layers","description":"","frontmatter":{},"headers":[],"relativePath":"guide/advanced-concepts/dynamic-layers.md","lastUpdated":1681131771000}'),o={name:"guide/advanced-concepts/dynamic-layers.md"},l=n(`
Dynamic Layers ​
You can dynamically add and remove layers using the addLayer and removeLayer functions. It's important to note that removing a layer does not affect the player's save data. You can safely add and remove the same layer without losing any progress. For instances where the structure of a layer changes, such as when adding a new feature, use the reloadLayer function.
When procedurally generating layers with similar structures, consider using a utility function like the one below. This function allows you to access a correctly typed reference to a layer with a specified ID easily:
ts
function getDynLayer(id: string): DynamicLayer {
   const layer = layers[id];
   if (!layer) throw "Layer does not exist";
   return layer as DynamicLayer; // you might need an "as unknown" after layer
diff --git a/assets/guide_advanced-concepts_dynamic-layers.md.a5b2ad1d.lean.js b/assets/guide_advanced-concepts_dynamic-layers.md.f71d038a.lean.js
similarity index 85%
rename from assets/guide_advanced-concepts_dynamic-layers.md.a5b2ad1d.lean.js
rename to assets/guide_advanced-concepts_dynamic-layers.md.f71d038a.lean.js
index c94697b9..bcf8d519 100644
--- a/assets/guide_advanced-concepts_dynamic-layers.md.a5b2ad1d.lean.js
+++ b/assets/guide_advanced-concepts_dynamic-layers.md.f71d038a.lean.js
@@ -1 +1 @@
-import{_ as a,c as s,o as e,N as n}from"./chunks/framework.0799945b.js";const D=JSON.parse('{"title":"Dynamic Layers","description":"","frontmatter":{},"headers":[],"relativePath":"guide/advanced-concepts/dynamic-layers.md","lastUpdated":1681094412000}'),o={name:"guide/advanced-concepts/dynamic-layers.md"},l=n("",6),t=[l];function r(p,c,y,i,d,u){return e(),s("div",null,t)}const h=a(o,[["render",r]]);export{D as __pageData,h as default};
+import{_ as a,c as s,o as e,N as n}from"./chunks/framework.0799945b.js";const D=JSON.parse('{"title":"Dynamic Layers","description":"","frontmatter":{},"headers":[],"relativePath":"guide/advanced-concepts/dynamic-layers.md","lastUpdated":1681131771000}'),o={name:"guide/advanced-concepts/dynamic-layers.md"},l=n("",6),t=[l];function r(p,c,y,i,d,u){return e(),s("div",null,t)}const h=a(o,[["render",r]]);export{D as __pageData,h as default};
diff --git a/assets/guide_advanced-concepts_nodes.md.f29b361a.js b/assets/guide_advanced-concepts_nodes.md.7a309ab5.js
similarity index 99%
rename from assets/guide_advanced-concepts_nodes.md.f29b361a.js
rename to assets/guide_advanced-concepts_nodes.md.7a309ab5.js
index 1fae3e16..7125cec2 100644
--- a/assets/guide_advanced-concepts_nodes.md.f29b361a.js
+++ b/assets/guide_advanced-concepts_nodes.md.7a309ab5.js
@@ -1,4 +1,4 @@
-import{_ as s,c as n,o as a,N as o}from"./chunks/framework.0799945b.js";const C=JSON.parse('{"title":"Nodes","description":"","frontmatter":{},"headers":[],"relativePath":"guide/advanced-concepts/nodes.md","lastUpdated":1681094412000}'),l={name:"guide/advanced-concepts/nodes.md"},e=o(`
Nodes ​
Features rendered in the DOM should include a Node component, which registers itself to the nearest Context component (usually within the Layer's component) and tracks the bounding rect (both size and position) of the DOM element. Access the DOM element for a feature via its unique id property within layer.nodes, provided it currently exists.
This is useful for features with complex displays, such as particle effects positioned relative to another feature or drawing links between different nodes. To illustrate this, let's look at a complete example of using layer.nodes to get a node's bounding rect and then placing a particle effect using it. Here's an example from Kronos:
ts
const particlesEmitter = ref(particles.addEmitter(element.particlesConfig));
+import{_ as s,c as n,o as a,N as o}from"./chunks/framework.0799945b.js";const C=JSON.parse('{"title":"Nodes","description":"","frontmatter":{},"headers":[],"relativePath":"guide/advanced-concepts/nodes.md","lastUpdated":1681131771000}'),l={name:"guide/advanced-concepts/nodes.md"},e=o(`
Nodes ​
Features rendered in the DOM should include a Node component, which registers itself to the nearest Context component (usually within the Layer's component) and tracks the bounding rect (both size and position) of the DOM element. Access the DOM element for a feature via its unique id property within layer.nodes, provided it currently exists.
This is useful for features with complex displays, such as particle effects positioned relative to another feature or drawing links between different nodes. To illustrate this, let's look at a complete example of using layer.nodes to get a node's bounding rect and then placing a particle effect using it. Here's an example from Kronos:
ts
const particlesEmitter = ref(particles.addEmitter(element.particlesConfig));
 const updateParticleEffect = async ([shouldEmit, rect, boundingRect]: [
     boolean,
     DOMRect | undefined,
diff --git a/assets/guide_advanced-concepts_nodes.md.f29b361a.lean.js b/assets/guide_advanced-concepts_nodes.md.7a309ab5.lean.js
similarity index 84%
rename from assets/guide_advanced-concepts_nodes.md.f29b361a.lean.js
rename to assets/guide_advanced-concepts_nodes.md.7a309ab5.lean.js
index c89f48cb..f6091a41 100644
--- a/assets/guide_advanced-concepts_nodes.md.f29b361a.lean.js
+++ b/assets/guide_advanced-concepts_nodes.md.7a309ab5.lean.js
@@ -1 +1 @@
-import{_ as s,c as n,o as a,N as o}from"./chunks/framework.0799945b.js";const C=JSON.parse('{"title":"Nodes","description":"","frontmatter":{},"headers":[],"relativePath":"guide/advanced-concepts/nodes.md","lastUpdated":1681094412000}'),l={name:"guide/advanced-concepts/nodes.md"},e=o("",6),p=[e];function t(c,r,y,D,F,i){return a(),n("div",null,p)}const d=s(l,[["render",t]]);export{C as __pageData,d as default};
+import{_ as s,c as n,o as a,N as o}from"./chunks/framework.0799945b.js";const C=JSON.parse('{"title":"Nodes","description":"","frontmatter":{},"headers":[],"relativePath":"guide/advanced-concepts/nodes.md","lastUpdated":1681131771000}'),l={name:"guide/advanced-concepts/nodes.md"},e=o("",6),p=[e];function t(c,r,y,D,F,i){return a(),n("div",null,p)}const d=s(l,[["render",t]]);export{C as __pageData,d as default};
diff --git a/assets/guide_creating-your-project_changelog.md.2ba9cb27.js b/assets/guide_creating-your-project_changelog.md.d1bc7baa.js
similarity index 98%
rename from assets/guide_creating-your-project_changelog.md.2ba9cb27.js
rename to assets/guide_creating-your-project_changelog.md.d1bc7baa.js
index b6680daf..d25347d5 100644
--- a/assets/guide_creating-your-project_changelog.md.2ba9cb27.js
+++ b/assets/guide_creating-your-project_changelog.md.d1bc7baa.js
@@ -1,4 +1,4 @@
-import{_ as s,c as a,o as n,N as e}from"./chunks/framework.0799945b.js";const g=JSON.parse('{"title":"Changelog","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/changelog.md","lastUpdated":1681094412000}'),l={name:"guide/creating-your-project/changelog.md"},o=e(`
Changelog ​
This is a Vue component stored at /src/data/Changelog.vue used to display all the changes version to version. You can use any features you'd like within here, but it's recommended to simply add new <details> elements for each new major release, and mark the most recent one as open by default. It is strongly advised to not change any of the code relating to making the changelog appear in a modal.
There is a single version included by default that can serve as a reference of how it is recommended to add a version to the changelog:
html
<details open>
+import{_ as s,c as a,o as n,N as e}from"./chunks/framework.0799945b.js";const g=JSON.parse('{"title":"Changelog","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/changelog.md","lastUpdated":1681131771000}'),l={name:"guide/creating-your-project/changelog.md"},o=e(`
Changelog ​
This is a Vue component stored at /src/data/Changelog.vue used to display all the changes version to version. You can use any features you'd like within here, but it's recommended to simply add new <details> elements for each new major release, and mark the most recent one as open by default. It is strongly advised to not change any of the code relating to making the changelog appear in a modal.
There is a single version included by default that can serve as a reference of how it is recommended to add a version to the changelog:
html
<details open>
 	<summary>v0.0 Initial Commit - <time>2021-09-04</time></summary>
 	This is the first release :D
 	<ul>
diff --git a/assets/guide_creating-your-project_changelog.md.2ba9cb27.lean.js b/assets/guide_creating-your-project_changelog.md.d1bc7baa.lean.js
similarity index 85%
rename from assets/guide_creating-your-project_changelog.md.2ba9cb27.lean.js
rename to assets/guide_creating-your-project_changelog.md.d1bc7baa.lean.js
index fd03c889..111b3e8a 100644
--- a/assets/guide_creating-your-project_changelog.md.2ba9cb27.lean.js
+++ b/assets/guide_creating-your-project_changelog.md.d1bc7baa.lean.js
@@ -1 +1 @@
-import{_ as s,c as a,o as n,N as e}from"./chunks/framework.0799945b.js";const g=JSON.parse('{"title":"Changelog","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/changelog.md","lastUpdated":1681094412000}'),l={name:"guide/creating-your-project/changelog.md"},o=e("",6),t=[o];function p(c,r,D,i,F,y){return n(),a("div",null,t)}const h=s(l,[["render",p]]);export{g as __pageData,h as default};
+import{_ as s,c as a,o as n,N as e}from"./chunks/framework.0799945b.js";const g=JSON.parse('{"title":"Changelog","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/changelog.md","lastUpdated":1681131771000}'),l={name:"guide/creating-your-project/changelog.md"},o=e("",6),t=[o];function p(c,r,D,i,F,y){return n(),a("div",null,t)}const h=s(l,[["render",p]]);export{g as __pageData,h as default};
diff --git a/assets/guide_creating-your-project_project-entry.md.56be55a7.js b/assets/guide_creating-your-project_project-entry.md.99e6dee7.js
similarity index 98%
rename from assets/guide_creating-your-project_project-entry.md.56be55a7.js
rename to assets/guide_creating-your-project_project-entry.md.99e6dee7.js
index 0f30ffcc..d5b5f6c7 100644
--- a/assets/guide_creating-your-project_project-entry.md.56be55a7.js
+++ b/assets/guide_creating-your-project_project-entry.md.99e6dee7.js
@@ -1 +1 @@
-import{_ as e,c as a,o as t,N as o}from"./chunks/framework.0799945b.js";const f=JSON.parse('{"title":"Project Entry","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/project-entry.md","lastUpdated":1681094412000}'),s={name:"guide/creating-your-project/project-entry.md"},r=o('
Project Entry ​
This is a TypeScript file containing the non-static parts of your project, and acts as the entry point for it.
It is stored at /src/data/projEntry.jsx.
This file has 3 things it must export, but beyond that can export anything the creator wants it to. Typically in addition to the required 3, the initial/"main" layer will be exported. Typically utilites belong in common.tsx, which exists next to projEntry.tsx.
Required Exports ​
getInitialLayers ​
  • Type: (player: Partial<PlayerData>) => GenericLayer[]
A function that is given a player save data object currently being loaded, and returns a list of layers that should be active for that player. If a project does not have dynamic layers, this should always return a list of all layers.
hasWon ​
  • Type: ComputedRef<boolean>
A computed ref whose value is true whenever the game is over.
For example, in a game where the goal is to have a resource reach 10:
ts
export const hasWon = computed(() => Decimal.gte(resource.value, 10));
fixOldSave ​
  • Type: (oldVersion: string | undefined, player: Partial<PlayerData>) => void
This function will be run whenever a save is loaded that has a different version than the one in project info. It will be given the old version number, and the player save data object currently being loaded.
The purpose of this function is to perform any necessary migrations, such as capping a resource that accidentally inflated in a previous version of the project. By default it will do nothing.
',17),n=[r];function l(i,p,c,d,h,y){return t(),a("div",null,n)}const g=e(s,[["render",l]]);export{f as __pageData,g as default};
+import{_ as e,c as a,o as t,N as o}from"./chunks/framework.0799945b.js";const f=JSON.parse('{"title":"Project Entry","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/project-entry.md","lastUpdated":1681131771000}'),s={name:"guide/creating-your-project/project-entry.md"},r=o('
Project Entry ​
This is a TypeScript file containing the non-static parts of your project, and acts as the entry point for it.
It is stored at /src/data/projEntry.jsx.
This file has 3 things it must export, but beyond that can export anything the creator wants it to. Typically in addition to the required 3, the initial/"main" layer will be exported. Typically utilites belong in common.tsx, which exists next to projEntry.tsx.
Required Exports ​
getInitialLayers ​
  • Type: (player: Partial<PlayerData>) => GenericLayer[]
A function that is given a player save data object currently being loaded, and returns a list of layers that should be active for that player. If a project does not have dynamic layers, this should always return a list of all layers.
hasWon ​
  • Type: ComputedRef<boolean>
A computed ref whose value is true whenever the game is over.
For example, in a game where the goal is to have a resource reach 10:
ts
export const hasWon = computed(() => Decimal.gte(resource.value, 10));
fixOldSave ​
  • Type: (oldVersion: string | undefined, player: Partial<PlayerData>) => void
This function will be run whenever a save is loaded that has a different version than the one in project info. It will be given the old version number, and the player save data object currently being loaded.
The purpose of this function is to perform any necessary migrations, such as capping a resource that accidentally inflated in a previous version of the project. By default it will do nothing.
',17),n=[r];function l(i,p,c,d,h,y){return t(),a("div",null,n)}const g=e(s,[["render",l]]);export{f as __pageData,g as default};
diff --git a/assets/guide_creating-your-project_project-entry.md.56be55a7.lean.js b/assets/guide_creating-your-project_project-entry.md.99e6dee7.lean.js
similarity index 85%
rename from assets/guide_creating-your-project_project-entry.md.56be55a7.lean.js
rename to assets/guide_creating-your-project_project-entry.md.99e6dee7.lean.js
index 28124616..50ee1c57 100644
--- a/assets/guide_creating-your-project_project-entry.md.56be55a7.lean.js
+++ b/assets/guide_creating-your-project_project-entry.md.99e6dee7.lean.js
@@ -1 +1 @@
-import{_ as e,c as a,o as t,N as o}from"./chunks/framework.0799945b.js";const f=JSON.parse('{"title":"Project Entry","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/project-entry.md","lastUpdated":1681094412000}'),s={name:"guide/creating-your-project/project-entry.md"},r=o("",17),n=[r];function l(i,p,c,d,h,y){return t(),a("div",null,n)}const g=e(s,[["render",l]]);export{f as __pageData,g as default};
+import{_ as e,c as a,o as t,N as o}from"./chunks/framework.0799945b.js";const f=JSON.parse('{"title":"Project Entry","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/project-entry.md","lastUpdated":1681131771000}'),s={name:"guide/creating-your-project/project-entry.md"},r=o("",17),n=[r];function l(i,p,c,d,h,y){return t(),a("div",null,n)}const g=e(s,[["render",l]]);export{f as __pageData,g as default};
diff --git a/assets/guide_creating-your-project_project-info.md.9bccc4b8.js b/assets/guide_creating-your-project_project-info.md.4c371e5e.js
similarity index 99%
rename from assets/guide_creating-your-project_project-info.md.9bccc4b8.js
rename to assets/guide_creating-your-project_project-info.md.4c371e5e.js
index e73ba280..cb45a420 100644
--- a/assets/guide_creating-your-project_project-info.md.9bccc4b8.js
+++ b/assets/guide_creating-your-project_project-info.md.4c371e5e.js
@@ -1 +1 @@
-import{_ as e,c as a,o,N as t}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Project Info","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/project-info.md","lastUpdated":1681094412000}'),i={name:"guide/creating-your-project/project-info.md"},l=t('
Project Info ​
This is a JSON file containing information that describes your project and configures parts of how Profectus should represent it.
It is stored at /src/data/projInfo.json.
Basic Config ​
title ​
  • Type: string
  • Default: Profectus
The name of the project, which will appear in the info tab and the header, if enabled. The page title will also be set to this value.
description ​
  • Type: string
  • Default: A project made in Profectus
A description of the project, which will be used when the project is installed as a Progressive Web Application.
id ​
  • Type: string
  • Default: ""
This is a unique ID used when saving player data. Changing this will effectively erase all save data for all players.
WARNING
This ID MUST be unique to your project, and should not be left as the default value. Otherwise, your project may use the save data from another project and cause issues for both projects.
author ​
  • Type: string
  • Default: ""
The author of the project, which will appear in the info tab.
discordName ​
  • Type: string
  • Default: The Paper Pilot Community
The text to display for the discord server to point users to. This will appear when hovering over the discord icon, inside the info tab, the game over screen, as well as the NaN detected screen.
By default, this is The Paper Pilot Community, which can act as a catch-all for any Profectus projects without their own servers. If you change the discord server with your own, The Paper Pilot Community will still display underneath the custom server when hovering over the discord icon and within the info tab. Those places will also contain a link to the Modding Tree discord server.
  • Type: string
  • Default: https://discord.gg/WzejVAx
The link for the discord server to point users to. See discordName for more details.
Version Config ​
versionNumber ​
  • Type: string
  • Default: 0.0
The current version of the project loaded. If the player data was last saved in a different version of the project, fixOldSave will be run, so you can perform any save migrations necessary. This will also appear in the nav, the info tab, and the game over screen.
versionTitle ​
  • Type: string
  • Default: Initial Commit
The display name for the current version of the project loaded. This will also appear in the nav, the info tab, and the game over screen unless set to an empty string.
Display Config ​
allowGoBack ​
  • Type: boolean
  • Default: true
Whether or not to allow tabs (besides the first) to display a "back" button to close them (and any other tabs to the right of them).
defaultShowSmall ​
  • Type: boolean
  • Default: false
Whether or not to allow resources to display small values (<.001). If false they'll just display as 0. Individual resources can also be configured to override this value.
defaultDecimalsShown ​
  • Type: number
  • Default: 2
Default precision to display numbers at when passed into format. Individual format calls can override this value, and resources can be configured with a custom precision as well.
useHeader ​
  • Type: boolean
  • Default: true
Whether or not to display the nav as a header at the top of the screen. If disabled, the nav will appear on the left side of the screen laid over the first tab.
  • Type: string | null
  • Default: null
A path to an image file to display as the logo of the app. If null, the title will be shown instead. This will appear in the nav when useHeader is true.
  • Type: string
  • Default: ""
A path to an image file to display as the logo of the app within the info tab. If left blank no logo will be shown.
initialTabs ​
  • Type: string[]
  • Default: ["main"]
The list of initial tabs to display on new saves. This value must have at least one element. Each element should be the ID of the layer to display in that tab.
Advanced Config ​
maxTickLength ​
  • Type: number
  • Default: 3600
The longest duration a single tick can be, in seconds. When calculating things like offline time, a single tick will be forced to be this amount or lower. This will make calculating offline time spread out across many ticks as necessary. The default value is 1 hour.
offlineLimit ​
  • Type: number
  • Default: 1
The max amount of time that can be stored as offline time, in hours.
enablePausing ​
  • Type: boolean
  • Default: true
Whether or not to allow the player to pause the game. Turning this off disables the toggle from the options menu as well as the NaN screen. Developers can still manually pause by just running player.devSpeed = 0 in console (or = 1 to resume).
exportEncoding ​
  • Type: base64 | lz | plain
  • Default: base64
The encoding to use when exporting to the clipboard. Plain-text is fast to generate but is easiest for the player to manipulate and cheat with. Base 64 is slightly slower and the string will be longer but will offer a small barrier to people trying to cheat. LZ-String is the slowest method, but produces the smallest strings and still offers a small barrier to those trying to cheat. Some sharing platforms like pastebin may automatically delete base64 encoded text, and some sites might not support all the characters used in lz-string exports.
',66),r=[l];function n(s,d,c,h,u,p){return o(),a("div",null,r)}const m=e(i,[["render",n]]);export{b as __pageData,m as default};
+import{_ as e,c as a,o,N as t}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Project Info","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/project-info.md","lastUpdated":1681131771000}'),i={name:"guide/creating-your-project/project-info.md"},l=t('
Project Info ​
This is a JSON file containing information that describes your project and configures parts of how Profectus should represent it.
It is stored at /src/data/projInfo.json.
Basic Config ​
title ​
  • Type: string
  • Default: Profectus
The name of the project, which will appear in the info tab and the header, if enabled. The page title will also be set to this value.
description ​
  • Type: string
  • Default: A project made in Profectus
A description of the project, which will be used when the project is installed as a Progressive Web Application.
id ​
  • Type: string
  • Default: ""
This is a unique ID used when saving player data. Changing this will effectively erase all save data for all players.
WARNING
This ID MUST be unique to your project, and should not be left as the default value. Otherwise, your project may use the save data from another project and cause issues for both projects.
author ​
  • Type: string
  • Default: ""
The author of the project, which will appear in the info tab.
discordName ​
  • Type: string
  • Default: The Paper Pilot Community
The text to display for the discord server to point users to. This will appear when hovering over the discord icon, inside the info tab, the game over screen, as well as the NaN detected screen.
By default, this is The Paper Pilot Community, which can act as a catch-all for any Profectus projects without their own servers. If you change the discord server with your own, The Paper Pilot Community will still display underneath the custom server when hovering over the discord icon and within the info tab. Those places will also contain a link to the Modding Tree discord server.
  • Type: string
  • Default: https://discord.gg/WzejVAx
The link for the discord server to point users to. See discordName for more details.
Version Config ​
versionNumber ​
  • Type: string
  • Default: 0.0
The current version of the project loaded. If the player data was last saved in a different version of the project, fixOldSave will be run, so you can perform any save migrations necessary. This will also appear in the nav, the info tab, and the game over screen.
versionTitle ​
  • Type: string
  • Default: Initial Commit
The display name for the current version of the project loaded. This will also appear in the nav, the info tab, and the game over screen unless set to an empty string.
Display Config ​
allowGoBack ​
  • Type: boolean
  • Default: true
Whether or not to allow tabs (besides the first) to display a "back" button to close them (and any other tabs to the right of them).
defaultShowSmall ​
  • Type: boolean
  • Default: false
Whether or not to allow resources to display small values (<.001). If false they'll just display as 0. Individual resources can also be configured to override this value.
defaultDecimalsShown ​
  • Type: number
  • Default: 2
Default precision to display numbers at when passed into format. Individual format calls can override this value, and resources can be configured with a custom precision as well.
useHeader ​
  • Type: boolean
  • Default: true
Whether or not to display the nav as a header at the top of the screen. If disabled, the nav will appear on the left side of the screen laid over the first tab.
  • Type: string | null
  • Default: null
A path to an image file to display as the logo of the app. If null, the title will be shown instead. This will appear in the nav when useHeader is true.
  • Type: string
  • Default: ""
A path to an image file to display as the logo of the app within the info tab. If left blank no logo will be shown.
initialTabs ​
  • Type: string[]
  • Default: ["main"]
The list of initial tabs to display on new saves. This value must have at least one element. Each element should be the ID of the layer to display in that tab.
Advanced Config ​
maxTickLength ​
  • Type: number
  • Default: 3600
The longest duration a single tick can be, in seconds. When calculating things like offline time, a single tick will be forced to be this amount or lower. This will make calculating offline time spread out across many ticks as necessary. The default value is 1 hour.
offlineLimit ​
  • Type: number
  • Default: 1
The max amount of time that can be stored as offline time, in hours.
enablePausing ​
  • Type: boolean
  • Default: true
Whether or not to allow the player to pause the game. Turning this off disables the toggle from the options menu as well as the NaN screen. Developers can still manually pause by just running player.devSpeed = 0 in console (or = 1 to resume).
exportEncoding ​
  • Type: base64 | lz | plain
  • Default: base64
The encoding to use when exporting to the clipboard. Plain-text is fast to generate but is easiest for the player to manipulate and cheat with. Base 64 is slightly slower and the string will be longer but will offer a small barrier to people trying to cheat. LZ-String is the slowest method, but produces the smallest strings and still offers a small barrier to those trying to cheat. Some sharing platforms like pastebin may automatically delete base64 encoded text, and some sites might not support all the characters used in lz-string exports.
',66),r=[l];function n(s,d,c,h,u,p){return o(),a("div",null,r)}const m=e(i,[["render",n]]);export{b as __pageData,m as default};
diff --git a/assets/guide_creating-your-project_project-info.md.9bccc4b8.lean.js b/assets/guide_creating-your-project_project-info.md.4c371e5e.lean.js
similarity index 85%
rename from assets/guide_creating-your-project_project-info.md.9bccc4b8.lean.js
rename to assets/guide_creating-your-project_project-info.md.4c371e5e.lean.js
index 3b522ff6..7fc68eec 100644
--- a/assets/guide_creating-your-project_project-info.md.9bccc4b8.lean.js
+++ b/assets/guide_creating-your-project_project-info.md.4c371e5e.lean.js
@@ -1 +1 @@
-import{_ as e,c as a,o,N as t}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Project Info","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/project-info.md","lastUpdated":1681094412000}'),i={name:"guide/creating-your-project/project-info.md"},l=t("",66),r=[l];function n(s,d,c,h,u,p){return o(),a("div",null,r)}const m=e(i,[["render",n]]);export{b as __pageData,m as default};
+import{_ as e,c as a,o,N as t}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Project Info","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/project-info.md","lastUpdated":1681131771000}'),i={name:"guide/creating-your-project/project-info.md"},l=t("",66),r=[l];function n(s,d,c,h,u,p){return o(),a("div",null,r)}const m=e(i,[["render",n]]);export{b as __pageData,m as default};
diff --git a/assets/guide_creating-your-project_themes.md.5c750649.js b/assets/guide_creating-your-project_themes.md.ad0d91c8.js
similarity index 97%
rename from assets/guide_creating-your-project_themes.md.5c750649.js
rename to assets/guide_creating-your-project_themes.md.ad0d91c8.js
index 786e0924..10d4eb1c 100644
--- a/assets/guide_creating-your-project_themes.md.5c750649.js
+++ b/assets/guide_creating-your-project_themes.md.ad0d91c8.js
@@ -1 +1 @@
-import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const g=JSON.parse('{"title":"Themes","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/themes.md","lastUpdated":1681094412000}'),i={name:"guide/creating-your-project/themes.md"},s=o('
Themes ​
Themes are objects that change how the project's interface should look. This is done mostly by changing the values of various CSS variables. You can look at the existing themes as a reference for the kind of values these CSS variables expect. They can also set various theme options that change how parts of the screen are laid out, which are described below.
They are stored in /src/data/themes.ts.
Modifying Themes ​
You can add a theme by adding a property to the Themes enum and then including the theme in the exported object. It's recommended to use the spread operator if you'd like to have a theme look like another, but override specific options / CSS variables.
Themes added in this way will be automatically included in the Themes dropdown in the Options tab. Removing themes from the enum and exported object will similarly hide them from the dropdown.
If you'd like to change which theme is the default, you may modify the initial player settings object in the /src/game/settings.ts file. Keep in mind you'll also want to change it in the hardResetSettings function in the same file.
Theme Options ​
floatingTabs ​
  • Type: boolean
Toggles whether to display tab buttons in a tab list, similar to how a browser displays tabs; or to display them as floating buttons, similar to how TMT displays buttons.
mergeAdjacent ​
  • Type: boolean
If true, elements in a row or column will have their margins removed and border radiuses set to 0 between elements. This will cause the elements to appear as segments in a single object.
Currently, this can only merge in a single dimension. Rows of columns or columns of rows will not merge into a single rectangular object.
',15),n=[s];function r(h,l,d,c,m,p){return a(),t("div",null,n)}const b=e(i,[["render",r]]);export{g as __pageData,b as default};
+import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const g=JSON.parse('{"title":"Themes","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/themes.md","lastUpdated":1681131771000}'),i={name:"guide/creating-your-project/themes.md"},s=o('
Themes ​
Themes are objects that change how the project's interface should look. This is done mostly by changing the values of various CSS variables. You can look at the existing themes as a reference for the kind of values these CSS variables expect. They can also set various theme options that change how parts of the screen are laid out, which are described below.
They are stored in /src/data/themes.ts.
Modifying Themes ​
You can add a theme by adding a property to the Themes enum and then including the theme in the exported object. It's recommended to use the spread operator if you'd like to have a theme look like another, but override specific options / CSS variables.
Themes added in this way will be automatically included in the Themes dropdown in the Options tab. Removing themes from the enum and exported object will similarly hide them from the dropdown.
If you'd like to change which theme is the default, you may modify the initial player settings object in the /src/game/settings.ts file. Keep in mind you'll also want to change it in the hardResetSettings function in the same file.
Theme Options ​
floatingTabs ​
  • Type: boolean
Toggles whether to display tab buttons in a tab list, similar to how a browser displays tabs; or to display them as floating buttons, similar to how TMT displays buttons.
mergeAdjacent ​
  • Type: boolean
If true, elements in a row or column will have their margins removed and border radiuses set to 0 between elements. This will cause the elements to appear as segments in a single object.
Currently, this can only merge in a single dimension. Rows of columns or columns of rows will not merge into a single rectangular object.
',15),n=[s];function r(h,l,d,c,m,p){return a(),t("div",null,n)}const b=e(i,[["render",r]]);export{g as __pageData,b as default};
diff --git a/assets/guide_creating-your-project_themes.md.5c750649.lean.js b/assets/guide_creating-your-project_themes.md.ad0d91c8.lean.js
similarity index 84%
rename from assets/guide_creating-your-project_themes.md.5c750649.lean.js
rename to assets/guide_creating-your-project_themes.md.ad0d91c8.lean.js
index 33aec2f6..a751d152 100644
--- a/assets/guide_creating-your-project_themes.md.5c750649.lean.js
+++ b/assets/guide_creating-your-project_themes.md.ad0d91c8.lean.js
@@ -1 +1 @@
-import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const g=JSON.parse('{"title":"Themes","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/themes.md","lastUpdated":1681094412000}'),i={name:"guide/creating-your-project/themes.md"},s=o("",15),n=[s];function r(h,l,d,c,m,p){return a(),t("div",null,n)}const b=e(i,[["render",r]]);export{g as __pageData,b as default};
+import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const g=JSON.parse('{"title":"Themes","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/themes.md","lastUpdated":1681131771000}'),i={name:"guide/creating-your-project/themes.md"},s=o("",15),n=[s];function r(h,l,d,c,m,p){return a(),t("div",null,n)}const b=e(i,[["render",r]]);export{g as __pageData,b as default};
diff --git a/assets/guide_creating-your-project_utils.md.264c40cd.js b/assets/guide_creating-your-project_utils.md.b7441a18.js
similarity index 95%
rename from assets/guide_creating-your-project_utils.md.264c40cd.js
rename to assets/guide_creating-your-project_utils.md.b7441a18.js
index 4f141e64..3b355393 100644
--- a/assets/guide_creating-your-project_utils.md.264c40cd.js
+++ b/assets/guide_creating-your-project_utils.md.b7441a18.js
@@ -1 +1 @@
-import{_ as a,c as o,o as s,x as e,a as t}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Utilities","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/utils.md","lastUpdated":1681094412000}'),i={name:"guide/creating-your-project/utils.md"},n=e("h1",{id:"utilities",tabindex:"-1"},[t("Utilities "),e("a",{class:"header-anchor",href:"#utilities","aria-label":'Permalink to "Utilities"'},"​")],-1),r=e("p",null,"There are often concepts that aren't inherent to a single feature, but rather work with joining different features together. For example, a reset clickable that activates a conversion and resets a tree, which happens to be a common use case but isn't inherent to clickables, conversions, or trees.",-1),c=e("p",null,[t("These are perfect situations for utilities, and so to encourage creators to learn to identify and take advantage of these situations, a file called "),e("code",null,"src/data/common.tsx"),t(" has been created to demo some of the more common utility functions a project might use. Adding new utilities to this file is encouraged, as is creating utils in general. It also works as a good stepping stone to creating your own features.")],-1),l=[n,r,c];function d(u,h,p,f,m,_){return s(),o("div",null,l)}const k=a(i,[["render",d]]);export{b as __pageData,k as default};
+import{_ as a,c as o,o as s,x as e,a as t}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Utilities","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/utils.md","lastUpdated":1681131771000}'),i={name:"guide/creating-your-project/utils.md"},n=e("h1",{id:"utilities",tabindex:"-1"},[t("Utilities "),e("a",{class:"header-anchor",href:"#utilities","aria-label":'Permalink to "Utilities"'},"​")],-1),r=e("p",null,"There are often concepts that aren't inherent to a single feature, but rather work with joining different features together. For example, a reset clickable that activates a conversion and resets a tree, which happens to be a common use case but isn't inherent to clickables, conversions, or trees.",-1),c=e("p",null,[t("These are perfect situations for utilities, and so to encourage creators to learn to identify and take advantage of these situations, a file called "),e("code",null,"src/data/common.tsx"),t(" has been created to demo some of the more common utility functions a project might use. Adding new utilities to this file is encouraged, as is creating utils in general. It also works as a good stepping stone to creating your own features.")],-1),l=[n,r,c];function d(u,h,p,f,m,_){return s(),o("div",null,l)}const k=a(i,[["render",d]]);export{b as __pageData,k as default};
diff --git a/assets/guide_creating-your-project_utils.md.264c40cd.lean.js b/assets/guide_creating-your-project_utils.md.b7441a18.lean.js
similarity index 95%
rename from assets/guide_creating-your-project_utils.md.264c40cd.lean.js
rename to assets/guide_creating-your-project_utils.md.b7441a18.lean.js
index 4f141e64..3b355393 100644
--- a/assets/guide_creating-your-project_utils.md.264c40cd.lean.js
+++ b/assets/guide_creating-your-project_utils.md.b7441a18.lean.js
@@ -1 +1 @@
-import{_ as a,c as o,o as s,x as e,a as t}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Utilities","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/utils.md","lastUpdated":1681094412000}'),i={name:"guide/creating-your-project/utils.md"},n=e("h1",{id:"utilities",tabindex:"-1"},[t("Utilities "),e("a",{class:"header-anchor",href:"#utilities","aria-label":'Permalink to "Utilities"'},"​")],-1),r=e("p",null,"There are often concepts that aren't inherent to a single feature, but rather work with joining different features together. For example, a reset clickable that activates a conversion and resets a tree, which happens to be a common use case but isn't inherent to clickables, conversions, or trees.",-1),c=e("p",null,[t("These are perfect situations for utilities, and so to encourage creators to learn to identify and take advantage of these situations, a file called "),e("code",null,"src/data/common.tsx"),t(" has been created to demo some of the more common utility functions a project might use. Adding new utilities to this file is encouraged, as is creating utils in general. It also works as a good stepping stone to creating your own features.")],-1),l=[n,r,c];function d(u,h,p,f,m,_){return s(),o("div",null,l)}const k=a(i,[["render",d]]);export{b as __pageData,k as default};
+import{_ as a,c as o,o as s,x as e,a as t}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Utilities","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/utils.md","lastUpdated":1681131771000}'),i={name:"guide/creating-your-project/utils.md"},n=e("h1",{id:"utilities",tabindex:"-1"},[t("Utilities "),e("a",{class:"header-anchor",href:"#utilities","aria-label":'Permalink to "Utilities"'},"​")],-1),r=e("p",null,"There are often concepts that aren't inherent to a single feature, but rather work with joining different features together. For example, a reset clickable that activates a conversion and resets a tree, which happens to be a common use case but isn't inherent to clickables, conversions, or trees.",-1),c=e("p",null,[t("These are perfect situations for utilities, and so to encourage creators to learn to identify and take advantage of these situations, a file called "),e("code",null,"src/data/common.tsx"),t(" has been created to demo some of the more common utility functions a project might use. Adding new utilities to this file is encouraged, as is creating utils in general. It also works as a good stepping stone to creating your own features.")],-1),l=[n,r,c];function d(u,h,p,f,m,_){return s(),o("div",null,l)}const k=a(i,[["render",d]]);export{b as __pageData,k as default};
diff --git a/assets/guide_getting-started_examples.md.305530d8.js b/assets/guide_getting-started_examples.md.9aa0f345.js
similarity index 97%
rename from assets/guide_getting-started_examples.md.305530d8.js
rename to assets/guide_getting-started_examples.md.9aa0f345.js
index 1c1f082c..20d159da 100644
--- a/assets/guide_getting-started_examples.md.305530d8.js
+++ b/assets/guide_getting-started_examples.md.9aa0f345.js
@@ -1 +1 @@
-import{_ as o,c as n,x as e,a as t,C as a,o as s,D as i}from"./chunks/framework.0799945b.js";const D=JSON.parse('{"title":"Example Projects","description":"","frontmatter":{},"headers":[],"relativePath":"guide/getting-started/examples.md","lastUpdated":1681094412000}'),l={name:"guide/getting-started/examples.md"},c=e("h1",{id:"example-projects",tabindex:"-1"},[t("Example Projects "),e("a",{class:"header-anchor",href:"#example-projects","aria-label":'Permalink to "Example Projects"'},"​")],-1),d={id:"advent-incremental",tabindex:"-1"},p=e("a",{class:"header-anchor",href:"#advent-incremental","aria-label":'Permalink to "Advent Incremental "'},"​",-1),h=e("p",null,[e("a",{href:"https://github.com/thepaperpilot/advent-Incremental/",target:"_blank",rel:"noreferrer"},"View Source"),t(" | "),e("a",{href:"https://www.thepaperpilot.org/advent/",target:"_blank",rel:"noreferrer"},"View Project")],-1),m=e("p",null,[t("An incremental game with 25 different layers of content. A good example of what a large project looks like. There's also a partial port to 0.6 available "),e("a",{href:"https://github.com/thepaperpilot/advent-Incremental/tree/next",target:"_blank",rel:"noreferrer"},"here"),t(".")],-1),f={id:"primordia",tabindex:"-1"},_=e("a",{class:"header-anchor",href:"#primordia","aria-label":'Permalink to "Primordia "'},"​",-1),g=e("p",null,[e("a",{href:"https://github.com/Jacorb90/Primordial-Tree",target:"_blank",rel:"noreferrer"},"View Source"),t(" | "),e("a",{href:"https://jacorb90.me/Primordial-Tree/",target:"_blank",rel:"noreferrer"},"View Project")],-1),u=e("p",null,'A "The Prestige Tree" style incremental game, developed by the original creator of TPT.',-1),b={id:"tmt-demo",tabindex:"-1"},x=e("a",{class:"header-anchor",href:"#tmt-demo","aria-label":'Permalink to "TMT-Demo "'},"​",-1),P=e("p",null,[e("a",{href:"https://github.com/profectus-engine/tmt-demo",target:"_blank",rel:"noreferrer"},"View Source"),t(" | "),e("a",{href:"https://profectus-engine.github.io/TMT-Demo/",target:"_blank",rel:"noreferrer"},"View Project")],-1),T=e("p",null,"A project loosely based off the Demo project for TMT. Uses most of the different features of Profectus, but doesn't have any real gameplay.",-1);function k(w,v,j,y,V,B){const r=i("Badge");return s(),n("div",null,[c,e("h2",d,[t("Advent Incremental "),a(r,{type:"warning",text:"Profectus 0.5"}),t(),p]),h,m,e("h2",f,[t("Primordia "),a(r,{type:"warning",text:"Profectus 0.5"}),t(),_]),g,u,e("h2",b,[t("TMT-Demo "),a(r,{type:"tip",text:"Profectus 0.6"}),t(),x]),P,T])}const E=o(l,[["render",k]]);export{D as __pageData,E as default};
+import{_ as o,c as n,x as e,a as t,C as a,o as s,D as i}from"./chunks/framework.0799945b.js";const D=JSON.parse('{"title":"Example Projects","description":"","frontmatter":{},"headers":[],"relativePath":"guide/getting-started/examples.md","lastUpdated":1681131771000}'),l={name:"guide/getting-started/examples.md"},c=e("h1",{id:"example-projects",tabindex:"-1"},[t("Example Projects "),e("a",{class:"header-anchor",href:"#example-projects","aria-label":'Permalink to "Example Projects"'},"​")],-1),d={id:"advent-incremental",tabindex:"-1"},p=e("a",{class:"header-anchor",href:"#advent-incremental","aria-label":'Permalink to "Advent Incremental "'},"​",-1),h=e("p",null,[e("a",{href:"https://github.com/thepaperpilot/advent-Incremental/",target:"_blank",rel:"noreferrer"},"View Source"),t(" | "),e("a",{href:"https://www.thepaperpilot.org/advent/",target:"_blank",rel:"noreferrer"},"View Project")],-1),m=e("p",null,[t("An incremental game with 25 different layers of content. A good example of what a large project looks like. There's also a partial port to 0.6 available "),e("a",{href:"https://github.com/thepaperpilot/advent-Incremental/tree/next",target:"_blank",rel:"noreferrer"},"here"),t(".")],-1),f={id:"primordia",tabindex:"-1"},_=e("a",{class:"header-anchor",href:"#primordia","aria-label":'Permalink to "Primordia "'},"​",-1),g=e("p",null,[e("a",{href:"https://github.com/Jacorb90/Primordial-Tree",target:"_blank",rel:"noreferrer"},"View Source"),t(" | "),e("a",{href:"https://jacorb90.me/Primordial-Tree/",target:"_blank",rel:"noreferrer"},"View Project")],-1),u=e("p",null,'A "The Prestige Tree" style incremental game, developed by the original creator of TPT.',-1),b={id:"tmt-demo",tabindex:"-1"},x=e("a",{class:"header-anchor",href:"#tmt-demo","aria-label":'Permalink to "TMT-Demo "'},"​",-1),P=e("p",null,[e("a",{href:"https://github.com/profectus-engine/tmt-demo",target:"_blank",rel:"noreferrer"},"View Source"),t(" | "),e("a",{href:"https://profectus-engine.github.io/TMT-Demo/",target:"_blank",rel:"noreferrer"},"View Project")],-1),T=e("p",null,"A project loosely based off the Demo project for TMT. Uses most of the different features of Profectus, but doesn't have any real gameplay.",-1);function k(w,v,j,y,V,B){const r=i("Badge");return s(),n("div",null,[c,e("h2",d,[t("Advent Incremental "),a(r,{type:"warning",text:"Profectus 0.5"}),t(),p]),h,m,e("h2",f,[t("Primordia "),a(r,{type:"warning",text:"Profectus 0.5"}),t(),_]),g,u,e("h2",b,[t("TMT-Demo "),a(r,{type:"tip",text:"Profectus 0.6"}),t(),x]),P,T])}const E=o(l,[["render",k]]);export{D as __pageData,E as default};
diff --git a/assets/guide_getting-started_examples.md.305530d8.lean.js b/assets/guide_getting-started_examples.md.9aa0f345.lean.js
similarity index 97%
rename from assets/guide_getting-started_examples.md.305530d8.lean.js
rename to assets/guide_getting-started_examples.md.9aa0f345.lean.js
index 1c1f082c..20d159da 100644
--- a/assets/guide_getting-started_examples.md.305530d8.lean.js
+++ b/assets/guide_getting-started_examples.md.9aa0f345.lean.js
@@ -1 +1 @@
-import{_ as o,c as n,x as e,a as t,C as a,o as s,D as i}from"./chunks/framework.0799945b.js";const D=JSON.parse('{"title":"Example Projects","description":"","frontmatter":{},"headers":[],"relativePath":"guide/getting-started/examples.md","lastUpdated":1681094412000}'),l={name:"guide/getting-started/examples.md"},c=e("h1",{id:"example-projects",tabindex:"-1"},[t("Example Projects "),e("a",{class:"header-anchor",href:"#example-projects","aria-label":'Permalink to "Example Projects"'},"​")],-1),d={id:"advent-incremental",tabindex:"-1"},p=e("a",{class:"header-anchor",href:"#advent-incremental","aria-label":'Permalink to "Advent Incremental "'},"​",-1),h=e("p",null,[e("a",{href:"https://github.com/thepaperpilot/advent-Incremental/",target:"_blank",rel:"noreferrer"},"View Source"),t(" | "),e("a",{href:"https://www.thepaperpilot.org/advent/",target:"_blank",rel:"noreferrer"},"View Project")],-1),m=e("p",null,[t("An incremental game with 25 different layers of content. A good example of what a large project looks like. There's also a partial port to 0.6 available "),e("a",{href:"https://github.com/thepaperpilot/advent-Incremental/tree/next",target:"_blank",rel:"noreferrer"},"here"),t(".")],-1),f={id:"primordia",tabindex:"-1"},_=e("a",{class:"header-anchor",href:"#primordia","aria-label":'Permalink to "Primordia "'},"​",-1),g=e("p",null,[e("a",{href:"https://github.com/Jacorb90/Primordial-Tree",target:"_blank",rel:"noreferrer"},"View Source"),t(" | "),e("a",{href:"https://jacorb90.me/Primordial-Tree/",target:"_blank",rel:"noreferrer"},"View Project")],-1),u=e("p",null,'A "The Prestige Tree" style incremental game, developed by the original creator of TPT.',-1),b={id:"tmt-demo",tabindex:"-1"},x=e("a",{class:"header-anchor",href:"#tmt-demo","aria-label":'Permalink to "TMT-Demo "'},"​",-1),P=e("p",null,[e("a",{href:"https://github.com/profectus-engine/tmt-demo",target:"_blank",rel:"noreferrer"},"View Source"),t(" | "),e("a",{href:"https://profectus-engine.github.io/TMT-Demo/",target:"_blank",rel:"noreferrer"},"View Project")],-1),T=e("p",null,"A project loosely based off the Demo project for TMT. Uses most of the different features of Profectus, but doesn't have any real gameplay.",-1);function k(w,v,j,y,V,B){const r=i("Badge");return s(),n("div",null,[c,e("h2",d,[t("Advent Incremental "),a(r,{type:"warning",text:"Profectus 0.5"}),t(),p]),h,m,e("h2",f,[t("Primordia "),a(r,{type:"warning",text:"Profectus 0.5"}),t(),_]),g,u,e("h2",b,[t("TMT-Demo "),a(r,{type:"tip",text:"Profectus 0.6"}),t(),x]),P,T])}const E=o(l,[["render",k]]);export{D as __pageData,E as default};
+import{_ as o,c as n,x as e,a as t,C as a,o as s,D as i}from"./chunks/framework.0799945b.js";const D=JSON.parse('{"title":"Example Projects","description":"","frontmatter":{},"headers":[],"relativePath":"guide/getting-started/examples.md","lastUpdated":1681131771000}'),l={name:"guide/getting-started/examples.md"},c=e("h1",{id:"example-projects",tabindex:"-1"},[t("Example Projects "),e("a",{class:"header-anchor",href:"#example-projects","aria-label":'Permalink to "Example Projects"'},"​")],-1),d={id:"advent-incremental",tabindex:"-1"},p=e("a",{class:"header-anchor",href:"#advent-incremental","aria-label":'Permalink to "Advent Incremental "'},"​",-1),h=e("p",null,[e("a",{href:"https://github.com/thepaperpilot/advent-Incremental/",target:"_blank",rel:"noreferrer"},"View Source"),t(" | "),e("a",{href:"https://www.thepaperpilot.org/advent/",target:"_blank",rel:"noreferrer"},"View Project")],-1),m=e("p",null,[t("An incremental game with 25 different layers of content. A good example of what a large project looks like. There's also a partial port to 0.6 available "),e("a",{href:"https://github.com/thepaperpilot/advent-Incremental/tree/next",target:"_blank",rel:"noreferrer"},"here"),t(".")],-1),f={id:"primordia",tabindex:"-1"},_=e("a",{class:"header-anchor",href:"#primordia","aria-label":'Permalink to "Primordia "'},"​",-1),g=e("p",null,[e("a",{href:"https://github.com/Jacorb90/Primordial-Tree",target:"_blank",rel:"noreferrer"},"View Source"),t(" | "),e("a",{href:"https://jacorb90.me/Primordial-Tree/",target:"_blank",rel:"noreferrer"},"View Project")],-1),u=e("p",null,'A "The Prestige Tree" style incremental game, developed by the original creator of TPT.',-1),b={id:"tmt-demo",tabindex:"-1"},x=e("a",{class:"header-anchor",href:"#tmt-demo","aria-label":'Permalink to "TMT-Demo "'},"​",-1),P=e("p",null,[e("a",{href:"https://github.com/profectus-engine/tmt-demo",target:"_blank",rel:"noreferrer"},"View Source"),t(" | "),e("a",{href:"https://profectus-engine.github.io/TMT-Demo/",target:"_blank",rel:"noreferrer"},"View Project")],-1),T=e("p",null,"A project loosely based off the Demo project for TMT. Uses most of the different features of Profectus, but doesn't have any real gameplay.",-1);function k(w,v,j,y,V,B){const r=i("Badge");return s(),n("div",null,[c,e("h2",d,[t("Advent Incremental "),a(r,{type:"warning",text:"Profectus 0.5"}),t(),p]),h,m,e("h2",f,[t("Primordia "),a(r,{type:"warning",text:"Profectus 0.5"}),t(),_]),g,u,e("h2",b,[t("TMT-Demo "),a(r,{type:"tip",text:"Profectus 0.6"}),t(),x]),P,T])}const E=o(l,[["render",k]]);export{D as __pageData,E as default};
diff --git a/assets/guide_getting-started_setup.md.036f5e9e.js b/assets/guide_getting-started_setup.md.b8a9be2d.js
similarity index 99%
rename from assets/guide_getting-started_setup.md.036f5e9e.js
rename to assets/guide_getting-started_setup.md.b8a9be2d.js
index 4962e926..5bb24b87 100644
--- a/assets/guide_getting-started_setup.md.036f5e9e.js
+++ b/assets/guide_getting-started_setup.md.b8a9be2d.js
@@ -1 +1 @@
-import{_ as e,c as t,o,N as a}from"./chunks/framework.0799945b.js";const r="/assets/workflow-perms.afbb596c.png",i="/assets/actionsbutton.f1ba9d8e.png",n="/assets/gh-pages.a24cefcf.png",y=JSON.parse('{"title":"Setting Up","description":"","frontmatter":{},"headers":[],"relativePath":"guide/getting-started/setup.md","lastUpdated":1681094412000}'),s={name:"guide/getting-started/setup.md"},l=a('
Setting Up ​
Profectus requires a Node.js development environment for working on a project. If you are comfortable with the command line, a local development environment is recommended.
Local Development ​
For local development, you will need the following tools:
Create a new project from the Profectus repository by clicking the "Use this template" button. Then, clone the repository locally using the provided link.
INFO
The template repository allows easy creation of multiple projects from one repository. However, updating an existing project to a newer version of Profectus can be challenging. Consider updating Profectus before starting development to avoid issues with unrelated histories.
It's recommended to create a new Git branch for development, allowing you to push changes without affecting the live build. The GitHub workflow will automatically rebuild the page when you push to the main branch.
Next, install Profectus' dependencies by running npm install. Run npm run serve to start a local server hosting your project. The site will automatically reload as you modify files.
Also, follow the steps to update Profectus before starting to make future updates easier without worrying about unrelated histories.
Deploying ​
Using Git, the repository's workflow action automates deployment. However, you need to grant write permissions for the action in the repository settings. Go to Actions, General, Workflow permissions, and select "Read and write permissions".
workflow permissions
To deploy, push changes to the main branch. The site will be updated automatically in a few minutes. Check progress or errors from the Actions tab on your repository.
actions button
Enable GitHub Pages in the repo settings to host the generated site. Select the gh-pages branch. Perform this step once. This will automatically start another GitHub action to deploy the website.
github pages
Upon action completion, your project should be available at https://<YOUR_GITHUB_USERNAME>.github.io/<YOUR_REPO_NAME>/. For example, the TMT Demo project hosted at https://github.com/profectus-engine/TMT-Demo is available at https://profectus-engine.github.io/TMT-Demo/.
Visual Studio Code Setup ​
If you don't have a preferred IDE, Profectus is developed in Visual Studio Code and is known to work well with it.
Recommendations:
  • Use Take Over Mode for proper type analysis
  • Turn off .value autocomplete by running the Preferences: Open Settings command and setting volar.autoCompleteRefs to false
  • Install the Vitest VS Code extension for running and debugging unit tests (if working on the engine itself)
Replit ​
As an alternative to local development, you may use Replit. Replit sets up your development and hosts your project.
On the free plan, you'll face limitations, and the program may need occasional startups.
To create a Profectus project on Replit, all you have to do is click this button:
Run on Repl.it
Click the "Run" button at the top of the screen to start development. This will also make the project publicly accessible, essentially auto-deploying it. However, this means you cannot separate your development and production environments.
Glitch ​
Glitch is a site similar to Replit, with many of the same pros and cons. To create a Profectus project on Glitch, select "New Project", "Import from GitHub", and enter profectus-engine/Profectus. The new project will be automatically configured and ready to go.
',30),p=[l];function c(u,h,d,m,f,g){return o(),t("div",null,p)}const _=e(s,[["render",c]]);export{y as __pageData,_ as default};
+import{_ as e,c as t,o,N as a}from"./chunks/framework.0799945b.js";const r="/assets/workflow-perms.afbb596c.png",i="/assets/actionsbutton.f1ba9d8e.png",n="/assets/gh-pages.a24cefcf.png",y=JSON.parse('{"title":"Setting Up","description":"","frontmatter":{},"headers":[],"relativePath":"guide/getting-started/setup.md","lastUpdated":1681131771000}'),s={name:"guide/getting-started/setup.md"},l=a('
Setting Up ​
Profectus requires a Node.js development environment for working on a project. If you are comfortable with the command line, a local development environment is recommended.
Local Development ​
For local development, you will need the following tools:
Create a new project from the Profectus repository by clicking the "Use this template" button. Then, clone the repository locally using the provided link.
INFO
The template repository allows easy creation of multiple projects from one repository. However, updating an existing project to a newer version of Profectus can be challenging. Consider updating Profectus before starting development to avoid issues with unrelated histories.
It's recommended to create a new Git branch for development, allowing you to push changes without affecting the live build. The GitHub workflow will automatically rebuild the page when you push to the main branch.
Next, install Profectus' dependencies by running npm install. Run npm run serve to start a local server hosting your project. The site will automatically reload as you modify files.
Also, follow the steps to update Profectus before starting to make future updates easier without worrying about unrelated histories.
Deploying ​
Using Git, the repository's workflow action automates deployment. However, you need to grant write permissions for the action in the repository settings. Go to Actions, General, Workflow permissions, and select "Read and write permissions".
workflow permissions
To deploy, push changes to the main branch. The site will be updated automatically in a few minutes. Check progress or errors from the Actions tab on your repository.
actions button
Enable GitHub Pages in the repo settings to host the generated site. Select the gh-pages branch. Perform this step once. This will automatically start another GitHub action to deploy the website.
github pages
Upon action completion, your project should be available at https://<YOUR_GITHUB_USERNAME>.github.io/<YOUR_REPO_NAME>/. For example, the TMT Demo project hosted at https://github.com/profectus-engine/TMT-Demo is available at https://profectus-engine.github.io/TMT-Demo/.
Visual Studio Code Setup ​
If you don't have a preferred IDE, Profectus is developed in Visual Studio Code and is known to work well with it.
Recommendations:
  • Use Take Over Mode for proper type analysis
  • Turn off .value autocomplete by running the Preferences: Open Settings command and setting volar.autoCompleteRefs to false
  • Install the Vitest VS Code extension for running and debugging unit tests (if working on the engine itself)
Replit ​
As an alternative to local development, you may use Replit. Replit sets up your development and hosts your project.
On the free plan, you'll face limitations, and the program may need occasional startups.
To create a Profectus project on Replit, all you have to do is click this button:
Run on Repl.it
Click the "Run" button at the top of the screen to start development. This will also make the project publicly accessible, essentially auto-deploying it. However, this means you cannot separate your development and production environments.
Glitch ​
Glitch is a site similar to Replit, with many of the same pros and cons. To create a Profectus project on Glitch, select "New Project", "Import from GitHub", and enter profectus-engine/Profectus. The new project will be automatically configured and ready to go.
',30),p=[l];function c(u,h,d,m,f,g){return o(),t("div",null,p)}const _=e(s,[["render",c]]);export{y as __pageData,_ as default};
diff --git a/assets/guide_getting-started_setup.md.036f5e9e.lean.js b/assets/guide_getting-started_setup.md.b8a9be2d.lean.js
similarity index 87%
rename from assets/guide_getting-started_setup.md.036f5e9e.lean.js
rename to assets/guide_getting-started_setup.md.b8a9be2d.lean.js
index 813403c4..7afb995e 100644
--- a/assets/guide_getting-started_setup.md.036f5e9e.lean.js
+++ b/assets/guide_getting-started_setup.md.b8a9be2d.lean.js
@@ -1 +1 @@
-import{_ as e,c as t,o,N as a}from"./chunks/framework.0799945b.js";const r="/assets/workflow-perms.afbb596c.png",i="/assets/actionsbutton.f1ba9d8e.png",n="/assets/gh-pages.a24cefcf.png",y=JSON.parse('{"title":"Setting Up","description":"","frontmatter":{},"headers":[],"relativePath":"guide/getting-started/setup.md","lastUpdated":1681094412000}'),s={name:"guide/getting-started/setup.md"},l=a("",30),p=[l];function c(u,h,d,m,f,g){return o(),t("div",null,p)}const _=e(s,[["render",c]]);export{y as __pageData,_ as default};
+import{_ as e,c as t,o,N as a}from"./chunks/framework.0799945b.js";const r="/assets/workflow-perms.afbb596c.png",i="/assets/actionsbutton.f1ba9d8e.png",n="/assets/gh-pages.a24cefcf.png",y=JSON.parse('{"title":"Setting Up","description":"","frontmatter":{},"headers":[],"relativePath":"guide/getting-started/setup.md","lastUpdated":1681131771000}'),s={name:"guide/getting-started/setup.md"},l=a("",30),p=[l];function c(u,h,d,m,f,g){return o(),t("div",null,p)}const _=e(s,[["render",c]]);export{y as __pageData,_ as default};
diff --git a/assets/guide_getting-started_updating.md.6193ab7a.js b/assets/guide_getting-started_updating.md.0e2b10bd.js
similarity index 98%
rename from assets/guide_getting-started_updating.md.6193ab7a.js
rename to assets/guide_getting-started_updating.md.0e2b10bd.js
index 82a9374a..014acb4d 100644
--- a/assets/guide_getting-started_updating.md.6193ab7a.js
+++ b/assets/guide_getting-started_updating.md.0e2b10bd.js
@@ -1,3 +1,3 @@
-import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const g=JSON.parse('{"title":"Updating Profectus","description":"","frontmatter":{},"headers":[],"relativePath":"guide/getting-started/updating.md","lastUpdated":1681094412000}'),s={name:"guide/getting-started/updating.md"},n=o(`
Updating Profectus ​
Github ​
Due to Profectus being a template repository, your projects do not share a git history with Profectus. In order to update changes, you will need to run the following:
bash
git remote add template https://github.com/profectus-engine/Profectus
+import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const g=JSON.parse('{"title":"Updating Profectus","description":"","frontmatter":{},"headers":[],"relativePath":"guide/getting-started/updating.md","lastUpdated":1681131771000}'),s={name:"guide/getting-started/updating.md"},n=o(`
Updating Profectus ​
Github ​
Due to Profectus being a template repository, your projects do not share a git history with Profectus. In order to update changes, you will need to run the following:
bash
git remote add template https://github.com/profectus-engine/Profectus
 git fetch --all
 git merge template/main --allow-unrelated-histories
The first command only has to be performed once. The third command may require you to merge conflicts between code both you and Profectus have changed - however, due to the modularity of Profectus, this should be fairly rare. Unfortunately, due to the unrelated histories the first time you do this every change will be marked as a conflict, and you'll need to accept each one.
Replit ​
The sidebar has a tab labelled "Version Control", which you can use to merge all changes made to Profectus into your project. Unfortunately, replit does not have a merge tool so this process may irrecoverably erase changes you've made - I'd recommend making a backup first.
Glitch ​
Unfortunately glitch does not provide any method by which to update a project from a github repository. If you've only changed things in the data folder you may consider creating a new project, importing the current version of Profectus, and then placing your data folder in the new project.
`,9),r=[n];function l(i,c,p,d,h,u){return a(),t("div",null,r)}const m=e(s,[["render",l]]);export{g as __pageData,m as default};
diff --git a/assets/guide_getting-started_updating.md.6193ab7a.lean.js b/assets/guide_getting-started_updating.md.0e2b10bd.lean.js
similarity index 85%
rename from assets/guide_getting-started_updating.md.6193ab7a.lean.js
rename to assets/guide_getting-started_updating.md.0e2b10bd.lean.js
index 6ac5b16c..2457adf8 100644
--- a/assets/guide_getting-started_updating.md.6193ab7a.lean.js
+++ b/assets/guide_getting-started_updating.md.0e2b10bd.lean.js
@@ -1 +1 @@
-import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const g=JSON.parse('{"title":"Updating Profectus","description":"","frontmatter":{},"headers":[],"relativePath":"guide/getting-started/updating.md","lastUpdated":1681094412000}'),s={name:"guide/getting-started/updating.md"},n=o("",9),r=[n];function l(i,c,p,d,h,u){return a(),t("div",null,r)}const m=e(s,[["render",l]]);export{g as __pageData,m as default};
+import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const g=JSON.parse('{"title":"Updating Profectus","description":"","frontmatter":{},"headers":[],"relativePath":"guide/getting-started/updating.md","lastUpdated":1681131771000}'),s={name:"guide/getting-started/updating.md"},n=o("",9),r=[n];function l(i,c,p,d,h,u){return a(),t("div",null,r)}const m=e(s,[["render",l]]);export{g as __pageData,m as default};
diff --git a/assets/guide_important-concepts_coercable.md.025d8a15.js b/assets/guide_important-concepts_coercable.md.d6377a4d.js
similarity index 99%
rename from assets/guide_important-concepts_coercable.md.025d8a15.js
rename to assets/guide_important-concepts_coercable.md.d6377a4d.js
index 7353989d..32227dbd 100644
--- a/assets/guide_important-concepts_coercable.md.025d8a15.js
+++ b/assets/guide_important-concepts_coercable.md.d6377a4d.js
@@ -1,4 +1,4 @@
-import{_ as e,c as a,o as s,N as n}from"./chunks/framework.0799945b.js";const h=JSON.parse('{"title":"Coercable Components","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/coercable.md","lastUpdated":1681094412000}'),o={name:"guide/important-concepts/coercable.md"},t=n(`
Coercable Components ​
Most times a feature has some sort of dynamic display, it'll allow you to pass a "Coercable Component", or rather, something that can be coerced into a Vue component. This page goes over the different types of values you can use
Template Strings ​
If you provide a string, it will be wrapped in a component using it as the template. This is the simplest method, although not suitable for complex displays, and realistically cannot use Vue components as none are registered globally (by default). Recommended for static or simple dynamic displays, such as displays on features.
Template strings need to be wrapped in some HTML element. By default, they'll be wrapped in a <span> element, although certain features may wrap things in div or header elements instead, as appropriate.
Render Functions (JSX) ​
You can provide a render function and it will be wrapped in a component as well. The intended use for this is to write JSX inside a function, which will get automatically converted into a render function. You can read more about that process on the Vue docs on Render Functions & JSX. Note that JSX must be returned in a function - it does not work "standalone". The CoercableComponent type will enforce this for you.
JSX can use imported components, making this suited for writing the display properties on things like Tabs or Layers. There are also built-in functions to render features (either as their own or in a layout via renderRow and renderCol), so you don't need to import the Vue component for every feature you plan on using.
Typically a feature will accept a Computable<CoercableComponent>, which means functions would (normally) be wrapped in a computed (see Computable for more details). This would break render functions, so when passing a render function as a CoercableComponent it must be specially marked that it shouldn't be cached. You can use the built-in jsx function to mark a function for you.
Example ​
ts
{
+import{_ as e,c as a,o as s,N as n}from"./chunks/framework.0799945b.js";const h=JSON.parse('{"title":"Coercable Components","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/coercable.md","lastUpdated":1681131771000}'),o={name:"guide/important-concepts/coercable.md"},t=n(`
Coercable Components ​
Most times a feature has some sort of dynamic display, it'll allow you to pass a "Coercable Component", or rather, something that can be coerced into a Vue component. This page goes over the different types of values you can use
Template Strings ​
If you provide a string, it will be wrapped in a component using it as the template. This is the simplest method, although not suitable for complex displays, and realistically cannot use Vue components as none are registered globally (by default). Recommended for static or simple dynamic displays, such as displays on features.
Template strings need to be wrapped in some HTML element. By default, they'll be wrapped in a <span> element, although certain features may wrap things in div or header elements instead, as appropriate.
Render Functions (JSX) ​
You can provide a render function and it will be wrapped in a component as well. The intended use for this is to write JSX inside a function, which will get automatically converted into a render function. You can read more about that process on the Vue docs on Render Functions & JSX. Note that JSX must be returned in a function - it does not work "standalone". The CoercableComponent type will enforce this for you.
JSX can use imported components, making this suited for writing the display properties on things like Tabs or Layers. There are also built-in functions to render features (either as their own or in a layout via renderRow and renderCol), so you don't need to import the Vue component for every feature you plan on using.
Typically a feature will accept a Computable<CoercableComponent>, which means functions would (normally) be wrapped in a computed (see Computable for more details). This would break render functions, so when passing a render function as a CoercableComponent it must be specially marked that it shouldn't be cached. You can use the built-in jsx function to mark a function for you.
Example ​
ts
{
 	display: jsx(() => (
         <>
             <MainDisplay resource={points} color={color} />
diff --git a/assets/guide_important-concepts_coercable.md.025d8a15.lean.js b/assets/guide_important-concepts_coercable.md.d6377a4d.lean.js
similarity index 85%
rename from assets/guide_important-concepts_coercable.md.025d8a15.lean.js
rename to assets/guide_important-concepts_coercable.md.d6377a4d.lean.js
index 8feec1d7..fed1c818 100644
--- a/assets/guide_important-concepts_coercable.md.025d8a15.lean.js
+++ b/assets/guide_important-concepts_coercable.md.d6377a4d.lean.js
@@ -1 +1 @@
-import{_ as e,c as a,o as s,N as n}from"./chunks/framework.0799945b.js";const h=JSON.parse('{"title":"Coercable Components","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/coercable.md","lastUpdated":1681094412000}'),o={name:"guide/important-concepts/coercable.md"},t=n("",13),l=[t];function p(r,c,i,d,u,y){return s(),a("div",null,l)}const F=e(o,[["render",p]]);export{h as __pageData,F as default};
+import{_ as e,c as a,o as s,N as n}from"./chunks/framework.0799945b.js";const h=JSON.parse('{"title":"Coercable Components","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/coercable.md","lastUpdated":1681131771000}'),o={name:"guide/important-concepts/coercable.md"},t=n("",13),l=[t];function p(r,c,i,d,u,y){return s(),a("div",null,l)}const F=e(o,[["render",p]]);export{h as __pageData,F as default};
diff --git a/assets/guide_important-concepts_features.md.1957772b.js b/assets/guide_important-concepts_features.md.09bfe05c.js
similarity index 99%
rename from assets/guide_important-concepts_features.md.1957772b.js
rename to assets/guide_important-concepts_features.md.09bfe05c.js
index cc1ec226..7cfbf651 100644
--- a/assets/guide_important-concepts_features.md.1957772b.js
+++ b/assets/guide_important-concepts_features.md.09bfe05c.js
@@ -1,4 +1,4 @@
-import{_ as e,c as s,o as a,N as n}from"./chunks/framework.0799945b.js";const D=JSON.parse('{"title":"Features","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/features.md","lastUpdated":1681094412000}'),t={name:"guide/important-concepts/features.md"},o=n(`
Features ​
A layer is made up of features. There are many types of features included in Profectus, and more can be created once you become familiar with the engine.
To create a feature, the feature type will have one or more functions to help you. They'll typically look something like this:
ts
const addGainUpgrade = createUpgrade(() => ({
+import{_ as e,c as s,o as a,N as n}from"./chunks/framework.0799945b.js";const D=JSON.parse('{"title":"Features","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/features.md","lastUpdated":1681131771000}'),t={name:"guide/important-concepts/features.md"},o=n(`
Features ​
A layer is made up of features. There are many types of features included in Profectus, and more can be created once you become familiar with the engine.
To create a feature, the feature type will have one or more functions to help you. They'll typically look something like this:
ts
const addGainUpgrade = createUpgrade(() => ({
     display: {
         title: "Generator of Genericness",
         description: "Gain 1 point every second"
diff --git a/assets/guide_important-concepts_features.md.1957772b.lean.js b/assets/guide_important-concepts_features.md.09bfe05c.lean.js
similarity index 84%
rename from assets/guide_important-concepts_features.md.1957772b.lean.js
rename to assets/guide_important-concepts_features.md.09bfe05c.lean.js
index a6d47772..7fd49de1 100644
--- a/assets/guide_important-concepts_features.md.1957772b.lean.js
+++ b/assets/guide_important-concepts_features.md.09bfe05c.lean.js
@@ -1 +1 @@
-import{_ as e,c as s,o as a,N as n}from"./chunks/framework.0799945b.js";const D=JSON.parse('{"title":"Features","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/features.md","lastUpdated":1681094412000}'),t={name:"guide/important-concepts/features.md"},o=n("",12),l=[o];function p(r,c,i,y,d,u){return a(),s("div",null,l)}const C=e(t,[["render",p]]);export{D as __pageData,C as default};
+import{_ as e,c as s,o as a,N as n}from"./chunks/framework.0799945b.js";const D=JSON.parse('{"title":"Features","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/features.md","lastUpdated":1681131771000}'),t={name:"guide/important-concepts/features.md"},o=n("",12),l=[o];function p(r,c,i,y,d,u){return a(),s("div",null,l)}const C=e(t,[["render",p]]);export{D as __pageData,C as default};
diff --git a/assets/guide_important-concepts_formulas.md.592f0311.js b/assets/guide_important-concepts_formulas.md.92a97105.js
similarity index 99%
rename from assets/guide_important-concepts_formulas.md.592f0311.js
rename to assets/guide_important-concepts_formulas.md.92a97105.js
index d95aaa20..496dea69 100644
--- a/assets/guide_important-concepts_formulas.md.592f0311.js
+++ b/assets/guide_important-concepts_formulas.md.92a97105.js
@@ -1,4 +1,4 @@
-import{_ as e,c as a,o as s,N as o}from"./chunks/framework.0799945b.js";const y=JSON.parse('{"title":"Formulas","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/formulas.md","lastUpdated":1681094412000}'),n={name:"guide/important-concepts/formulas.md"},t=o(`
Formulas ​
Profectus utilizes formulas for various features, such as increasing requirements for repeatables and challenges or determining resource gains in conversions. These formulas often need to be inverted or integrated to enable features like buying multiple levels of a repeatable at once or determining when a conversion will increase resource gains. The Formula class can handle these operations, supporting every function Decimal does, while tracking the operations internally.
For example, a cost function like Decimal.pow(this.amount, 1.05).times(100) can be represented using a Formula: Formula.variable(this.amount).pow(1.05).times(100).
ts
const myRepeatable = createRepeatable(function (this: GenericRepeatable) {
+import{_ as e,c as a,o as s,N as o}from"./chunks/framework.0799945b.js";const y=JSON.parse('{"title":"Formulas","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/formulas.md","lastUpdated":1681131771000}'),n={name:"guide/important-concepts/formulas.md"},t=o(`
Formulas ​
Profectus utilizes formulas for various features, such as increasing requirements for repeatables and challenges or determining resource gains in conversions. These formulas often need to be inverted or integrated to enable features like buying multiple levels of a repeatable at once or determining when a conversion will increase resource gains. The Formula class can handle these operations, supporting every function Decimal does, while tracking the operations internally.
For example, a cost function like Decimal.pow(this.amount, 1.05).times(100) can be represented using a Formula: Formula.variable(this.amount).pow(1.05).times(100).
ts
const myRepeatable = createRepeatable(function (this: GenericRepeatable) {
     return {
         requirements: createCostRequirement(() => ({
             resource: points,
diff --git a/assets/guide_important-concepts_formulas.md.592f0311.lean.js b/assets/guide_important-concepts_formulas.md.92a97105.lean.js
similarity index 84%
rename from assets/guide_important-concepts_formulas.md.592f0311.lean.js
rename to assets/guide_important-concepts_formulas.md.92a97105.lean.js
index 1e4fd02a..83797c5e 100644
--- a/assets/guide_important-concepts_formulas.md.592f0311.lean.js
+++ b/assets/guide_important-concepts_formulas.md.92a97105.lean.js
@@ -1 +1 @@
-import{_ as e,c as a,o as s,N as o}from"./chunks/framework.0799945b.js";const y=JSON.parse('{"title":"Formulas","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/formulas.md","lastUpdated":1681094412000}'),n={name:"guide/important-concepts/formulas.md"},t=o("",18),r=[t];function l(i,p,c,u,h,m){return s(),a("div",null,r)}const F=e(n,[["render",l]]);export{y as __pageData,F as default};
+import{_ as e,c as a,o as s,N as o}from"./chunks/framework.0799945b.js";const y=JSON.parse('{"title":"Formulas","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/formulas.md","lastUpdated":1681131771000}'),n={name:"guide/important-concepts/formulas.md"},t=o("",18),r=[t];function l(i,p,c,u,h,m){return s(),a("div",null,r)}const F=e(n,[["render",l]]);export{y as __pageData,F as default};
diff --git a/assets/guide_important-concepts_layers.md.12789b41.js b/assets/guide_important-concepts_layers.md.5ce0f121.js
similarity index 96%
rename from assets/guide_important-concepts_layers.md.12789b41.js
rename to assets/guide_important-concepts_layers.md.5ce0f121.js
index bffc00a5..bb0d6c9f 100644
--- a/assets/guide_important-concepts_layers.md.12789b41.js
+++ b/assets/guide_important-concepts_layers.md.5ce0f121.js
@@ -1 +1 @@
-import{_ as e,c as a,o as t,N as r}from"./chunks/framework.0799945b.js";const f=JSON.parse('{"title":"Layers","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/layers.md","lastUpdated":1681094412000}'),o={name:"guide/important-concepts/layers.md"},s=r('
Layers ​
Profectus content is organized into units called "Layers". When displaying content to the user, the screen will be divided into several tabs that each display the content of a layer. These layers are stored in /src/data/layers.
Each layer is ultimately a collection of different features, and a display function. While there are a couple reserved properties for layers, most of its structure is fully up to the creator.
Layers can be dynamically added or removed at any time, which also allows for effectively disabling or enabling content based on arbitrary conditions. Just make sure getInitialLayers can process the player save data object and determine which layers should be currently active.
Lazy Proxies ​
Layers (and features) are not actually created immediately. Instead, their options are gotten through a function which is then run the first time something inside the layer is accessed. This is a concept called lazy evaluation, which is also used for things like computed, and allows for features to reference each other without worrying about cyclical dependencies.
',6),i=[s];function n(c,l,d,h,y,p){return t(),a("div",null,i)}const _=e(o,[["render",n]]);export{f as __pageData,_ as default};
+import{_ as e,c as a,o as t,N as r}from"./chunks/framework.0799945b.js";const f=JSON.parse('{"title":"Layers","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/layers.md","lastUpdated":1681131771000}'),o={name:"guide/important-concepts/layers.md"},s=r('
Layers ​
Profectus content is organized into units called "Layers". When displaying content to the user, the screen will be divided into several tabs that each display the content of a layer. These layers are stored in /src/data/layers.
Each layer is ultimately a collection of different features, and a display function. While there are a couple reserved properties for layers, most of its structure is fully up to the creator.
Layers can be dynamically added or removed at any time, which also allows for effectively disabling or enabling content based on arbitrary conditions. Just make sure getInitialLayers can process the player save data object and determine which layers should be currently active.
Lazy Proxies ​
Layers (and features) are not actually created immediately. Instead, their options are gotten through a function which is then run the first time something inside the layer is accessed. This is a concept called lazy evaluation, which is also used for things like computed, and allows for features to reference each other without worrying about cyclical dependencies.
',6),i=[s];function n(c,l,d,h,y,p){return t(),a("div",null,i)}const _=e(o,[["render",n]]);export{f as __pageData,_ as default};
diff --git a/assets/guide_important-concepts_layers.md.12789b41.lean.js b/assets/guide_important-concepts_layers.md.5ce0f121.lean.js
similarity index 84%
rename from assets/guide_important-concepts_layers.md.12789b41.lean.js
rename to assets/guide_important-concepts_layers.md.5ce0f121.lean.js
index 8316db11..baca370a 100644
--- a/assets/guide_important-concepts_layers.md.12789b41.lean.js
+++ b/assets/guide_important-concepts_layers.md.5ce0f121.lean.js
@@ -1 +1 @@
-import{_ as e,c as a,o as t,N as r}from"./chunks/framework.0799945b.js";const f=JSON.parse('{"title":"Layers","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/layers.md","lastUpdated":1681094412000}'),o={name:"guide/important-concepts/layers.md"},s=r("",6),i=[s];function n(c,l,d,h,y,p){return t(),a("div",null,i)}const _=e(o,[["render",n]]);export{f as __pageData,_ as default};
+import{_ as e,c as a,o as t,N as r}from"./chunks/framework.0799945b.js";const f=JSON.parse('{"title":"Layers","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/layers.md","lastUpdated":1681131771000}'),o={name:"guide/important-concepts/layers.md"},s=r("",6),i=[s];function n(c,l,d,h,y,p){return t(),a("div",null,i)}const _=e(o,[["render",n]]);export{f as __pageData,_ as default};
diff --git a/assets/guide_important-concepts_persistence.md.e64f98b0.js b/assets/guide_important-concepts_persistence.md.5574dcf4.js
similarity index 97%
rename from assets/guide_important-concepts_persistence.md.e64f98b0.js
rename to assets/guide_important-concepts_persistence.md.5574dcf4.js
index 7ed44288..6e89619b 100644
--- a/assets/guide_important-concepts_persistence.md.e64f98b0.js
+++ b/assets/guide_important-concepts_persistence.md.5574dcf4.js
@@ -1 +1 @@
-import{_ as e,c as t,o as a,N as s}from"./chunks/framework.0799945b.js";const m=JSON.parse('{"title":"Persistence","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/persistence.md","lastUpdated":1681094412000}'),r={name:"guide/important-concepts/persistence.md"},n=s('
Persistence ​
Persistence refers to data that is saved, so that it persists when the user closes the tab and opens it again in the future.
In Profectus, this is handled by creating "persistent refs", which act like refs but whose value is stored in an object that gets saved to localStorage. Other than that you can treat them like any other ref - when adding the layer, any persistent refs will automatically have their values updated to the ones saved in localStorage. If there isn't a saved value, it'll use the default value passed to the persistent ref constructor.
Many features in Profectus, such as upgrades, milestones, and challenges, internally have persistent refs to save things like whether the upgrade has been purchased, the milestone achieved, or the challenge completed. Creators can also create their own custom persistent refs to store any arbitrary (but serializable) data they need - that means Numbers (including big numbers), strings, booleans, or objects containing only serializable values. Another notable function is the resource constructor. If you pass a default value into its contructor, it will automatically create a persistent ref for that resource. If you pass in a ref, it will NOT make the ref persistent.
It's important for saving and loading these properties for these refs to be in a well known location. This is implemented based on the location of the persistent ref within a layer. That means its important that all persistent refs are located within the object returned by the createLayer options function. If a persistent ref is not within that object, it will NOT be saved and loaded - regardless of whether its a persistent ref within a feature, one you manually created, or otherwise.
Additionally, this structure should typically remain consistent between project versions. If a value is in a new location, it will not load the value from localStorage correctly. This is exacerbated if two values swap places, such as when an array is re-ordered. In the event a creator changes this structure anyways, the fixOldSave function can be used to migrate the old player save data to the new structure expected by the current version of the project.
',6),i=[n];function o(c,l,h,d,u,p){return a(),t("div",null,i)}const y=e(r,[["render",o]]);export{m as __pageData,y as default};
+import{_ as e,c as t,o as a,N as s}from"./chunks/framework.0799945b.js";const m=JSON.parse('{"title":"Persistence","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/persistence.md","lastUpdated":1681131771000}'),r={name:"guide/important-concepts/persistence.md"},n=s('
Persistence ​
Persistence refers to data that is saved, so that it persists when the user closes the tab and opens it again in the future.
In Profectus, this is handled by creating "persistent refs", which act like refs but whose value is stored in an object that gets saved to localStorage. Other than that you can treat them like any other ref - when adding the layer, any persistent refs will automatically have their values updated to the ones saved in localStorage. If there isn't a saved value, it'll use the default value passed to the persistent ref constructor.
Many features in Profectus, such as upgrades, milestones, and challenges, internally have persistent refs to save things like whether the upgrade has been purchased, the milestone achieved, or the challenge completed. Creators can also create their own custom persistent refs to store any arbitrary (but serializable) data they need - that means Numbers (including big numbers), strings, booleans, or objects containing only serializable values. Another notable function is the resource constructor. If you pass a default value into its contructor, it will automatically create a persistent ref for that resource. If you pass in a ref, it will NOT make the ref persistent.
It's important for saving and loading these properties for these refs to be in a well known location. This is implemented based on the location of the persistent ref within a layer. That means its important that all persistent refs are located within the object returned by the createLayer options function. If a persistent ref is not within that object, it will NOT be saved and loaded - regardless of whether its a persistent ref within a feature, one you manually created, or otherwise.
Additionally, this structure should typically remain consistent between project versions. If a value is in a new location, it will not load the value from localStorage correctly. This is exacerbated if two values swap places, such as when an array is re-ordered. In the event a creator changes this structure anyways, the fixOldSave function can be used to migrate the old player save data to the new structure expected by the current version of the project.
',6),i=[n];function o(c,l,h,d,u,p){return a(),t("div",null,i)}const y=e(r,[["render",o]]);export{m as __pageData,y as default};
diff --git a/assets/guide_important-concepts_persistence.md.e64f98b0.lean.js b/assets/guide_important-concepts_persistence.md.5574dcf4.lean.js
similarity index 85%
rename from assets/guide_important-concepts_persistence.md.e64f98b0.lean.js
rename to assets/guide_important-concepts_persistence.md.5574dcf4.lean.js
index d7eb0102..addf4137 100644
--- a/assets/guide_important-concepts_persistence.md.e64f98b0.lean.js
+++ b/assets/guide_important-concepts_persistence.md.5574dcf4.lean.js
@@ -1 +1 @@
-import{_ as e,c as t,o as a,N as s}from"./chunks/framework.0799945b.js";const m=JSON.parse('{"title":"Persistence","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/persistence.md","lastUpdated":1681094412000}'),r={name:"guide/important-concepts/persistence.md"},n=s("",6),i=[n];function o(c,l,h,d,u,p){return a(),t("div",null,i)}const y=e(r,[["render",o]]);export{m as __pageData,y as default};
+import{_ as e,c as t,o as a,N as s}from"./chunks/framework.0799945b.js";const m=JSON.parse('{"title":"Persistence","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/persistence.md","lastUpdated":1681131771000}'),r={name:"guide/important-concepts/persistence.md"},n=s("",6),i=[n];function o(c,l,h,d,u,p){return a(),t("div",null,i)}const y=e(r,[["render",o]]);export{m as __pageData,y as default};
diff --git a/assets/guide_important-concepts_reactivity.md.bcec6c75.js b/assets/guide_important-concepts_reactivity.md.ef52d055.js
similarity index 97%
rename from assets/guide_important-concepts_reactivity.md.bcec6c75.js
rename to assets/guide_important-concepts_reactivity.md.ef52d055.js
index 873b331f..ba366cc7 100644
--- a/assets/guide_important-concepts_reactivity.md.bcec6c75.js
+++ b/assets/guide_important-concepts_reactivity.md.ef52d055.js
@@ -1 +1 @@
-import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const f=JSON.parse('{"title":"Reactivity","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/reactivity.md","lastUpdated":1681094412000}'),r={name:"guide/important-concepts/reactivity.md"},s=o('
Reactivity ​
Profectus takes large advantage of Vue's reactivity system. It's recommended to read up on how refs and computed refs work. Ultimately this means that sometimes you'll need to type .value to get the actual value of something, but also you are able to pass things around by reference instead of by value. Indeed, it is recommended to only unwrap the actual value when you actually need it. .value is guaranteed to be correct and up to date only on the exact moment it is accessed.
With a proper IDE, such as Visual Studio Code, you should be able to see whether or not something is a ref or not from type hints. If in doubt, you can always wrap the property in an unref call.
Vue's reactivity is probably the "quirkiest" part of Profectus, and not even the documentation makes all of those quirks clear. It is recommend to read this thread of common misconceptions around Vue reactivity.
Computable ​
Most properties on features will accept Computable values. Computable values can either be a raw value, a ref to the value, or a function that returns the value. In the lattermost case it will be wrapped in computed, turning it into a ref. The feature type will handle it being a ref or a raw value by using unref when accessing those values. With type hints, your IDE should correctly identify these values as refs or raw values so you can treat them as the types they actually are.
Because functions are automatically wrapped in computed for many properties, it might be expected to happen to custom properties you add to a feature that isn't defined by the feature type. These functions will not be wrapped, and if you want it cached you should wrap it in a computed yourself. This does, however, allow you to include custom methods on a feature without worry.
',7),i=[s];function n(c,u,d,l,p,h){return a(),t("div",null,i)}const y=e(r,[["render",n]]);export{f as __pageData,y as default};
+import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const f=JSON.parse('{"title":"Reactivity","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/reactivity.md","lastUpdated":1681131771000}'),r={name:"guide/important-concepts/reactivity.md"},s=o('
Reactivity ​
Profectus takes large advantage of Vue's reactivity system. It's recommended to read up on how refs and computed refs work. Ultimately this means that sometimes you'll need to type .value to get the actual value of something, but also you are able to pass things around by reference instead of by value. Indeed, it is recommended to only unwrap the actual value when you actually need it. .value is guaranteed to be correct and up to date only on the exact moment it is accessed.
With a proper IDE, such as Visual Studio Code, you should be able to see whether or not something is a ref or not from type hints. If in doubt, you can always wrap the property in an unref call.
Vue's reactivity is probably the "quirkiest" part of Profectus, and not even the documentation makes all of those quirks clear. It is recommend to read this thread of common misconceptions around Vue reactivity.
Computable ​
Most properties on features will accept Computable values. Computable values can either be a raw value, a ref to the value, or a function that returns the value. In the lattermost case it will be wrapped in computed, turning it into a ref. The feature type will handle it being a ref or a raw value by using unref when accessing those values. With type hints, your IDE should correctly identify these values as refs or raw values so you can treat them as the types they actually are.
Because functions are automatically wrapped in computed for many properties, it might be expected to happen to custom properties you add to a feature that isn't defined by the feature type. These functions will not be wrapped, and if you want it cached you should wrap it in a computed yourself. This does, however, allow you to include custom methods on a feature without worry.
',7),i=[s];function n(c,u,d,l,p,h){return a(),t("div",null,i)}const y=e(r,[["render",n]]);export{f as __pageData,y as default};
diff --git a/assets/guide_important-concepts_reactivity.md.bcec6c75.lean.js b/assets/guide_important-concepts_reactivity.md.ef52d055.lean.js
similarity index 85%
rename from assets/guide_important-concepts_reactivity.md.bcec6c75.lean.js
rename to assets/guide_important-concepts_reactivity.md.ef52d055.lean.js
index 953b8238..aac8d077 100644
--- a/assets/guide_important-concepts_reactivity.md.bcec6c75.lean.js
+++ b/assets/guide_important-concepts_reactivity.md.ef52d055.lean.js
@@ -1 +1 @@
-import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const f=JSON.parse('{"title":"Reactivity","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/reactivity.md","lastUpdated":1681094412000}'),r={name:"guide/important-concepts/reactivity.md"},s=o("",7),i=[s];function n(c,u,d,l,p,h){return a(),t("div",null,i)}const y=e(r,[["render",n]]);export{f as __pageData,y as default};
+import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const f=JSON.parse('{"title":"Reactivity","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/reactivity.md","lastUpdated":1681131771000}'),r={name:"guide/important-concepts/reactivity.md"},s=o("",7),i=[s];function n(c,u,d,l,p,h){return a(),t("div",null,i)}const y=e(r,[["render",n]]);export{f as __pageData,y as default};
diff --git a/assets/guide_important-concepts_requirements.md.856b4ffd.js b/assets/guide_important-concepts_requirements.md.fb6512c2.js
similarity index 98%
rename from assets/guide_important-concepts_requirements.md.856b4ffd.js
rename to assets/guide_important-concepts_requirements.md.fb6512c2.js
index e377a4d2..77f53d31 100644
--- a/assets/guide_important-concepts_requirements.md.856b4ffd.js
+++ b/assets/guide_important-concepts_requirements.md.fb6512c2.js
@@ -1 +1 @@
-import{_ as e,c as t,o as i,N as r}from"./chunks/framework.0799945b.js";const q=JSON.parse('{"title":"Requirements","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/requirements.md","lastUpdated":1681094412000}'),a={name:"guide/important-concepts/requirements.md"},n=r('
Requirements ​
The requirements system in Profectus is designed to handle various conditions that must be met before certain actions or features can be accessed by the player. These conditions can include resource amounts, completed challenges, or other milestones within the game.
Creating Requirements ​
To create a requirement, you can use one of the provided utility functions like createCostRequirement, createVisibilityRequirement, or createBooleanRequirement. These functions return a Requirement object with specific properties that define the requirement conditions.
Using Requirements ​
Several features will have a requirements property that takes one or more requirements that must be fulfilled for a certain action to be performed with that feature.
When implementing requirements, you can use the displayRequirements utility. This utility is designed to give a human-readable string generated by the requirement(s) given, making it easier for players to understand the conditions needed to progress in the game. Typically features that support requirements will already use this utility internally.
You may need to "pay" requirements upon meeting their conditions and performing the associated action. This action typically involves spending resources or making other adjustments to the game state. The payRequirements function simplifies this process by handling the payment for one or more requirements, considering the number of levels to pay for. Additionally, custom pay functions like payByDivision and payByReset can be passed into createCostRequirement for more specialized cases.
Multi-Level Requirements ​
Requirements can have multiple "levels", which are typically used for things like multi-level challenges with scaling requirements. When checking if requirements are met, the requirementsMet function can be used. It accepts a single requirement or an array of requirements.
Requirements that are just on/off, such as boolean or visibility requirements, will count as infinite levels when in the same array. This allows you to combine different types of requirements in the same array and use the maxRequirementsMet function to calculate the maximum number of levels that could be acquired with the current requirement states.
',11),s=[n];function o(u,m,l,c,h,d){return i(),t("div",null,s)}const f=e(a,[["render",o]]);export{q as __pageData,f as default};
+import{_ as e,c as t,o as i,N as r}from"./chunks/framework.0799945b.js";const q=JSON.parse('{"title":"Requirements","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/requirements.md","lastUpdated":1681131771000}'),a={name:"guide/important-concepts/requirements.md"},n=r('
Requirements ​
The requirements system in Profectus is designed to handle various conditions that must be met before certain actions or features can be accessed by the player. These conditions can include resource amounts, completed challenges, or other milestones within the game.
Creating Requirements ​
To create a requirement, you can use one of the provided utility functions like createCostRequirement, createVisibilityRequirement, or createBooleanRequirement. These functions return a Requirement object with specific properties that define the requirement conditions.
Using Requirements ​
Several features will have a requirements property that takes one or more requirements that must be fulfilled for a certain action to be performed with that feature.
When implementing requirements, you can use the displayRequirements utility. This utility is designed to give a human-readable string generated by the requirement(s) given, making it easier for players to understand the conditions needed to progress in the game. Typically features that support requirements will already use this utility internally.
You may need to "pay" requirements upon meeting their conditions and performing the associated action. This action typically involves spending resources or making other adjustments to the game state. The payRequirements function simplifies this process by handling the payment for one or more requirements, considering the number of levels to pay for. Additionally, custom pay functions like payByDivision and payByReset can be passed into createCostRequirement for more specialized cases.
Multi-Level Requirements ​
Requirements can have multiple "levels", which are typically used for things like multi-level challenges with scaling requirements. When checking if requirements are met, the requirementsMet function can be used. It accepts a single requirement or an array of requirements.
Requirements that are just on/off, such as boolean or visibility requirements, will count as infinite levels when in the same array. This allows you to combine different types of requirements in the same array and use the maxRequirementsMet function to calculate the maximum number of levels that could be acquired with the current requirement states.
',11),s=[n];function o(u,m,l,c,h,d){return i(),t("div",null,s)}const f=e(a,[["render",o]]);export{q as __pageData,f as default};
diff --git a/assets/guide_important-concepts_requirements.md.856b4ffd.lean.js b/assets/guide_important-concepts_requirements.md.fb6512c2.lean.js
similarity index 85%
rename from assets/guide_important-concepts_requirements.md.856b4ffd.lean.js
rename to assets/guide_important-concepts_requirements.md.fb6512c2.lean.js
index 4b2bd1e9..a8e8d4b7 100644
--- a/assets/guide_important-concepts_requirements.md.856b4ffd.lean.js
+++ b/assets/guide_important-concepts_requirements.md.fb6512c2.lean.js
@@ -1 +1 @@
-import{_ as e,c as t,o as i,N as r}from"./chunks/framework.0799945b.js";const q=JSON.parse('{"title":"Requirements","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/requirements.md","lastUpdated":1681094412000}'),a={name:"guide/important-concepts/requirements.md"},n=r("",11),s=[n];function o(u,m,l,c,h,d){return i(),t("div",null,s)}const f=e(a,[["render",o]]);export{q as __pageData,f as default};
+import{_ as e,c as t,o as i,N as r}from"./chunks/framework.0799945b.js";const q=JSON.parse('{"title":"Requirements","description":"","frontmatter":{},"headers":[],"relativePath":"guide/important-concepts/requirements.md","lastUpdated":1681131771000}'),a={name:"guide/important-concepts/requirements.md"},n=r("",11),s=[n];function o(u,m,l,c,h,d){return i(),t("div",null,s)}const f=e(a,[["render",o]]);export{q as __pageData,f as default};
diff --git a/assets/guide_index.md.02afca62.js b/assets/guide_index.md.463f69d1.js
similarity index 98%
rename from assets/guide_index.md.02afca62.js
rename to assets/guide_index.md.463f69d1.js
index 3743385c..36f9fd41 100644
--- a/assets/guide_index.md.02afca62.js
+++ b/assets/guide_index.md.463f69d1.js
@@ -1 +1 @@
-import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const m=JSON.parse('{"title":"Introduction","description":"","frontmatter":{"title":"Introduction"},"headers":[],"relativePath":"guide/index.md","lastUpdated":1681094412000}'),n={name:"guide/index.md"},r=o('
Introduction ​
Profectus is a web-based game engine. You can write your content using many built in features, write your own features, and build up complex gameplay quickly and easily.
The purpose of creating profectus was to create an easy to use engine that does not create a ceiling for a programmer's personal growth. This engine will grow in complexity with you, empowering you to create increasingly complex designs and mechanics.
Should you use Profectus? ​
While this engine is intended to make game development (and web app development) easier, it still requires you to be comfortable with programming in general and javascript in particular. Fortunately, that is a solvable problem.
If you've never used Javascript before, learn-js.org is a good resource for learning the important concepts. If you'd like a more thorough lesson on all the ins and outs of web development, javascript.info and MDN's tutorials should have you covered. MDN is also a great resource to use as a reference - for example, if you want to know more about something and you google it, there'll typically be a MDN link that'll explain it thoroughly.
Beyond the basics, Profectus uses a modern web development pipeline, using tools like node, typescript, and JSX. While most of it should be relatively easy to pick up through context, if this becomes too complicated you may be interested in The Modding Tree, a predecessor of Profectus that uses plain old javascript.
Alternative Engines ​
There are many popular game engines out there, such as GameMaker Studio 2, Unity3D, Unreal Engine 4, and Godot, that are all general purpose and also more useful if you're planning on going into a career in game development. These are all more mature and robust game engines compared to Profectus, and are used by actual game development studios.
Profectus, on the other hand, is a very opinionated engine that is better at specific types of projects. Where the above engines will require you to design and create your own interfaces, menus, save management systems, etc. Profectus will include those out of the box. Profectus will also output games that run natively in the browser, and will typically be easier for players to play than traditional engines.
If you are not interested in programming but still want to get into game development, the above engines also all support "visual programming", which may be more amenable to you. Each engine will have varying levels of support, and of course with varying complexities, but ultimately any of these will help you learn the concepts of programming and game development, and all of them also offer traditional programming for when you think you're ready.
Design Philosophies ​
While absolute purity is impossible, design decisions have been and will continue to be made using these principles in mind.
  • An engine should be intuitive, and code readable without context
  • An engine should not constrain a creator
  • An engine should be consistent
  • An engine should be extensible, and those extensions sharable
  • An engine should be efficient
  • An engine should report issues early and thoroughly
  • Passing by reference is one honking great idea -- let's do more of that! 
',14),i=[r];function s(l,u,h,d,p,c){return a(),t("div",null,i)}const f=e(n,[["render",s]]);export{m as __pageData,f as default};
+import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const m=JSON.parse('{"title":"Introduction","description":"","frontmatter":{"title":"Introduction"},"headers":[],"relativePath":"guide/index.md","lastUpdated":1681131771000}'),n={name:"guide/index.md"},r=o('
Introduction ​
Profectus is a web-based game engine. You can write your content using many built in features, write your own features, and build up complex gameplay quickly and easily.
The purpose of creating profectus was to create an easy to use engine that does not create a ceiling for a programmer's personal growth. This engine will grow in complexity with you, empowering you to create increasingly complex designs and mechanics.
Should you use Profectus? ​
While this engine is intended to make game development (and web app development) easier, it still requires you to be comfortable with programming in general and javascript in particular. Fortunately, that is a solvable problem.
If you've never used Javascript before, learn-js.org is a good resource for learning the important concepts. If you'd like a more thorough lesson on all the ins and outs of web development, javascript.info and MDN's tutorials should have you covered. MDN is also a great resource to use as a reference - for example, if you want to know more about something and you google it, there'll typically be a MDN link that'll explain it thoroughly.
Beyond the basics, Profectus uses a modern web development pipeline, using tools like node, typescript, and JSX. While most of it should be relatively easy to pick up through context, if this becomes too complicated you may be interested in The Modding Tree, a predecessor of Profectus that uses plain old javascript.
Alternative Engines ​
There are many popular game engines out there, such as GameMaker Studio 2, Unity3D, Unreal Engine 4, and Godot, that are all general purpose and also more useful if you're planning on going into a career in game development. These are all more mature and robust game engines compared to Profectus, and are used by actual game development studios.
Profectus, on the other hand, is a very opinionated engine that is better at specific types of projects. Where the above engines will require you to design and create your own interfaces, menus, save management systems, etc. Profectus will include those out of the box. Profectus will also output games that run natively in the browser, and will typically be easier for players to play than traditional engines.
If you are not interested in programming but still want to get into game development, the above engines also all support "visual programming", which may be more amenable to you. Each engine will have varying levels of support, and of course with varying complexities, but ultimately any of these will help you learn the concepts of programming and game development, and all of them also offer traditional programming for when you think you're ready.
Design Philosophies ​
While absolute purity is impossible, design decisions have been and will continue to be made using these principles in mind.
  • An engine should be intuitive, and code readable without context
  • An engine should not constrain a creator
  • An engine should be consistent
  • An engine should be extensible, and those extensions sharable
  • An engine should be efficient
  • An engine should report issues early and thoroughly
  • Passing by reference is one honking great idea -- let's do more of that! 
',14),i=[r];function s(l,u,h,d,p,c){return a(),t("div",null,i)}const f=e(n,[["render",s]]);export{m as __pageData,f as default};
diff --git a/assets/guide_index.md.02afca62.lean.js b/assets/guide_index.md.463f69d1.lean.js
similarity index 84%
rename from assets/guide_index.md.02afca62.lean.js
rename to assets/guide_index.md.463f69d1.lean.js
index be98a128..cd1a38f2 100644
--- a/assets/guide_index.md.02afca62.lean.js
+++ b/assets/guide_index.md.463f69d1.lean.js
@@ -1 +1 @@
-import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const m=JSON.parse('{"title":"Introduction","description":"","frontmatter":{"title":"Introduction"},"headers":[],"relativePath":"guide/index.md","lastUpdated":1681094412000}'),n={name:"guide/index.md"},r=o("",14),i=[r];function s(l,u,h,d,p,c){return a(),t("div",null,i)}const f=e(n,[["render",s]]);export{m as __pageData,f as default};
+import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const m=JSON.parse('{"title":"Introduction","description":"","frontmatter":{"title":"Introduction"},"headers":[],"relativePath":"guide/index.md","lastUpdated":1681131771000}'),n={name:"guide/index.md"},r=o("",14),i=[r];function s(l,u,h,d,p,c){return a(),t("div",null,i)}const f=e(n,[["render",s]]);export{m as __pageData,f as default};
diff --git a/assets/guide_recipes_particles.md.30664cc1.js b/assets/guide_recipes_particles.md.d4df0645.js
similarity index 79%
rename from assets/guide_recipes_particles.md.30664cc1.js
rename to assets/guide_recipes_particles.md.d4df0645.js
index 2568239e..b4386114 100644
--- a/assets/guide_recipes_particles.md.30664cc1.js
+++ b/assets/guide_recipes_particles.md.d4df0645.js
@@ -1,14 +1,14 @@
-import{_ as s,c as a,o as n,N as l}from"./chunks/framework.0799945b.js";const i=JSON.parse('{"title":"Particles","description":"","frontmatter":{},"headers":[],"relativePath":"guide/recipes/particles.md","lastUpdated":1681094412000}'),p={name:"guide/recipes/particles.md"},o=l(`
Particles ​
This is a more complete example from the Kronos example used in the nodes docs. You will design a particle effect, make it appear on another feature, and make it adapt to the game state.
Let's start with designing the particle effect. Profectus uses pixi-particles, and there's an online particle effect editor for it here. However, it will return an older format of the particle effect emitter options, so you'll need to convert it like so:
ts
import myParticleEffect from "myParticleEffect.json";
+import{_ as s,c as a,o as n,N as l}from"./chunks/framework.0799945b.js";const i=JSON.parse('{"title":"Particles","description":"","frontmatter":{},"headers":[],"relativePath":"guide/recipes/particles.md","lastUpdated":1681131771000}'),p={name:"guide/recipes/particles.md"},o=l(`
Particles ​
This is a more comprehensive example based on the Kronos example used in the nodes docs. You will design a particle effect, make it appear on another feature, and ensure it adapts to the game state.
First, design the particle effect. Profectus uses pixi-particles, and you can use the online particle effect editor here. However, the editor returns an older format of the particle effect emitter config, so you'll need to convert it like this:
ts
import myParticleEffect from "myParticleEffect.json";
 import { upgradeConfig } from "@pixi/particle-emitter"
 
-const particleEffect = upgradeConfig(myParticleEffect);
Next we need to create the particles feature and render it. We'll also want to track the bounding rect of the particle effects. We'll consider the next step:
ts
const particles = createParticles(() => ({
+const particleEffect = upgradeConfig(myParticleEffect);
Next, create the particles feature and render it. You'll also want to track the bounding rect of the particle effects. Consider the following step:
ts
const particles = createParticles(() => ({
     fullscreen: false,
     zIndex: -1,
     boundingRect: ref<null | DOMRect>(null),
     onContainerResized(boundingRect) {
         this.boundingRect.value = boundingRect;
     }
-}));
You'll note this adds a bounding rect and updates it's based on the boundingRect set to non-null. The next step will be creating the emitter. Now we can pull in the Kronos example, which make a particle effect that appears when actualGain > 0.
ts
const particlesEmitter = ref(particles.addEmitter(element.particlesConfig));
+}));
This code adds a bounding rect for the particles and updates it when the container is created or resizes. Now, create the emitter. Pull in the Kronos example, which displays a particle effect when actualGain > 0.
ts
const particlesEmitter = ref(particles.addEmitter(element.particlesConfig));
 const updateParticleEffect = async ([shouldEmit, rect, boundingRect]: [
     boolean,
     DOMRect | undefined,
@@ -32,7 +32,7 @@ import{_ as s,c as a,o as n,N as l}from"./chunks/framework.0799945b.js";const i=
         particles.boundingRect
     ],
     updateParticleEffect
-)
You'll note this checks regularly whether the boundingRect exists. If you ensure all the references to things are being watched, youy can make complex situations for various emitters.
If you're hot reloading, it may be required to re-load the particle effect. Here's example code from Kronos.
ts
const refreshParticleEffect = () => {
+)
This code watches for whether the node exists and the boundingRect exists, which are required to display the effect. You can additionally watch any other values that would have an impact on the particle effect, like whether or not it should be emitting.
If you're using hot reloading, you might need to reload the particle effect. Here's an example from Kronos:
ts
const refreshParticleEffect = () => {
     particlesEmitter.value
         .then(e => e.destroy())
         .then(
diff --git a/assets/guide_recipes_particles.md.30664cc1.lean.js b/assets/guide_recipes_particles.md.d4df0645.lean.js
similarity index 84%
rename from assets/guide_recipes_particles.md.30664cc1.lean.js
rename to assets/guide_recipes_particles.md.d4df0645.lean.js
index 452a2b8b..f26fba35 100644
--- a/assets/guide_recipes_particles.md.30664cc1.lean.js
+++ b/assets/guide_recipes_particles.md.d4df0645.lean.js
@@ -1 +1 @@
-import{_ as s,c as a,o as n,N as l}from"./chunks/framework.0799945b.js";const i=JSON.parse('{"title":"Particles","description":"","frontmatter":{},"headers":[],"relativePath":"guide/recipes/particles.md","lastUpdated":1681094412000}'),p={name:"guide/recipes/particles.md"},o=l("",11),e=[o];function t(c,r,y,F,D,A){return n(),a("div",null,e)}const d=s(p,[["render",t]]);export{i as __pageData,d as default};
+import{_ as s,c as a,o as n,N as l}from"./chunks/framework.0799945b.js";const i=JSON.parse('{"title":"Particles","description":"","frontmatter":{},"headers":[],"relativePath":"guide/recipes/particles.md","lastUpdated":1681131771000}'),p={name:"guide/recipes/particles.md"},o=l("",11),e=[o];function t(c,r,y,F,D,A){return n(),a("div",null,e)}const d=s(p,[["render",t]]);export{i as __pageData,d as default};
diff --git a/assets/guide_recipes_save-progress.md.300c07f4.js b/assets/guide_recipes_save-progress.md.77ef05d3.js
similarity index 99%
rename from assets/guide_recipes_save-progress.md.300c07f4.js
rename to assets/guide_recipes_save-progress.md.77ef05d3.js
index 8ec9e3a1..c5408498 100644
--- a/assets/guide_recipes_save-progress.md.300c07f4.js
+++ b/assets/guide_recipes_save-progress.md.77ef05d3.js
@@ -1,4 +1,4 @@
-import{_ as s,c as a,o as e,N as n}from"./chunks/framework.0799945b.js";const o="/assets/save-progress.2c9d1bae.png",u=JSON.parse('{"title":"Display Save Progress","description":"","frontmatter":{},"headers":[],"relativePath":"guide/recipes/save-progress.md","lastUpdated":1681094412000}'),t={name:"guide/recipes/save-progress.md"},l=n('
Display Save Progress ​
This is a recipe to add a section to each save in the Saves Manager that will describe the amount of progress within that save. This can allow the player to more easily compare the saves to determine which is which. This would be in addition to the game version, last time played, and the name of the save itself, which can already be used for comparing saves without any configuration.
save progress display
This recipe will involve modifying the Save.vue file within your project to include an extra component in the saves details. It will go over creating the new component, how to work with the save data object, and then displaying the component.
Creating the component ​
Let's start with creating the coerced component. For this recipe we're going to make a couple assumptions about what this display should be. We'll assume the text will be more complex than displaying a single value. That is, at different stages of the game progress will be indicated by different metrics. We'll also assume it will be a single line of descriptive text - no images or anything else that would justify making a new .vue component. Breaking these assumptions is left as an exercise for the reader. But for now, with those assumptions in mind, we'll write our component (in the <script> tag in Save.vue) similar to this example:
ts
const progressDisplay = computeComponent(
+import{_ as s,c as a,o as e,N as n}from"./chunks/framework.0799945b.js";const o="/assets/save-progress.2c9d1bae.png",u=JSON.parse('{"title":"Display Save Progress","description":"","frontmatter":{},"headers":[],"relativePath":"guide/recipes/save-progress.md","lastUpdated":1681131771000}'),t={name:"guide/recipes/save-progress.md"},l=n('
Display Save Progress ​
This is a recipe to add a section to each save in the Saves Manager that will describe the amount of progress within that save. This can allow the player to more easily compare the saves to determine which is which. This would be in addition to the game version, last time played, and the name of the save itself, which can already be used for comparing saves without any configuration.
save progress display
This recipe will involve modifying the Save.vue file within your project to include an extra component in the saves details. It will go over creating the new component, how to work with the save data object, and then displaying the component.
Creating the component ​
Let's start with creating the coerced component. For this recipe we're going to make a couple assumptions about what this display should be. We'll assume the text will be more complex than displaying a single value. That is, at different stages of the game progress will be indicated by different metrics. We'll also assume it will be a single line of descriptive text - no images or anything else that would justify making a new .vue component. Breaking these assumptions is left as an exercise for the reader. But for now, with those assumptions in mind, we'll write our component (in the <script> tag in Save.vue) similar to this example:
ts
const progressDisplay = computeComponent(
     computed(() => {
     	if (someCondition) {
     		return "Just started";
diff --git a/assets/guide_recipes_save-progress.md.300c07f4.lean.js b/assets/guide_recipes_save-progress.md.77ef05d3.lean.js
similarity index 86%
rename from assets/guide_recipes_save-progress.md.300c07f4.lean.js
rename to assets/guide_recipes_save-progress.md.77ef05d3.lean.js
index 366918d8..cb3ce688 100644
--- a/assets/guide_recipes_save-progress.md.300c07f4.lean.js
+++ b/assets/guide_recipes_save-progress.md.77ef05d3.lean.js
@@ -1 +1 @@
-import{_ as s,c as a,o as e,N as n}from"./chunks/framework.0799945b.js";const o="/assets/save-progress.2c9d1bae.png",u=JSON.parse('{"title":"Display Save Progress","description":"","frontmatter":{},"headers":[],"relativePath":"guide/recipes/save-progress.md","lastUpdated":1681094412000}'),t={name:"guide/recipes/save-progress.md"},l=n("",16),p=[l];function r(c,i,y,D,F,d){return e(),a("div",null,p)}const m=s(t,[["render",r]]);export{u as __pageData,m as default};
+import{_ as s,c as a,o as e,N as n}from"./chunks/framework.0799945b.js";const o="/assets/save-progress.2c9d1bae.png",u=JSON.parse('{"title":"Display Save Progress","description":"","frontmatter":{},"headers":[],"relativePath":"guide/recipes/save-progress.md","lastUpdated":1681131771000}'),t={name:"guide/recipes/save-progress.md"},l=n("",16),p=[l];function r(c,i,y,D,F,d){return e(),a("div",null,p)}const m=s(t,[["render",r]]);export{u as __pageData,m as default};
diff --git a/assets/index.md.6970eb14.js b/assets/index.md.a72140fb.js
similarity index 94%
rename from assets/index.md.6970eb14.js
rename to assets/index.md.a72140fb.js
index 871b0052..222cd4a0 100644
--- a/assets/index.md.6970eb14.js
+++ b/assets/index.md.a72140fb.js
@@ -1 +1 @@
-import{_ as e,c as t,o}from"./chunks/framework.0799945b.js";const m=JSON.parse('{"title":"Home","description":"","frontmatter":{"layout":"home","title":"Home","hero":{"name":"Profectus","text":"A game engine that grows with you","tagline":"Starts at your skill level and encourages your ambition to make your projects bigger and better.","actions":[{"theme":"brand","text":"Get Started","link":"/guide/getting-started/setup"},{"theme":"alt","text":"Learn More","link":"/guide/"}]},"features":[{"title":"Easy to Use","details":"Everything is written to be as intuitive to use as possible, through consistent design."},{"title":"Helpful","details":"Built with TypeScript to guide you as you write. Seamlessly deploy your project with pre-configured github workflows, and more."},{"title":"Incremental","details":"Designed to actively encourage you to become better at programming. The engine will never limit you."}]},"headers":[],"relativePath":"index.md","lastUpdated":1681094412000}'),i={name:"index.md"};function a(r,n,s,l,d,u){return o(),t("div")}const g=e(i,[["render",a]]);export{m as __pageData,g as default};
+import{_ as e,c as t,o}from"./chunks/framework.0799945b.js";const m=JSON.parse('{"title":"Home","description":"","frontmatter":{"layout":"home","title":"Home","hero":{"name":"Profectus","text":"A game engine that grows with you","tagline":"Starts at your skill level and encourages your ambition to make your projects bigger and better.","actions":[{"theme":"brand","text":"Get Started","link":"/guide/getting-started/setup"},{"theme":"alt","text":"Learn More","link":"/guide/"}]},"features":[{"title":"Easy to Use","details":"Everything is written to be as intuitive to use as possible, through consistent design."},{"title":"Helpful","details":"Built with TypeScript to guide you as you write. Seamlessly deploy your project with pre-configured github workflows, and more."},{"title":"Incremental","details":"Designed to actively encourage you to become better at programming. The engine will never limit you."}]},"headers":[],"relativePath":"index.md","lastUpdated":1681131771000}'),i={name:"index.md"};function a(r,n,s,l,d,u){return o(),t("div")}const g=e(i,[["render",a]]);export{m as __pageData,g as default};
diff --git a/assets/index.md.6970eb14.lean.js b/assets/index.md.a72140fb.lean.js
similarity index 94%
rename from assets/index.md.6970eb14.lean.js
rename to assets/index.md.a72140fb.lean.js
index 871b0052..222cd4a0 100644
--- a/assets/index.md.6970eb14.lean.js
+++ b/assets/index.md.a72140fb.lean.js
@@ -1 +1 @@
-import{_ as e,c as t,o}from"./chunks/framework.0799945b.js";const m=JSON.parse('{"title":"Home","description":"","frontmatter":{"layout":"home","title":"Home","hero":{"name":"Profectus","text":"A game engine that grows with you","tagline":"Starts at your skill level and encourages your ambition to make your projects bigger and better.","actions":[{"theme":"brand","text":"Get Started","link":"/guide/getting-started/setup"},{"theme":"alt","text":"Learn More","link":"/guide/"}]},"features":[{"title":"Easy to Use","details":"Everything is written to be as intuitive to use as possible, through consistent design."},{"title":"Helpful","details":"Built with TypeScript to guide you as you write. Seamlessly deploy your project with pre-configured github workflows, and more."},{"title":"Incremental","details":"Designed to actively encourage you to become better at programming. The engine will never limit you."}]},"headers":[],"relativePath":"index.md","lastUpdated":1681094412000}'),i={name:"index.md"};function a(r,n,s,l,d,u){return o(),t("div")}const g=e(i,[["render",a]]);export{m as __pageData,g as default};
+import{_ as e,c as t,o}from"./chunks/framework.0799945b.js";const m=JSON.parse('{"title":"Home","description":"","frontmatter":{"layout":"home","title":"Home","hero":{"name":"Profectus","text":"A game engine that grows with you","tagline":"Starts at your skill level and encourages your ambition to make your projects bigger and better.","actions":[{"theme":"brand","text":"Get Started","link":"/guide/getting-started/setup"},{"theme":"alt","text":"Learn More","link":"/guide/"}]},"features":[{"title":"Easy to Use","details":"Everything is written to be as intuitive to use as possible, through consistent design."},{"title":"Helpful","details":"Built with TypeScript to guide you as you write. Seamlessly deploy your project with pre-configured github workflows, and more."},{"title":"Incremental","details":"Designed to actively encourage you to become better at programming. The engine will never limit you."}]},"headers":[],"relativePath":"index.md","lastUpdated":1681131771000}'),i={name:"index.md"};function a(r,n,s,l,d,u){return o(),t("div")}const g=e(i,[["render",a]]);export{m as __pageData,g as default};
diff --git a/guide/advanced-concepts/creating-features.html b/guide/advanced-concepts/creating-features.html
index 67aae7c2..4ff40b16 100644
--- a/guide/advanced-concepts/creating-features.html
+++ b/guide/advanced-concepts/creating-features.html
@@ -10,7 +10,7 @@
     
   
   
-  
+  
   
   
   
@@ -51,8 +51,8 @@
     // unsubscribe from postUpdate
     listeners[layer.id]?.();
     listeners[layer.id] = undefined;
-});

-    
     
   
diff --git a/guide/advanced-concepts/dynamic-layers.html b/guide/advanced-concepts/dynamic-layers.html
index 81dc4951..2c3c5e11 100644
--- a/guide/advanced-concepts/dynamic-layers.html
+++ b/guide/advanced-concepts/dynamic-layers.html
@@ -10,7 +10,7 @@
     
   
   
-  
+  
   
   
   
@@ -25,8 +25,8 @@
   const layer = layers[id];
   if (!layer) throw "Layer does not exist";
   return layer as DynamicLayer; // you might need an "as unknown" after layer
-}
This utility function can streamline your code when dealing with multiple dynamic layers and ensure that you're working with the correct layer type.
When working with dynamic layers you'll need to ensure you can determine what layers should exist when loading a save file, by returning an accurate list from your project's getInitialLayers function.
- diff --git a/guide/advanced-concepts/nodes.html b/guide/advanced-concepts/nodes.html index 394afd31..5c13b078 100644 --- a/guide/advanced-concepts/nodes.html +++ b/guide/advanced-concepts/nodes.html @@ -10,7 +10,7 @@ - + @@ -45,8 +45,8 @@ particles.boundingRect ], updateParticleEffect -)

In this example the particle effects will update whenever the window resizes, the feature's bounding rect changes, or the particle effect is supposed to turn on/off. By watching for other relevant properties you can ensure even more complex situations are accounted for.

The bounding rect is usually kept up-to-date and responsive to changes such as nodes resizing, moving due to window resizing, or features being shown or hidden. However, occasional situations may cause it to be out of sync. Therefore, it's recommended to use the node system for visual effects only, where any glitches have minimal impact.

- diff --git a/guide/creating-your-project/changelog.html b/guide/creating-your-project/changelog.html index db665599..689d9182 100644 --- a/guide/creating-your-project/changelog.html +++ b/guide/creating-your-project/changelog.html @@ -10,7 +10,7 @@ - + @@ -30,8 +30,8 @@ <li class="breaking">Removed everything</li> <li class="balancing">Created some bugs to fix later</li> </ul> -</details>

The details and summary tags will create a section that can be collapsed and uncollapsed. While collapsed only the text in the summary tag will appear. By default sections are collapsed, although adding the open attribute to the details element will change that.

Within the details of the version, you can add a description and a list of changes for that version. CSS classes have been defined to automatically mark a change as a feature, fix, breaking change, or balancing tweak. You can of course add additional tags as you have full control over the entire component.

- diff --git a/guide/creating-your-project/project-entry.html b/guide/creating-your-project/project-entry.html index b1067bda..8c3bf823 100644 --- a/guide/creating-your-project/project-entry.html +++ b/guide/creating-your-project/project-entry.html @@ -10,7 +10,7 @@ - + @@ -21,8 +21,8 @@ -
Profectus
On this page

Project Entry ​

This is a TypeScript file containing the non-static parts of your project, and acts as the entry point for it.

It is stored at /src/data/projEntry.jsx.

This file has 3 things it must export, but beyond that can export anything the creator wants it to. Typically in addition to the required 3, the initial/"main" layer will be exported. Typically utilites belong in common.tsx, which exists next to projEntry.tsx.

Required Exports ​

getInitialLayers ​

  • Type: (player: Partial<PlayerData>) => GenericLayer[]

A function that is given a player save data object currently being loaded, and returns a list of layers that should be active for that player. If a project does not have dynamic layers, this should always return a list of all layers.

hasWon ​

  • Type: ComputedRef<boolean>

A computed ref whose value is true whenever the game is over.

For example, in a game where the goal is to have a resource reach 10:

ts
export const hasWon = computed(() => Decimal.gte(resource.value, 10));

fixOldSave ​

  • Type: (oldVersion: string | undefined, player: Partial<PlayerData>) => void

This function will be run whenever a save is loaded that has a different version than the one in project info. It will be given the old version number, and the player save data object currently being loaded.

The purpose of this function is to perform any necessary migrations, such as capping a resource that accidentally inflated in a previous version of the project. By default it will do nothing.

- diff --git a/guide/creating-your-project/project-info.html b/guide/creating-your-project/project-info.html index 6abfe599..c3b50ad1 100644 --- a/guide/creating-your-project/project-info.html +++ b/guide/creating-your-project/project-info.html @@ -10,7 +10,7 @@ - + @@ -21,8 +21,8 @@ -
Profectus
On this page

Project Info ​

This is a JSON file containing information that describes your project and configures parts of how Profectus should represent it.

It is stored at /src/data/projInfo.json.

Basic Config ​

title ​

  • Type: string
  • Default: Profectus

The name of the project, which will appear in the info tab and the header, if enabled. The page title will also be set to this value.

description ​

  • Type: string
  • Default: A project made in Profectus

A description of the project, which will be used when the project is installed as a Progressive Web Application.

id ​

  • Type: string
  • Default: ""

This is a unique ID used when saving player data. Changing this will effectively erase all save data for all players.

WARNING

This ID MUST be unique to your project, and should not be left as the default value. Otherwise, your project may use the save data from another project and cause issues for both projects.

author ​

  • Type: string
  • Default: ""

The author of the project, which will appear in the info tab.

discordName ​

  • Type: string
  • Default: The Paper Pilot Community

The text to display for the discord server to point users to. This will appear when hovering over the discord icon, inside the info tab, the game over screen, as well as the NaN detected screen.

By default, this is The Paper Pilot Community, which can act as a catch-all for any Profectus projects without their own servers. If you change the discord server with your own, The Paper Pilot Community will still display underneath the custom server when hovering over the discord icon and within the info tab. Those places will also contain a link to the Modding Tree discord server.

  • Type: string
  • Default: https://discord.gg/WzejVAx

The link for the discord server to point users to. See discordName for more details.

Version Config ​

versionNumber ​

  • Type: string
  • Default: 0.0

The current version of the project loaded. If the player data was last saved in a different version of the project, fixOldSave will be run, so you can perform any save migrations necessary. This will also appear in the nav, the info tab, and the game over screen.

versionTitle ​

  • Type: string
  • Default: Initial Commit

The display name for the current version of the project loaded. This will also appear in the nav, the info tab, and the game over screen unless set to an empty string.

Display Config ​

allowGoBack ​

  • Type: boolean
  • Default: true

Whether or not to allow tabs (besides the first) to display a "back" button to close them (and any other tabs to the right of them).

defaultShowSmall ​

  • Type: boolean
  • Default: false

Whether or not to allow resources to display small values (<.001). If false they'll just display as 0. Individual resources can also be configured to override this value.

defaultDecimalsShown ​

  • Type: number
  • Default: 2

Default precision to display numbers at when passed into format. Individual format calls can override this value, and resources can be configured with a custom precision as well.

useHeader ​

  • Type: boolean
  • Default: true

Whether or not to display the nav as a header at the top of the screen. If disabled, the nav will appear on the left side of the screen laid over the first tab.

  • Type: string | null
  • Default: null

A path to an image file to display as the logo of the app. If null, the title will be shown instead. This will appear in the nav when useHeader is true.

  • Type: string
  • Default: ""

A path to an image file to display as the logo of the app within the info tab. If left blank no logo will be shown.

initialTabs ​

  • Type: string[]
  • Default: ["main"]

The list of initial tabs to display on new saves. This value must have at least one element. Each element should be the ID of the layer to display in that tab.

Advanced Config ​

maxTickLength ​

  • Type: number
  • Default: 3600

The longest duration a single tick can be, in seconds. When calculating things like offline time, a single tick will be forced to be this amount or lower. This will make calculating offline time spread out across many ticks as necessary. The default value is 1 hour.

offlineLimit ​

  • Type: number
  • Default: 1

The max amount of time that can be stored as offline time, in hours.

enablePausing ​

  • Type: boolean
  • Default: true

Whether or not to allow the player to pause the game. Turning this off disables the toggle from the options menu as well as the NaN screen. Developers can still manually pause by just running player.devSpeed = 0 in console (or = 1 to resume).

exportEncoding ​

  • Type: base64 | lz | plain
  • Default: base64

The encoding to use when exporting to the clipboard. Plain-text is fast to generate but is easiest for the player to manipulate and cheat with. Base 64 is slightly slower and the string will be longer but will offer a small barrier to people trying to cheat. LZ-String is the slowest method, but produces the smallest strings and still offers a small barrier to those trying to cheat. Some sharing platforms like pastebin may automatically delete base64 encoded text, and some sites might not support all the characters used in lz-string exports.

- diff --git a/guide/creating-your-project/themes.html b/guide/creating-your-project/themes.html index 7cfc87c9..d16d61a6 100644 --- a/guide/creating-your-project/themes.html +++ b/guide/creating-your-project/themes.html @@ -10,7 +10,7 @@ - + @@ -21,8 +21,8 @@ -
Profectus
On this page

Themes ​

Themes are objects that change how the project's interface should look. This is done mostly by changing the values of various CSS variables. You can look at the existing themes as a reference for the kind of values these CSS variables expect. They can also set various theme options that change how parts of the screen are laid out, which are described below.

They are stored in /src/data/themes.ts.

Modifying Themes ​

You can add a theme by adding a property to the Themes enum and then including the theme in the exported object. It's recommended to use the spread operator if you'd like to have a theme look like another, but override specific options / CSS variables.

Themes added in this way will be automatically included in the Themes dropdown in the Options tab. Removing themes from the enum and exported object will similarly hide them from the dropdown.

If you'd like to change which theme is the default, you may modify the initial player settings object in the /src/game/settings.ts file. Keep in mind you'll also want to change it in the hardResetSettings function in the same file.

Theme Options ​

floatingTabs ​

  • Type: boolean

Toggles whether to display tab buttons in a tab list, similar to how a browser displays tabs; or to display them as floating buttons, similar to how TMT displays buttons.

mergeAdjacent ​

  • Type: boolean

If true, elements in a row or column will have their margins removed and border radiuses set to 0 between elements. This will cause the elements to appear as segments in a single object.

Currently, this can only merge in a single dimension. Rows of columns or columns of rows will not merge into a single rectangular object.

- diff --git a/guide/creating-your-project/utils.html b/guide/creating-your-project/utils.html index 9b499064..0d61595b 100644 --- a/guide/creating-your-project/utils.html +++ b/guide/creating-your-project/utils.html @@ -10,7 +10,7 @@ - + @@ -21,8 +21,8 @@ -
Profectus
On this page

Utilities ​

There are often concepts that aren't inherent to a single feature, but rather work with joining different features together. For example, a reset clickable that activates a conversion and resets a tree, which happens to be a common use case but isn't inherent to clickables, conversions, or trees.

These are perfect situations for utilities, and so to encourage creators to learn to identify and take advantage of these situations, a file called src/data/common.tsx has been created to demo some of the more common utility functions a project might use. Adding new utilities to this file is encouraged, as is creating utils in general. It also works as a good stepping stone to creating your own features.

- diff --git a/guide/getting-started/examples.html b/guide/getting-started/examples.html index fde1a821..3746166b 100644 --- a/guide/getting-started/examples.html +++ b/guide/getting-started/examples.html @@ -10,7 +10,7 @@ - + @@ -21,8 +21,8 @@ -
Profectus
On this page

Example Projects ​

Advent Incremental Profectus 0.5 ​

View Source | View Project

An incremental game with 25 different layers of content. A good example of what a large project looks like. There's also a partial port to 0.6 available here.

Primordia Profectus 0.5 ​

View Source | View Project

A "The Prestige Tree" style incremental game, developed by the original creator of TPT.

TMT-Demo Profectus 0.6 ​

View Source | View Project

A project loosely based off the Demo project for TMT. Uses most of the different features of Profectus, but doesn't have any real gameplay.

- diff --git a/guide/getting-started/setup.html b/guide/getting-started/setup.html index d2a40870..66e19ed2 100644 --- a/guide/getting-started/setup.html +++ b/guide/getting-started/setup.html @@ -10,7 +10,7 @@ - + @@ -21,8 +21,8 @@ -
Profectus
On this page

Setting Up ​

Profectus requires a Node.js development environment for working on a project. If you are comfortable with the command line, a local development environment is recommended.

Local Development ​

For local development, you will need the following tools:

Create a new project from the Profectus repository by clicking the "Use this template" button. Then, clone the repository locally using the provided link.

INFO

The template repository allows easy creation of multiple projects from one repository. However, updating an existing project to a newer version of Profectus can be challenging. Consider updating Profectus before starting development to avoid issues with unrelated histories.

It's recommended to create a new Git branch for development, allowing you to push changes without affecting the live build. The GitHub workflow will automatically rebuild the page when you push to the main branch.

Next, install Profectus' dependencies by running npm install. Run npm run serve to start a local server hosting your project. The site will automatically reload as you modify files.

Also, follow the steps to update Profectus before starting to make future updates easier without worrying about unrelated histories.

Deploying ​

Using Git, the repository's workflow action automates deployment. However, you need to grant write permissions for the action in the repository settings. Go to Actions, General, Workflow permissions, and select "Read and write permissions".

workflow permissions

To deploy, push changes to the main branch. The site will be updated automatically in a few minutes. Check progress or errors from the Actions tab on your repository.

actions button

Enable GitHub Pages in the repo settings to host the generated site. Select the gh-pages branch. Perform this step once. This will automatically start another GitHub action to deploy the website.

github pages

Upon action completion, your project should be available at https://<YOUR_GITHUB_USERNAME>.github.io/<YOUR_REPO_NAME>/. For example, the TMT Demo project hosted at https://github.com/profectus-engine/TMT-Demo is available at https://profectus-engine.github.io/TMT-Demo/.

Visual Studio Code Setup ​

If you don't have a preferred IDE, Profectus is developed in Visual Studio Code and is known to work well with it.

Recommendations:

  • Use Take Over Mode for proper type analysis
  • Turn off .value autocomplete by running the Preferences: Open Settings command and setting volar.autoCompleteRefs to false
  • Install the Vitest VS Code extension for running and debugging unit tests (if working on the engine itself)

Replit ​

As an alternative to local development, you may use Replit. Replit sets up your development and hosts your project.

On the free plan, you'll face limitations, and the program may need occasional startups.

To create a Profectus project on Replit, all you have to do is click this button:

Run on Repl.it

Click the "Run" button at the top of the screen to start development. This will also make the project publicly accessible, essentially auto-deploying it. However, this means you cannot separate your development and production environments.

Glitch ​

Glitch is a site similar to Replit, with many of the same pros and cons. To create a Profectus project on Glitch, select "New Project", "Import from GitHub", and enter profectus-engine/Profectus. The new project will be automatically configured and ready to go.

- diff --git a/guide/getting-started/updating.html b/guide/getting-started/updating.html index b27c15c6..0c4e02b3 100644 --- a/guide/getting-started/updating.html +++ b/guide/getting-started/updating.html @@ -10,7 +10,7 @@ - + @@ -23,8 +23,8 @@
Profectus
On this page

Updating Profectus ​

Github ​

Due to Profectus being a template repository, your projects do not share a git history with Profectus. In order to update changes, you will need to run the following:

bash
git remote add template https://github.com/profectus-engine/Profectus
 git fetch --all
-git merge template/main --allow-unrelated-histories

The first command only has to be performed once. The third command may require you to merge conflicts between code both you and Profectus have changed - however, due to the modularity of Profectus, this should be fairly rare. Unfortunately, due to the unrelated histories the first time you do this every change will be marked as a conflict, and you'll need to accept each one.

Replit ​

The sidebar has a tab labelled "Version Control", which you can use to merge all changes made to Profectus into your project. Unfortunately, replit does not have a merge tool so this process may irrecoverably erase changes you've made - I'd recommend making a backup first.

Glitch ​

Unfortunately glitch does not provide any method by which to update a project from a github repository. If you've only changed things in the data folder you may consider creating a new project, importing the current version of Profectus, and then placing your data folder in the new project.

- diff --git a/guide/important-concepts/coercable.html b/guide/important-concepts/coercable.html index e05fa1bf..678d1034 100644 --- a/guide/important-concepts/coercable.html +++ b/guide/important-concepts/coercable.html @@ -10,7 +10,7 @@ - + @@ -29,8 +29,8 @@ {renderRow(upgrade1, upgrade2, upgrade3)} </> )), -}

Components ​

This one might be the most obvious, but you can also just give it a Vue component to display outright. Keep in mind it will not be passed any props, so it should not depend on any. You can read more about creating Vue components on Components Basics.

- diff --git a/guide/important-concepts/features.html b/guide/important-concepts/features.html index 1ab51b9a..8dab3018 100644 --- a/guide/important-concepts/features.html +++ b/guide/important-concepts/features.html @@ -10,7 +10,7 @@ - + @@ -29,8 +29,8 @@ cost: 1, resource: points }));

The result will be a lazy proxy of the feature being created. The feature can then be used throughout the rest of the layer. The main thing to keep in mind when creating features is that they should typically be included in the layer object that gets returned. If a feature has any persistent refs they must be included or else they will not have their values saved and loaded correctly.

While the structure of layers is intentionally left up to the creator, it is recommended to avoid storing them in arrays. If you ever remove an upgrade from an array, or add an upgrade in between others, then it will interfere with the save data of existing users. You can manually fix these issues in fixOldSave, but it's recommended to avoid the error entirely.

Since usually you want to access a specific feature, storing them in an object is much more reliable and makes the code easier to read. For things like checking number of upgrades bought, for example, you can still use Object.values to get an array of the objects instead.

Example ​

ts
const upgrades = { addGainUpgrade, gainMultUpgrade, upgMultUpgrade };
-const numUpgrades = computed(() => Object.values(upgrades).length);

Tree Shaking ​

Since Profectus takes advantage of tree shaking, and type of feature that is not used will not be included in the output of the project. That means users have less code to download, a slight performance boost, and you don't need to worry about feature type-specific settings appearing (such as whether to show maxed challenges).

It should be noted that a couple features depend on each other, such as Buyables depending on Clickables. That means you may see features included in the output despite not directly using them. Some features, such as Links and Tooltips, are used by the engine itself and will always be included in the output.

- diff --git a/guide/important-concepts/formulas.html b/guide/important-concepts/formulas.html index 0c0e5c4f..2595eb9c 100644 --- a/guide/important-concepts/formulas.html +++ b/guide/important-concepts/formulas.html @@ -10,7 +10,7 @@ - + @@ -29,8 +29,8 @@ })), maximize: true }; -});

Limitations ​

Single Variable ​

For inverting and integrating, formulas should have a single variable, which serves as the input. Although other parts of the formula can be computed values, they must not be dependent on the input variable for inverting or integrating purposes. Formulas work correctly as long as changing other parts of the formula doesn't affect the input variable.

Invertibility and Integrability ​

Certain operations may not support inverting or integrating. Functions such as rounding or clamping are non-invertible, while others like super-log are non-integrable. You may only use a single complex operation in addition to add, sub, mult, and div operations. For formulas with two complex operations, a custom formula is required.

Spending Resources ​

When working with formulas, the spendResources property determines whether the formula needs to be invertible or integrable. The property is used in two utilities: calculateMaxAffordable and calculateCost. These utilities are ultimately employed wherever formulas are used, such as in cost requirements or conversions.

Spending resources refers to whether max affordability and cost calculations should account for resources spent. If spending resources is set to true, the formula will be integrated and inverted, albeit with certain limitations. For example, exponential modifiers and soft caps can make a formula non-integrable.

Consider a simple formula that returns the input value as the cost. For example, to make three sequential purchases, the costs would be 1, 2, and 3, totaling 6. When resources are spent, making three purchases in a single operation will cost a total of 6. However, if resources are not spent, the cost would only be 3, the cost of the last purchase. Accounting for resources being spent means that the overall cost calculation reflects the cumulative costs of multiple purchases.

Integration in this context is an estimation, as it calculates the area under a continuous curve, while actual purchases occur at integer values. This means that calculating max affordable might overshoot and the cost at that amount might undershoot. To help address this, the summedPurchases property can be used, which manually sums the last X purchases, reducing the error margin. This also ensures higher accuracy when the player makes fewer purchases at once, which is when accuracy is most relevant. For larger numbers of purchases, a slight overshoot or undershoot is typically acceptable.

Modifiers ​

When applying changes to a formula using modifiers, use the modifierToFormula utility to apply the modifier while preserving invertibility if the modifier is invertible.

Custom Formulas ​

If the existing functions are insufficient for your needs, create a custom formula by implementing your own evaluation, inversion, and integration functions. Use the operations in src/game/formulas/operations.ts as reference. For spending resources, the integral formula must be invertible.

- diff --git a/guide/important-concepts/layers.html b/guide/important-concepts/layers.html index 5f478d86..72d0a68f 100644 --- a/guide/important-concepts/layers.html +++ b/guide/important-concepts/layers.html @@ -10,7 +10,7 @@ - + @@ -21,8 +21,8 @@ -
Profectus
On this page

Layers ​

Profectus content is organized into units called "Layers". When displaying content to the user, the screen will be divided into several tabs that each display the content of a layer. These layers are stored in /src/data/layers.

Each layer is ultimately a collection of different features, and a display function. While there are a couple reserved properties for layers, most of its structure is fully up to the creator.

Layers can be dynamically added or removed at any time, which also allows for effectively disabling or enabling content based on arbitrary conditions. Just make sure getInitialLayers can process the player save data object and determine which layers should be currently active.

Lazy Proxies ​

Layers (and features) are not actually created immediately. Instead, their options are gotten through a function which is then run the first time something inside the layer is accessed. This is a concept called lazy evaluation, which is also used for things like computed, and allows for features to reference each other without worrying about cyclical dependencies.

- diff --git a/guide/important-concepts/persistence.html b/guide/important-concepts/persistence.html index 22c988da..0154fe66 100644 --- a/guide/important-concepts/persistence.html +++ b/guide/important-concepts/persistence.html @@ -10,7 +10,7 @@ - + @@ -21,8 +21,8 @@ -
Profectus
On this page

Persistence ​

Persistence refers to data that is saved, so that it persists when the user closes the tab and opens it again in the future.

In Profectus, this is handled by creating "persistent refs", which act like refs but whose value is stored in an object that gets saved to localStorage. Other than that you can treat them like any other ref - when adding the layer, any persistent refs will automatically have their values updated to the ones saved in localStorage. If there isn't a saved value, it'll use the default value passed to the persistent ref constructor.

Many features in Profectus, such as upgrades, milestones, and challenges, internally have persistent refs to save things like whether the upgrade has been purchased, the milestone achieved, or the challenge completed. Creators can also create their own custom persistent refs to store any arbitrary (but serializable) data they need - that means Numbers (including big numbers), strings, booleans, or objects containing only serializable values. Another notable function is the resource constructor. If you pass a default value into its contructor, it will automatically create a persistent ref for that resource. If you pass in a ref, it will NOT make the ref persistent.

It's important for saving and loading these properties for these refs to be in a well known location. This is implemented based on the location of the persistent ref within a layer. That means its important that all persistent refs are located within the object returned by the createLayer options function. If a persistent ref is not within that object, it will NOT be saved and loaded - regardless of whether its a persistent ref within a feature, one you manually created, or otherwise.

Additionally, this structure should typically remain consistent between project versions. If a value is in a new location, it will not load the value from localStorage correctly. This is exacerbated if two values swap places, such as when an array is re-ordered. In the event a creator changes this structure anyways, the fixOldSave function can be used to migrate the old player save data to the new structure expected by the current version of the project.

- diff --git a/guide/important-concepts/reactivity.html b/guide/important-concepts/reactivity.html index 60b0e7aa..82aabfb4 100644 --- a/guide/important-concepts/reactivity.html +++ b/guide/important-concepts/reactivity.html @@ -10,7 +10,7 @@ - + @@ -21,8 +21,8 @@ -
Profectus
On this page

Reactivity ​

Profectus takes large advantage of Vue's reactivity system. It's recommended to read up on how refs and computed refs work. Ultimately this means that sometimes you'll need to type .value to get the actual value of something, but also you are able to pass things around by reference instead of by value. Indeed, it is recommended to only unwrap the actual value when you actually need it. .value is guaranteed to be correct and up to date only on the exact moment it is accessed.

With a proper IDE, such as Visual Studio Code, you should be able to see whether or not something is a ref or not from type hints. If in doubt, you can always wrap the property in an unref call.

Vue's reactivity is probably the "quirkiest" part of Profectus, and not even the documentation makes all of those quirks clear. It is recommend to read this thread of common misconceptions around Vue reactivity.

Computable ​

Most properties on features will accept Computable values. Computable values can either be a raw value, a ref to the value, or a function that returns the value. In the lattermost case it will be wrapped in computed, turning it into a ref. The feature type will handle it being a ref or a raw value by using unref when accessing those values. With type hints, your IDE should correctly identify these values as refs or raw values so you can treat them as the types they actually are.

Because functions are automatically wrapped in computed for many properties, it might be expected to happen to custom properties you add to a feature that isn't defined by the feature type. These functions will not be wrapped, and if you want it cached you should wrap it in a computed yourself. This does, however, allow you to include custom methods on a feature without worry.

- diff --git a/guide/important-concepts/requirements.html b/guide/important-concepts/requirements.html index cee610ce..0d96e7d4 100644 --- a/guide/important-concepts/requirements.html +++ b/guide/important-concepts/requirements.html @@ -10,7 +10,7 @@ - + @@ -21,8 +21,8 @@ -
Profectus
On this page

Requirements ​

The requirements system in Profectus is designed to handle various conditions that must be met before certain actions or features can be accessed by the player. These conditions can include resource amounts, completed challenges, or other milestones within the game.

Creating Requirements ​

To create a requirement, you can use one of the provided utility functions like createCostRequirement, createVisibilityRequirement, or createBooleanRequirement. These functions return a Requirement object with specific properties that define the requirement conditions.

Using Requirements ​

Several features will have a requirements property that takes one or more requirements that must be fulfilled for a certain action to be performed with that feature.

When implementing requirements, you can use the displayRequirements utility. This utility is designed to give a human-readable string generated by the requirement(s) given, making it easier for players to understand the conditions needed to progress in the game. Typically features that support requirements will already use this utility internally.

You may need to "pay" requirements upon meeting their conditions and performing the associated action. This action typically involves spending resources or making other adjustments to the game state. The payRequirements function simplifies this process by handling the payment for one or more requirements, considering the number of levels to pay for. Additionally, custom pay functions like payByDivision and payByReset can be passed into createCostRequirement for more specialized cases.

Multi-Level Requirements ​

Requirements can have multiple "levels", which are typically used for things like multi-level challenges with scaling requirements. When checking if requirements are met, the requirementsMet function can be used. It accepts a single requirement or an array of requirements.

Requirements that are just on/off, such as boolean or visibility requirements, will count as infinite levels when in the same array. This allows you to combine different types of requirements in the same array and use the maxRequirementsMet function to calculate the maximum number of levels that could be acquired with the current requirement states.

- diff --git a/guide/index.html b/guide/index.html index 07490339..2177717c 100644 --- a/guide/index.html +++ b/guide/index.html @@ -10,7 +10,7 @@ - + @@ -21,8 +21,8 @@ -
Profectus
On this page

Introduction ​

Profectus is a web-based game engine. You can write your content using many built in features, write your own features, and build up complex gameplay quickly and easily.

The purpose of creating profectus was to create an easy to use engine that does not create a ceiling for a programmer's personal growth. This engine will grow in complexity with you, empowering you to create increasingly complex designs and mechanics.

Should you use Profectus? ​

While this engine is intended to make game development (and web app development) easier, it still requires you to be comfortable with programming in general and javascript in particular. Fortunately, that is a solvable problem.

If you've never used Javascript before, learn-js.org is a good resource for learning the important concepts. If you'd like a more thorough lesson on all the ins and outs of web development, javascript.info and MDN's tutorials should have you covered. MDN is also a great resource to use as a reference - for example, if you want to know more about something and you google it, there'll typically be a MDN link that'll explain it thoroughly.

Beyond the basics, Profectus uses a modern web development pipeline, using tools like node, typescript, and JSX. While most of it should be relatively easy to pick up through context, if this becomes too complicated you may be interested in The Modding Tree, a predecessor of Profectus that uses plain old javascript.

Alternative Engines ​

There are many popular game engines out there, such as GameMaker Studio 2, Unity3D, Unreal Engine 4, and Godot, that are all general purpose and also more useful if you're planning on going into a career in game development. These are all more mature and robust game engines compared to Profectus, and are used by actual game development studios.

Profectus, on the other hand, is a very opinionated engine that is better at specific types of projects. Where the above engines will require you to design and create your own interfaces, menus, save management systems, etc. Profectus will include those out of the box. Profectus will also output games that run natively in the browser, and will typically be easier for players to play than traditional engines.

If you are not interested in programming but still want to get into game development, the above engines also all support "visual programming", which may be more amenable to you. Each engine will have varying levels of support, and of course with varying complexities, but ultimately any of these will help you learn the concepts of programming and game development, and all of them also offer traditional programming for when you think you're ready.

Design Philosophies ​

While absolute purity is impossible, design decisions have been and will continue to be made using these principles in mind.

  • An engine should be intuitive, and code readable without context
  • An engine should not constrain a creator
  • An engine should be consistent
  • An engine should be extensible, and those extensions sharable
  • An engine should be efficient
  • An engine should report issues early and thoroughly
  • Passing by reference is one honking great idea -- let's do more of that!
- diff --git a/guide/recipes/particles.html b/guide/recipes/particles.html index 9bc98b70..245de23e 100644 --- a/guide/recipes/particles.html +++ b/guide/recipes/particles.html @@ -10,7 +10,7 @@ - + @@ -21,17 +21,17 @@ -
Profectus
On this page

Particles ​

This is a more complete example from the Kronos example used in the nodes docs. You will design a particle effect, make it appear on another feature, and make it adapt to the game state.

Let's start with designing the particle effect. Profectus uses pixi-particles, and there's an online particle effect editor for it here. However, it will return an older format of the particle effect emitter options, so you'll need to convert it like so:

ts
import myParticleEffect from "myParticleEffect.json";
+    
Profectus
On this page
Particles ​
This is a more comprehensive example based on the Kronos example used in the nodes docs. You will design a particle effect, make it appear on another feature, and ensure it adapts to the game state.
First, design the particle effect. Profectus uses pixi-particles, and you can use the online particle effect editor here. However, the editor returns an older format of the particle effect emitter config, so you'll need to convert it like this:
ts
import myParticleEffect from "myParticleEffect.json";
 import { upgradeConfig } from "@pixi/particle-emitter"
 
-const particleEffect = upgradeConfig(myParticleEffect);
Next we need to create the particles feature and render it. We'll also want to track the bounding rect of the particle effects. We'll consider the next step:
ts
const particles = createParticles(() => ({
+const particleEffect = upgradeConfig(myParticleEffect);
Next, create the particles feature and render it. You'll also want to track the bounding rect of the particle effects. Consider the following step:
ts
const particles = createParticles(() => ({
     fullscreen: false,
     zIndex: -1,
     boundingRect: ref<null | DOMRect>(null),
     onContainerResized(boundingRect) {
         this.boundingRect.value = boundingRect;
     }
-}));
You'll note this adds a bounding rect and updates it's based on the boundingRect set to non-null. The next step will be creating the emitter. Now we can pull in the Kronos example, which make a particle effect that appears when actualGain > 0.
ts
const particlesEmitter = ref(particles.addEmitter(element.particlesConfig));
+}));
This code adds a bounding rect for the particles and updates it when the container is created or resizes. Now, create the emitter. Pull in the Kronos example, which displays a particle effect when actualGain > 0.
ts
const particlesEmitter = ref(particles.addEmitter(element.particlesConfig));
 const updateParticleEffect = async ([shouldEmit, rect, boundingRect]: [
     boolean,
     DOMRect | undefined,
@@ -55,7 +55,7 @@
         particles.boundingRect
     ],
     updateParticleEffect
-)
You'll note this checks regularly whether the boundingRect exists. If you ensure all the references to things are being watched, youy can make complex situations for various emitters.
If you're hot reloading, it may be required to re-load the particle effect. Here's example code from Kronos.
ts
const refreshParticleEffect = () => {
+)
This code watches for whether the node exists and the boundingRect exists, which are required to display the effect. You can additionally watch any other values that would have an impact on the particle effect, like whether or not it should be emitting.
If you're using hot reloading, you might need to reload the particle effect. Here's an example from Kronos:
ts
const refreshParticleEffect = () => {
     particlesEmitter.value
         .then(e => e.destroy())
         .then(
@@ -69,8 +69,8 @@
                 particles.boundingRect.value
             ])
         );
-};

-    
     
   
diff --git a/guide/recipes/save-progress.html b/guide/recipes/save-progress.html
index 7645ebb2..1d77a8ca 100644
--- a/guide/recipes/save-progress.html
+++ b/guide/recipes/save-progress.html
@@ -10,7 +10,7 @@
     
   
   
-  
+  
   
   
   
@@ -42,8 +42,8 @@
     ><br />
     <div v-if="currentTime">Last played {{ dateFormat.format(currentTime) }}</div>
 ++  <div v-if="progressDisplay"><component :is="progressDisplay" /></div>
-</div>

And there you have it! Your dev environment should now show the component in all its glory in the saves manager.

- diff --git a/hashmap.json b/hashmap.json index fee1530d..75b9c9ff 100644 --- a/hashmap.json +++ b/hashmap.json @@ -1 +1 @@ -{"api_interfaces_game_state.transient.md":"9b93a3b5","api_interfaces_lib_pwa-register.registerswoptions.md":"410bf7a2","api_interfaces_util_vue.vuefeature.md":"01f2f21d","api_modules_data_common.md":"435662f2","api_modules_data_projentry.md":"c2e156b9","api_modules_data_themes.md":"77305c31","api_modules_features_achievements_achievementcomponent.md":"3d6fef57","api_modules_features_achievements_achievement.md":"a4408771","api_modules_features_action.md":"19d911c9","api_modules_features_bars_barcomponent.md":"85289c7c","api_modules_features_bars_bar.md":"e2e7802d","api_modules_features_boards_boardcomponent.md":"db30658c","api_modules_features_boards_boardlinkcomponent.md":"1046a1ee","api_modules_features_boards_boardnodecomponent.md":"5be89453","api_modules_features_boards_board.md":"db81d579","api_modules_features_challenges_challengecomponent.md":"e985608b","api_modules_features_challenges_challenge.md":"81a3e7d9","api_modules_features_clickables_clickablecomponent.md":"24e79a57","api_modules_features_clickables_clickable.md":"8f7ae4f9","api_modules_features_conversion.md":"251b951d","api_modules_features_grids_gridcellcomponent.md":"33efdb77","api_modules_features_grids_gridcomponent.md":"25740736","api_modules_features_grids_grid.md":"b68bc9a5","api_modules_features_hotkey.md":"bc733c26","api_modules_features_infoboxes_infoboxcomponent.md":"26a714ec","api_modules_features_infoboxes_infobox.md":"97ac6a69","api_modules_features_links_linkcomponent.md":"a7c0edf5","api_modules_features_links_linkscomponent.md":"e1028014","api_modules_features_resources_maindisplaycomponent.md":"209485b1","api_modules_features_resources_resourcecomponent.md":"c71dabc6","api_modules_features_resources_resource.md":"a7441b9e","api_modules_features_tabs_tabbuttoncomponent.md":"32f94f12","api_modules_features_tabs_tabcomponent.md":"db3fa930","api_modules_features_tabs_tabfamilycomponent.md":"8a06e9bf","api_modules_features_tabs_tab.md":"cbe8f60f","api_modules_features_tabs_tabfamily.md":"2ef6fdcb","api_modules_features_tooltips_tooltipcomponent.md":"22317b04","api_modules_features_tooltips_tooltip.md":"25104fdf","api_modules_features_trees_treecomponent.md":"77f79c83","api_modules_features_trees_treenodecomponent.md":"fed46f18","api_modules_features_trees_tree.md":"889d9cb9","api_modules_features_upgrades_upgradecomponent.md":"de8dd7d5","api_modules_game_events.md":"7be85787","api_modules_game_formulas_formulas.md":"cab0b567","api_modules_game_formulas_operations.md":"a5ad1c2f","api_modules_game_formulas_types.md":"99d5daf7","api_modules_game_gameloop.md":"a14a1b92","api_modules_game_layers.md":"7ee3d623","api_modules_game_modifiers.md":"123fe4fc","api_modules_game_notifications.md":"6faa4429","api_modules_game_persistence.md":"8cf5b173","api_modules_game_player.md":"d1bb543f","api_modules_game_requirements.md":"ecc7f3df","api_modules_game_settings.md":"6d845b69","api_modules_game_state.md":"c86e668c","api_modules_lib_break_eternity.md":"7a10eaa6","api_modules_lib_collapsetransition.md":"37a925e1","api_modules_lib_lru-cache.md":"ee23af86","api_modules_lib_pixi.md":"2b426252","api_modules_features_feature.md":"7a5eca69","api_modules_features_links_links.md":"5de1a01a","api_modules_features_upgrades_upgrade.md":"98e1167c","api_interfaces_features_boards_board.boardoptions.md":"027a5aef","api_interfaces_features_boards_board.nodelabel.md":"ca410803","api_interfaces_features_boards_board.nodetypeoptions.md":"633b58d0","api_interfaces_features_challenges_challenge.basechallenge.md":"cab2baa7","api_interfaces_features_challenges_challenge.challengeoptions.md":"3697b2d0","api_interfaces_features_clickables_clickable.baseclickable.md":"4194be50","api_interfaces_features_clickables_clickable.clickableoptions.md":"38b89983","api_interfaces_features_conversion.baseconversion.md":"5cd99eb1","api_interfaces_features_trees_tree.basetreenode.md":"6ff93233","api_interfaces_features_trees_tree.basetree.md":"071e07c3","api_modules_util_computed.md":"8c79a770","api_interfaces_features_boards_board.boardnodelink.md":"f51011a6","api_modules_util_vue.md":"5c3f1323","api_modules_util_proxies.md":"40d2071a","api_overview.md":"88cceb38","api_interfaces_features_boards_board.basenodetype.md":"f9aeae3e","api_interfaces_features_boards_board.boardnodeactionoptions.md":"339fab10","api_interfaces_features_grids_grid.gridoptions.md":"5d8ff64b","api_interfaces_features_hotkey.basehotkey.md":"d612cfce","api_interfaces_features_hotkey.hotkeyoptions.md":"c5110072","api_interfaces_features_infoboxes_infobox.baseinfobox.md":"e89fa27e","api_interfaces_features_infoboxes_infobox.infoboxoptions.md":"ad5967ef","api_interfaces_features_links_links.baselinks.md":"eebfe209","api_interfaces_features_tabs_tab.taboptions.md":"1a02d440","api_interfaces_features_links_links.linksoptions.md":"0e711c3a","api_interfaces_features_particles_particles.baseparticles.md":"cf816fdd","api_interfaces_features_particles_particles.particlesoptions.md":"67d30c88","api_interfaces_features_repeatable.baserepeatable.md":"f4db0ecd","api_interfaces_features_repeatable.repeatableoptions.md":"21bb1111","api_interfaces_features_reset.basereset.md":"2e8556d0","api_interfaces_features_reset.resetoptions.md":"2f5fd25e","api_interfaces_features_resources_resource.resource.md":"4bdd62cb","api_interfaces_features_tabs_tab.basetab.md":"1f7fdf1b","guide_advanced-concepts_dynamic-layers.md":"a5b2ad1d","guide_advanced-concepts_nodes.md":"f29b361a","guide_creating-your-project_changelog.md":"2ba9cb27","guide_creating-your-project_project-entry.md":"56be55a7","guide_creating-your-project_project-info.md":"9bccc4b8","guide_creating-your-project_themes.md":"5c750649","guide_creating-your-project_utils.md":"264c40cd","guide_getting-started_examples.md":"305530d8","guide_getting-started_setup.md":"036f5e9e","guide_getting-started_updating.md":"6193ab7a","guide_important-concepts_coercable.md":"025d8a15","guide_important-concepts_features.md":"1957772b","guide_important-concepts_formulas.md":"592f0311","guide_important-concepts_layers.md":"12789b41","guide_important-concepts_persistence.md":"e64f98b0","guide_important-concepts_reactivity.md":"bcec6c75","guide_important-concepts_requirements.md":"856b4ffd","guide_index.md":"02afca62","guide_recipes_particles.md":"30664cc1","guide_recipes_save-progress.md":"300c07f4","index.md":"6970eb14","api_interfaces_features_boards_board.boardnode.md":"cf6a9f07","api_interfaces_features_tabs_tabfamily.basetabbutton.md":"e63a6b14","api_interfaces_features_tabs_tabfamily.basetabfamily.md":"c0e867d5","api_interfaces_features_tabs_tabfamily.tabbuttonoptions.md":"c9f7090d","api_interfaces_features_tabs_tabfamily.tabfamilyoptions.md":"dcd840b4","api_interfaces_features_tooltips_tooltip.basetooltip.md":"ac0c5fd4","api_interfaces_features_tooltips_tooltip.tooltipoptions.md":"c02c958f","api_interfaces_features_trees_tree.treenodeoptions.md":"0208cb7e","api_interfaces_features_trees_tree.treeoptions.md":"662ae100","api_interfaces_features_upgrades_upgrade.baseupgrade.md":"259ee5ba","api_interfaces_features_upgrades_upgrade.upgradeoptions.md":"f7ddaed4","api_interfaces_game_events.globalevents.md":"4fb77cf2","api_interfaces_game_layers.baselayer.md":"5fd574f6","api_interfaces_game_layers.featurenode.md":"63d560af","api_interfaces_game_layers.layerevents.md":"eb3ef8a4","api_interfaces_game_layers.layeroptions.md":"f7c3a7ed","api_interfaces_game_layers.position.md":"92625afa","api_modules_util_save.md":"1b1d74da","api_interfaces_game_modifiers.exponentialmodifieroptions.md":"666c27c3","api_interfaces_game_settings.settings.md":"e1d4cf0c","api_interfaces_game_modifiers.modifier.md":"4a04a055","api_interfaces_game_modifiers.modifiersectionoptions.md":"55a2f406","api_interfaces_game_modifiers.multiplicativemodifieroptions.md":"8c9bc868","api_interfaces_game_player.player.md":"f547d1a8","api_interfaces_game_requirements.costrequirementoptions.md":"8768ed25","api_interfaces_game_requirements.requirement.md":"03ac28e6","api_modules_lib_pwa-register.md":"0067fcd5","api_interfaces_features_grids_grid.gridcell.md":"62ff3806","api_interfaces_features_grids_grid.basegrid.md":"19f9584b","guide_advanced-concepts_creating-features.md":"426efab2","api_components_hotkeycomponent.md":"dceff3ac","api_components_layercomponent.md":"1a86cca3","api_components_marknodecomponent.md":"23d08031","api_components_modalcomponent.md":"130cab7d","api_components_nodecomponent.md":"8a8fc540","api_components_savecomponent.md":"2ac07017","api_components_fields_dangerbuttoncomponent.md":"3259e0ab","api_components_fields_feedbackbuttoncomponent.md":"dd6b4910","api_components_fields_selectcomponent.md":"35cf9cc0","api_components_fields_slidercomponent.md":"ab61fc57","api_components_fields_togglecomponent.md":"f519e499","api_components_layout_collapsiblecomponent.md":"1fdca5de","api_components_layout_columncomponent.md":"c83cd2c5","api_components_layout_rowcomponent.md":"cb2610d0","api_components_layout_spacercomponent.md":"c5b42be9","api_components_layout_stickycomponent.md":"53bef21b","api_components_layout_verticalrulecomponent.md":"d9351eaa","api_components_math_floorcomponent.md":"da05e8cb","api_components_math_sqrtcomponent.md":"87bc6d21","api_enums_data_themes.themes.md":"b5796547","api_enums_features_achievements_achievement.achievementdisplay.md":"1982f962","api_enums_features_boards_board.progressdisplay.md":"d35ea581","api_enums_features_boards_board.shape.md":"990fd458","api_enums_util_common.direction.md":"0bdeb204","api_interfaces_game_modifiers.additivemodifieroptions.md":"6e335429","api_interfaces_data_common.layertreenodeoptions.md":"06b54ae6","api_interfaces_data_common.resetbuttonoptions.md":"7fcf71d7","api_classes_game_formulas_formulas.default.md":"7bbe151c","api_components_fields_textcomponent.md":"8fc37f4c","api_enums_features_feature.visibility.md":"e3f8ad05","api_classes_lib_break_eternity.default.md":"5982f2fb","api_classes_lib_lru-cache.lrucache.md":"4a3c08f5","api_components_contextcomponent.md":"d2aded5d","api_interfaces_data_common.section.md":"8ef32035","api_interfaces_data_themes.theme.md":"d66845d0","api_interfaces_data_themes.themevars.md":"79418824","api_interfaces_features_achievements_achievement.achievementoptions.md":"123460e9","api_interfaces_features_achievements_achievement.baseachievement.md":"a4c3dfaa","api_interfaces_features_action.actionoptions.md":"39efb739","api_interfaces_features_action.baseaction.md":"aa7fb5d4","api_interfaces_features_bars_bar.baroptions.md":"9f1017b9","api_interfaces_features_bars_bar.basebar.md":"5c701760","api_interfaces_features_boards_board.baseboard.md":"70c8ee23","api_interfaces_features_boards_board.baseboardnodeaction.md":"cc734bae","api_modules_lib_vue-panzoom.md":"bfc32ff5","api_interfaces_features_links_links.link.md":"4d6fe5f8","api_components_infocomponent.md":"29393227","api_modules_features_particles_particlescomponent.md":"e9b00afe","api_interfaces_features_conversion.conversionoptions.md":"221449e6","api_modules_lib_vue-textarea-autosize.md":"a92591ec","api_modules_util_bignum.md":"190d4017","api_modules_util_break_eternity.md":"7940bd72","api_modules_util_common.md":"71a18d40","api_interfaces_features_trees_tree.treebranch.md":"d8df8c3d","api_modules_features_particles_particles.md":"c84a0b31","api_modules_features_repeatable.md":"3d374383","api_modules_features_reset.md":"9695d33e"} +{"api_components_contextcomponent.md":"d2aded5d","api_components_layercomponent.md":"1a86cca3","api_components_hotkeycomponent.md":"dceff3ac","api_modules_util_break_eternity.md":"7940bd72","api_modules_util_common.md":"71a18d40","api_modules_util_computed.md":"8c79a770","api_modules_util_proxies.md":"40d2071a","api_modules_util_save.md":"1b1d74da","api_overview.md":"88cceb38","guide_advanced-concepts_creating-features.md":"4c37639d","guide_advanced-concepts_dynamic-layers.md":"f71d038a","guide_advanced-concepts_nodes.md":"7a309ab5","guide_creating-your-project_project-entry.md":"99e6dee7","guide_creating-your-project_project-info.md":"4c371e5e","guide_creating-your-project_themes.md":"ad0d91c8","guide_creating-your-project_utils.md":"b7441a18","guide_getting-started_examples.md":"9aa0f345","guide_getting-started_setup.md":"b8a9be2d","guide_getting-started_updating.md":"0e2b10bd","guide_important-concepts_coercable.md":"d6377a4d","guide_important-concepts_features.md":"09bfe05c","guide_important-concepts_reactivity.md":"ef52d055","guide_important-concepts_requirements.md":"fb6512c2","guide_index.md":"463f69d1","guide_recipes_save-progress.md":"77ef05d3","index.md":"a72140fb","api_components_infocomponent.md":"29393227","api_classes_game_formulas_formulas.default.md":"7bbe151c","api_components_modalcomponent.md":"130cab7d","api_modules_util_vue.md":"5c3f1323","guide_creating-your-project_changelog.md":"d1bc7baa","guide_important-concepts_formulas.md":"92a97105","api_components_nodecomponent.md":"8a8fc540","api_interfaces_data_themes.theme.md":"d66845d0","api_components_marknodecomponent.md":"23d08031","api_interfaces_features_achievements_achievement.baseachievement.md":"a4c3dfaa","api_interfaces_data_themes.themevars.md":"79418824","api_interfaces_features_action.actionoptions.md":"39efb739","api_components_fields_slidercomponent.md":"ab61fc57","api_components_fields_textcomponent.md":"8fc37f4c","api_components_layout_collapsiblecomponent.md":"1fdca5de","api_components_layout_columncomponent.md":"c83cd2c5","api_components_layout_rowcomponent.md":"cb2610d0","api_components_layout_spacercomponent.md":"c5b42be9","api_components_layout_stickycomponent.md":"53bef21b","api_components_layout_verticalrulecomponent.md":"d9351eaa","api_components_math_floorcomponent.md":"da05e8cb","api_interfaces_features_trees_tree.treenodeoptions.md":"0208cb7e","api_interfaces_features_trees_tree.treeoptions.md":"662ae100","api_interfaces_features_upgrades_upgrade.baseupgrade.md":"259ee5ba","api_interfaces_features_upgrades_upgrade.upgradeoptions.md":"f7ddaed4","api_interfaces_game_events.globalevents.md":"4fb77cf2","api_interfaces_game_layers.position.md":"92625afa","api_interfaces_game_modifiers.additivemodifieroptions.md":"6e335429","api_interfaces_game_modifiers.exponentialmodifieroptions.md":"666c27c3","api_interfaces_game_modifiers.modifier.md":"4a04a055","api_interfaces_game_modifiers.modifiersectionoptions.md":"55a2f406","api_interfaces_game_modifiers.multiplicativemodifieroptions.md":"8c9bc868","api_interfaces_game_player.player.md":"f547d1a8","api_interfaces_game_requirements.costrequirementoptions.md":"8768ed25","api_interfaces_game_requirements.requirement.md":"03ac28e6","api_interfaces_game_settings.settings.md":"e1d4cf0c","api_interfaces_game_state.transient.md":"9b93a3b5","api_interfaces_lib_pwa-register.registerswoptions.md":"410bf7a2","api_interfaces_util_vue.vuefeature.md":"01f2f21d","api_modules_data_common.md":"435662f2","api_modules_data_projentry.md":"c2e156b9","guide_important-concepts_layers.md":"5ce0f121","guide_important-concepts_persistence.md":"5574dcf4","api_interfaces_data_common.resetbuttonoptions.md":"7fcf71d7","api_modules_util_bignum.md":"190d4017","api_modules_lib_vue-textarea-autosize.md":"a92591ec","api_enums_data_themes.themes.md":"b5796547","api_enums_features_boards_board.progressdisplay.md":"d35ea581","api_enums_features_boards_board.shape.md":"990fd458","api_interfaces_data_common.layertreenodeoptions.md":"06b54ae6","api_interfaces_features_action.baseaction.md":"aa7fb5d4","api_interfaces_features_bars_bar.baroptions.md":"9f1017b9","guide_recipes_particles.md":"d4df0645","api_enums_features_achievements_achievement.achievementdisplay.md":"1982f962","api_interfaces_features_particles_particles.particlesoptions.md":"67d30c88","api_interfaces_features_achievements_achievement.achievementoptions.md":"123460e9","api_modules_data_themes.md":"77305c31","api_modules_features_achievements_achievementcomponent.md":"3d6fef57","api_modules_features_achievements_achievement.md":"a4408771","api_modules_features_action.md":"19d911c9","api_modules_features_bars_barcomponent.md":"85289c7c","api_modules_features_bars_bar.md":"e2e7802d","api_modules_features_boards_boardcomponent.md":"db30658c","api_modules_features_boards_boardlinkcomponent.md":"1046a1ee","api_modules_features_boards_boardnodecomponent.md":"5be89453","api_modules_features_boards_board.md":"db81d579","api_modules_lib_vue-panzoom.md":"bfc32ff5","api_modules_features_challenges_challengecomponent.md":"e985608b","api_modules_features_challenges_challenge.md":"81a3e7d9","api_modules_features_clickables_clickablecomponent.md":"24e79a57","api_modules_features_clickables_clickable.md":"8f7ae4f9","api_modules_features_conversion.md":"251b951d","api_modules_features_feature.md":"7a5eca69","api_modules_features_grids_gridcellcomponent.md":"33efdb77","api_modules_features_grids_gridcomponent.md":"25740736","api_modules_features_grids_grid.md":"b68bc9a5","api_modules_features_hotkey.md":"bc733c26","api_modules_features_infoboxes_infoboxcomponent.md":"26a714ec","api_modules_features_infoboxes_infobox.md":"97ac6a69","api_modules_features_links_linkcomponent.md":"a7c0edf5","api_modules_features_links_linkscomponent.md":"e1028014","api_modules_features_links_links.md":"5de1a01a","api_modules_features_particles_particlescomponent.md":"e9b00afe","api_modules_features_particles_particles.md":"c84a0b31","api_modules_features_repeatable.md":"3d374383","api_modules_features_reset.md":"9695d33e","api_modules_features_resources_maindisplaycomponent.md":"209485b1","api_modules_features_resources_resourcecomponent.md":"c71dabc6","api_modules_features_resources_resource.md":"a7441b9e","api_modules_features_tabs_tabbuttoncomponent.md":"32f94f12","api_modules_features_tabs_tabcomponent.md":"db3fa930","api_modules_features_tabs_tabfamilycomponent.md":"8a06e9bf","api_modules_features_tabs_tab.md":"cbe8f60f","api_modules_features_tabs_tabfamily.md":"2ef6fdcb","api_modules_features_tooltips_tooltip.md":"25104fdf","api_modules_features_trees_treecomponent.md":"77f79c83","api_modules_features_trees_treenodecomponent.md":"fed46f18","api_modules_features_trees_tree.md":"889d9cb9","api_modules_game_settings.md":"6d845b69","api_modules_game_state.md":"c86e668c","api_modules_lib_break_eternity.md":"7a10eaa6","api_modules_lib_collapsetransition.md":"37a925e1","api_modules_lib_lru-cache.md":"ee23af86","api_modules_lib_pixi.md":"2b426252","api_interfaces_features_particles_particles.baseparticles.md":"cf816fdd","api_enums_features_feature.visibility.md":"e3f8ad05","api_modules_features_tooltips_tooltipcomponent.md":"22317b04","api_enums_util_common.direction.md":"0bdeb204","api_components_savecomponent.md":"2ac07017","api_interfaces_features_trees_tree.basetreenode.md":"6ff93233","api_components_fields_selectcomponent.md":"35cf9cc0","api_classes_lib_break_eternity.default.md":"5982f2fb","api_interfaces_features_bars_bar.basebar.md":"5c701760","api_interfaces_features_boards_board.baseboard.md":"70c8ee23","api_interfaces_features_boards_board.baseboardnodeaction.md":"cc734bae","api_interfaces_features_boards_board.boardnode.md":"cf6a9f07","api_interfaces_features_boards_board.boardnodeactionoptions.md":"339fab10","api_interfaces_features_boards_board.boardnodelink.md":"f51011a6","api_modules_game_formulas_operations.md":"a5ad1c2f","api_interfaces_features_boards_board.boardoptions.md":"027a5aef","api_interfaces_features_boards_board.nodelabel.md":"ca410803","api_interfaces_features_boards_board.nodetypeoptions.md":"633b58d0","api_interfaces_features_challenges_challenge.challengeoptions.md":"3697b2d0","api_interfaces_features_clickables_clickable.baseclickable.md":"4194be50","api_interfaces_features_clickables_clickable.clickableoptions.md":"38b89983","api_interfaces_features_conversion.baseconversion.md":"5cd99eb1","api_interfaces_features_conversion.conversionoptions.md":"221449e6","api_interfaces_features_grids_grid.gridcell.md":"62ff3806","api_interfaces_features_grids_grid.gridoptions.md":"5d8ff64b","api_interfaces_features_hotkey.basehotkey.md":"d612cfce","api_interfaces_features_hotkey.hotkeyoptions.md":"c5110072","api_interfaces_features_infoboxes_infobox.baseinfobox.md":"e89fa27e","api_interfaces_features_infoboxes_infobox.infoboxoptions.md":"ad5967ef","api_interfaces_features_links_links.baselinks.md":"eebfe209","api_interfaces_features_links_links.linksoptions.md":"0e711c3a","api_classes_lib_lru-cache.lrucache.md":"4a3c08f5","api_interfaces_features_repeatable.repeatableoptions.md":"21bb1111","api_modules_game_formulas_types.md":"99d5daf7","api_interfaces_features_reset.basereset.md":"2e8556d0","api_interfaces_features_reset.resetoptions.md":"2f5fd25e","api_interfaces_features_resources_resource.resource.md":"4bdd62cb","api_interfaces_features_tabs_tab.basetab.md":"1f7fdf1b","api_interfaces_features_tabs_tab.taboptions.md":"1a02d440","api_interfaces_features_tabs_tabfamily.basetabbutton.md":"e63a6b14","api_interfaces_features_tabs_tabfamily.basetabfamily.md":"c0e867d5","api_interfaces_features_tabs_tabfamily.tabbuttonoptions.md":"c9f7090d","api_interfaces_features_tabs_tabfamily.tabfamilyoptions.md":"dcd840b4","api_interfaces_features_tooltips_tooltip.basetooltip.md":"ac0c5fd4","api_interfaces_features_tooltips_tooltip.tooltipoptions.md":"c02c958f","api_interfaces_features_trees_tree.basetree.md":"071e07c3","api_interfaces_data_common.section.md":"8ef32035","api_components_fields_dangerbuttoncomponent.md":"3259e0ab","api_components_fields_feedbackbuttoncomponent.md":"dd6b4910","api_modules_game_layers.md":"7ee3d623","api_modules_features_upgrades_upgrade.md":"98e1167c","api_modules_game_modifiers.md":"123fe4fc","api_modules_game_notifications.md":"6faa4429","api_modules_game_player.md":"d1bb543f","api_modules_game_requirements.md":"ecc7f3df","api_components_fields_togglecomponent.md":"f519e499","api_components_math_sqrtcomponent.md":"87bc6d21","api_interfaces_features_boards_board.basenodetype.md":"f9aeae3e","api_interfaces_features_challenges_challenge.basechallenge.md":"cab2baa7","api_interfaces_features_grids_grid.basegrid.md":"19f9584b","api_modules_game_events.md":"7be85787","api_interfaces_features_trees_tree.treebranch.md":"d8df8c3d","api_interfaces_game_layers.baselayer.md":"5fd574f6","api_modules_game_persistence.md":"8cf5b173","api_interfaces_game_layers.featurenode.md":"63d560af","api_interfaces_game_layers.layerevents.md":"eb3ef8a4","api_interfaces_game_layers.layeroptions.md":"f7c3a7ed","api_modules_lib_pwa-register.md":"0067fcd5","api_interfaces_features_links_links.link.md":"4d6fe5f8","api_modules_game_formulas_formulas.md":"cab0b567","api_modules_game_gameloop.md":"a14a1b92","api_modules_features_upgrades_upgradecomponent.md":"de8dd7d5","api_interfaces_features_repeatable.baserepeatable.md":"f4db0ecd"} diff --git a/index.html b/index.html index 01903620..4a09c5a5 100644 --- a/index.html +++ b/index.html @@ -10,7 +10,7 @@ - + @@ -22,7 +22,7 @@
Profectus

Profectus

A game engine that grows with you

Starts at your skill level and encourages your ambition to make your projects bigger and better.

Get Started
Learn More

Easy to Use

Everything is written to be as intuitive to use as possible, through consistent design.

Helpful

Built with TypeScript to guide you as you write. Seamlessly deploy your project with pre-configured github workflows, and more.

Incremental

Designed to actively encourage you to become better at programming. The engine will never limit you.

-