Skip to content
Profectus404
PAGE NOT FOUND
But if you don't change your direction, and if you keep looking, you may end up where you are heading.
404
But if you don't change your direction, and if you keep looking, you may end up where you are heading.
| Name | Type |
|---|---|
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>> |
| Name |
|---|
setMinimized |
• LayerTreeNodeOptions: Object
An object that configures a LayerTreeNode
| Name | Type | Description |
|---|---|---|
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. |
canClick? | Computable<boolean> | Whether or not this tree node can be clicked. |
classes? | Computable<Record<string, boolean>> | Dictionary of CSS classes to apply to this feature. |
color | Computable<string> | The color to display this tree node as |
display? | Computable<CoercableComponent> | The content to display in the tree node. Defaults to the layer's ID |
glowColor? | Computable<string> | The color of the glow effect shown to notify the user there's something to do with this node. |
layerID | string | The ID of the layer this tree node is associated with |
mark? | Computable<string | boolean> | Shows a marker on the corner of the feature. |
onClick? | (e?: MouseEvent | TouchEvent) => void | A function that is called when the tree node is clicked. |
onHold? | VoidFunction | A function that is called when the tree node is held down. |
reset? | GenericReset | A reset object attached to this node, used for propagating resets through the tree. |
style? | Computable<StyleValue> | CSS to apply to this feature. |
visibility? | Computable<boolean | Visibility> | Whether this tree node should be visible. |
profectus/src/data/common.tsx:175
• ResetButtonOptions: Object
An object that configures a ResetButton
| Name | Type | Description |
|---|---|---|
canClick? | Computable<boolean> | Whether or not this button can currently be clicked. Defaults to checking the current gain amount is greater than minimumGain |
classes? | Computable<Record<string, boolean>> | Dictionary of CSS classes to apply to this feature. |
conversion | GenericConversion | The conversion the button uses to calculate how much resources will be gained on click |
display? | Computable<CoercableComponent> | The content to display on the button. By default, this includes the reset description, and amount of currency to be gained. |
mark? | Computable<string | boolean> | Shows a marker on the corner of the feature. |
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. |
onClick? | (e?: MouseEvent | TouchEvent) => void | A function that is called when the clickable is clicked. |
onHold? | VoidFunction | A function that is called when the clickable is held down. |
resetDescription? | Computable<string> | Text to display on low conversion amounts, describing what "resetting" is in this context. Defaults to "Reset for ". |
resetTime? | Persistent<DecimalSource> | A persistent ref to track how much time has passed since the last time this tree node was reset. |
showNextAt? | Computable<boolean> | Whether or not to show how much currency would be required to make the gain amount increase. |
small? | boolean | Toggles a smaller design for the feature. |
style? | Computable<StyleValue> | CSS to apply to this feature. |
tree | GenericTree | The tree this reset button is apart of |
treeNode | GenericTreeNode | The specific tree node associated with this reset button |
visibility? | Computable<boolean | Visibility> | Whether this clickable should be visible. |
profectus/src/data/common.tsx:33
• Section: Object
An option object for a modifier display as a single section. *
| Name | Type | Description |
|---|---|---|
base? | Computable<DecimalSource> | The base value being modified. * |
baseText? | Computable<CoercableComponent> | The label to call the base amount. Defaults to "Base". * |
modifier | WithRequired<Modifier, "description"> | The modifier to be displaying in this section. * |
smallerIsBetter? | boolean | Determines if numbers larger or smaller than the base should be displayed as red. |
subtitle? | Computable<string> | A subtitle for this modifier, e.g. to explain the context for the modifier. * |
title | Computable<string> | The header for this modifier. * |
unit? | string | The unit of measurement for the base. * |
visible? | Computable<boolean> | Whether or not this section should be currently visible to the player. * |
profectus/src/data/common.tsx:240
Ƭ GenericLayerTreeNode: Replace<LayerTreeNode<LayerTreeNodeOptions>, { append?: ProcessedComputable<boolean> ; display: ProcessedComputable<CoercableComponent> }>
A type that matches any valid LayerTreeNode object.
profectus/src/data/common.tsx:200
Ƭ 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.
profectus/src/data/common.tsx:83
Ƭ 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.
| Name | Type |
|---|---|
T | extends LayerTreeNodeOptions |
profectus/src/data/common.tsx:192
Ƭ 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.
| Name | Type |
|---|---|
T | extends ResetButtonOptions |
profectus/src/data/common.tsx:70
â–¸ colorText(textToColor, color?): JSX.Element
Creates an HTML string for a span that writes some given text in a given color.
| Name | Type | Default value | Description |
|---|---|---|---|
textToColor | string | undefined | The content to change the color of |
color | string | "var(--accent2)" | The color to change the content to look like. Defaults to the current theme's accent 2 variable. |
JSX.Element
profectus/src/data/common.tsx:383
â–¸ createCollapsibleAchievements(achievements): Object
Creates a collapsible display of a list of achievements
| Name | Type | Description |
|---|---|---|
achievements | Record<string, GenericAchievement> | A dictionary of the achievements to display, inserted in the order from easiest to hardest |
Object
| Name | Type |
|---|---|
collapseAchievements | Persistent<boolean> |
display | JSXFunction |
profectus/src/data/common.tsx:391
â–¸ createCollapsibleModifierSections(sectionsFunc): [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.
| Name | Type | Description |
|---|---|---|
sectionsFunc | () => Section[] | A function that returns the sections to display. |
[JSXFunction, Persistent<Record<number, boolean>>]
profectus/src/data/common.tsx:264
â–¸ createFormulaPreview(formula, showPreview, previewAmount?): JSXFunction
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.
| Name | Type | Default value | Description |
|---|---|---|---|
formula | GenericFormula | undefined | The formula to display the result of. |
showPreview | Computable<boolean> | undefined | Whether or not to preview how the formula's result will change. |
previewAmount | Computable<DecimalSource> | 1 | The amount to add to the current formula's variable amount to preview the change in result. |
profectus/src/data/common.tsx:461
â–¸ createLayerTreeNode<T>(optionsFunc): LayerTreeNode<T>
Lazily creates a tree node that's associated with a specific layer, with the given options.
| Name | Type |
|---|---|
T | extends LayerTreeNodeOptions |
| Name | Type | Description |
|---|---|---|
optionsFunc | OptionsFunc<T> | A function that returns the options object for this tree node. |
profectus/src/data/common.tsx:212
â–¸ createResetButton<T>(optionsFunc): ResetButton<T>
Lazily creates a reset button with the given options.
| Name | Type |
|---|---|
T | extends ClickableOptions & ResetButtonOptions |
| Name | Type | Description |
|---|---|---|
optionsFunc | OptionsFunc<T> | A function that returns the options object for this reset button. |
ResetButton<T>
profectus/src/data/common.tsx:98
â–¸ 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.
| Name | Type | Description |
|---|---|---|
resource | Resource<DecimalSource> | The resource that will be increasing over time. |
rate | Computable<DecimalSource> | The rate at which the resource is increasing. |
target | Computable<DecimalSource> | The target amount of the resource to estimate the duration until. |
ComputedRef<string>
• Const hasWon: ComputedRef<boolean>
A computed ref whose value is true whenever the game is over.
profectus/src/data/projEntry.tsx:88
â–¸ 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.
| Name | Type | Description |
|---|---|---|
oldVersion | undefined | string | The version of the save being loaded in |
player | Partial<Player> | The save data being loaded in |
void
profectus/src/data/projEntry.tsx:98
â–¸ 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.
| Name | Type |
|---|---|
player | Partial<Player> |
• Themes: Object
An enum of all available themes and their internal IDs. The keys are their display names.
| Name | Type |
|---|---|
Aqua | "aqua" |
Classic | "classic" |
Nordic | "nordic" |
Paper | "paper" |
profectus/src/data/themes.ts:73
• Theme: Object
An object representing a theme the player can use to change the look of the game.
| Name | Type | Description |
|---|---|---|
floatingTabs | boolean | Whether or not tabs should "float" in the center of their container. |
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. |
showPin | boolean | Whether or not to show a pin icon on pinned tooltips. |
variables | ThemeVars | The values of the theme's CSS variables. |
profectus/src/data/themes.ts:24
• ThemeVars: Object
A object of all CSS variables determined by the current theme.
| Name | Type |
|---|---|
--accent1 | string |
--accent2 | string |
--accent3 | string |
--background | string |
--border-radius | string |
--bought | string |
--danger | string |
--feature-foreground | string |
--feature-margin | string |
--foreground | string |
--highlighted | string |
--link | string |
--locked | string |
--modal-border | string |
--outline | string |
--points | string |
--raised-background | string |
--tooltip-background | string |
profectus/src/data/themes.ts:2
• default: Record<Themes, Theme>
A dictionary of all available themes.
• AchievementDisplay: Object
Modes for only displaying some achievements.
| Name | Type |
|---|---|
All | "all" |
Configurable | "configurable" |
Incomplete | "incomplete" |
None | "none" |
profectus/src/features/achievements/achievement.tsx:51
• AchievementOptions: Object
An object that configures an Achievement.
| Name | Type | Description |
|---|---|---|
classes? | Computable<Record<string, boolean>> | Dictionary of CSS classes to apply to this feature. |
display? | Computable<CoercableComponent | { effectDisplay?: CoercableComponent ; optionsDisplay?: CoercableComponent ; requirement?: CoercableComponent }> | The display to use for this achievement. |
image? | Computable<string> | An image to display as the background for this achievement. |
mark? | Computable<string | boolean> | Shows a marker on the corner of the feature. |
onComplete? | VoidFunction | A function that is called when the achievement is completed. |
requirements? | Requirements | The requirement(s) to earn this achievement. Can be left null if using complete. |
showPopups? | Computable<boolean> | Whether or not to display a notification popup when this achievement is earned. |
small? | Computable<boolean> | Toggles a smaller design for the feature. |
style? | Computable<StyleValue> | CSS to apply to this feature. |
visibility? | Computable<boolean | Visibility> | Whether this achievement should be visible. |
profectus/src/features/achievements/achievement.tsx:62
• BaseAchievement: Object
The properties that are added onto a processed AchievementOptions to create an Achievement.
| Name | Type | Description |
|---|---|---|
[Component] | GenericComponent | The Vue component used to render this feature. |
[GatherProps] | () => Record<string, unknown> | A function to gather the props the vue component requires for this feature. |
complete | VoidFunction | A function to complete this achievement. |
earned | Persistent<boolean> | Whether or not this achievement has been earned. |
id | string | An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates. |
type | typeof AchievementType | A symbol that helps identify features of the same type. |
profectus/src/features/achievements/achievement.tsx:98
Ƭ 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.
| Name | Type |
|---|---|
T | extends AchievementOptions |
profectus/src/features/achievements/achievement.tsx:114
Ƭ GenericAchievement: Replace<Achievement<AchievementOptions>, { showPopups: ProcessedComputable<boolean> ; visibility: ProcessedComputable<Visibility | boolean> }>
A type that matches any valid Achievement object.
profectus/src/features/achievements/achievement.tsx:128
• Const AchievementType: typeof AchievementType
A symbol used to identify Achievement features.
profectus/src/features/achievements/achievement.tsx:48
â–¸ createAchievement<T>(optionsFunc?, ...decorators): Achievement<T>
Lazily creates an achievement with the given options.
| Name | Type |
|---|---|
T | extends AchievementOptions |
| Name | Type | Description |
|---|---|---|
optionsFunc? | OptionsFunc<T, BaseAchievement, GenericAchievement> | Achievement options. |
...decorators | GenericDecorator[] | - |
Achievement<T>
profectus/src/features/achievements/achievement.tsx:140
| Name | Type |
|---|---|
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 |
• ActionOptions: Object
An object that configures an Action.
| Name | Type | Description |
|---|---|---|
autoStart? | Computable<boolean> | Whether or not the action should perform automatically when the cooldown is finished. |
barOptions? | Partial<BarOptions> | A pass-through to the Bar used to display the cooldown progress for the action. |
canClick? | Computable<boolean> | Whether or not the clickable may be clicked. |
classes? | Computable<Record<string, boolean>> | Dictionary of CSS classes to apply to this feature. |
display? | Computable<CoercableComponent | { description: CoercableComponent ; title?: CoercableComponent }> | The display to use for this clickable. |
duration | Computable<DecimalSource> | The cooldown during which the action cannot be performed again, in seconds. |
mark? | Computable<string | boolean> | Shows a marker on the corner of the feature. |
onClick | (amount: DecimalSource) => void | A function that is called when the action is clicked. |
small? | boolean | Toggles a smaller design for the feature. |
style? | Computable<StyleValue> | CSS to apply to this feature. |
visibility? | Computable<boolean | Visibility> | Whether this clickable should be visible. |
profectus/src/features/action.tsx:42
• BaseAction: Object
The properties that are added onto a processed ActionOptions to create an Action.
| Name | Type | Description |
|---|---|---|
[Component] | GenericComponent | The Vue component used to render this feature. |
[GatherProps] | () => Record<string, unknown> | A function to gather the props the vue component requires for this feature. |
id | string | An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates. |
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. |
progress | Ref<DecimalSource> | The current amount of progress through the cooldown. |
progressBar | GenericBar | The bar used to display the current cooldown progress. |
type | typeof ActionType | A symbol that helps identify features of the same type. |
update | (diff: number) => void | Update the cooldown the specified number of seconds |
profectus/src/features/action.tsx:56
Ƭ 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 represents a feature that can be clicked upon, and then has a cooldown before it can be clicked again.
| Name | Type |
|---|---|
T | extends ActionOptions |
profectus/src/features/action.tsx:76
Ƭ GenericAction: Replace<Action<ActionOptions>, { autoStart: ProcessedComputable<boolean> ; canClick: ProcessedComputable<boolean> ; visibility: ProcessedComputable<Visibility | boolean> }>
A type that matches any valid Action object.
profectus/src/features/action.tsx:92
• Const ActionType: typeof ActionType
A symbol used to identify Action features.
profectus/src/features/action.tsx:37
â–¸ createAction<T>(optionsFunc?, ...decorators): Action<T>
Lazily creates an action with the given options.
| Name | Type |
|---|---|
T | extends ActionOptions<T> |
| Name | Type | Description |
|---|---|---|
optionsFunc? | OptionsFunc<T, BaseAction, GenericAction> | Action options. |
...decorators | GenericDecorator[] | - |
Action<T>
• BarOptions: Object
An object that configures a Bar.
| Name | Type | Description |
|---|---|---|
baseStyle? | Computable<StyleValue> | CSS to apply to the bar's base. |
borderStyle? | Computable<StyleValue> | CSS to apply to the bar's border. |
classes? | Computable<Record<string, boolean>> | Dictionary of CSS classes to apply to this feature. |
direction | Computable<Direction> | The direction in which the bar progresses. |
display? | Computable<CoercableComponent> | The display to use for this bar. |
fillStyle? | Computable<StyleValue> | CSS to apply to the bar's fill. |
height | Computable<number> | The height of the bar. |
mark? | Computable<string | boolean> | Shows a marker on the corner of the feature. |
progress | Computable<DecimalSource> | The progress value of the bar, from 0 to 1. |
style? | Computable<StyleValue> | CSS to apply to this feature. |
textStyle? | Computable<StyleValue> | CSS to apply to the bar's text. |
visibility? | Computable<boolean | Visibility> | Whether this bar should be visible. |
width | Computable<number> | The width of the bar. |
profectus/src/features/bars/bar.ts:29
• BaseBar: Object
The properties that are added onto a processed BarOptions to create a Bar.
| Name | Type | Description |
|---|---|---|
[Component] | GenericComponent | The Vue component used to render this feature. |
[GatherProps] | () => Record<string, unknown> | A function to gather the props the vue component requires for this feature. |
id | string | An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates. |
type | typeof BarType | A symbol that helps identify features of the same type. |
profectus/src/features/bars/bar.ts:61
Ƭ 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.
| Name | Type |
|---|---|
T | extends BarOptions |
profectus/src/features/bars/bar.ts:73
Ƭ GenericBar: Replace<Bar<BarOptions>, { visibility: ProcessedComputable<Visibility | boolean> }>
A type that matches any valid Bar object.
profectus/src/features/bars/bar.ts:93
• Const BarType: typeof BarType
A symbol used to identify Bar features.
profectus/src/features/bars/bar.ts:24
â–¸ createBar<T>(optionsFunc, ...decorators): Bar<T>
Lazily creates a bar with the given options.
| Name | Type |
|---|---|
T | extends BarOptions |
| Name | Type | Description |
|---|---|---|
optionsFunc | OptionsFunc<T, BaseBar, GenericBar> | Bar options. |
...decorators | GenericDecorator[] | - |
Bar<T>
profectus/src/features/bars/bar.ts:104
| Name | Type |
|---|---|
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 |
• ProgressDisplay: Object
Ways to display progress of an action with a duration.
| Name | Type |
|---|---|
Fill | "Fill" |
Outline | "Outline" |
profectus/src/features/boards/board.ts:41
• Shape: Object
Node shapes.
| Name | Type |
|---|---|
Circle | "Circle" |
Diamond | "Triangle" |
profectus/src/features/boards/board.ts:47
• BaseBoard: Object
The properties that are added onto a processed BoardOptions to create a Board.
| Name | Type | Description |
|---|---|---|
[Component] | GenericComponent | The Vue component used to render this feature. |
[GatherProps] | () => Record<string, unknown> | A function to gather the props the vue component requires for this feature. |
draggingNode | Ref<null | BoardNode> | The currently being dragged node, if any. |
id | string | An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates. |
mousePosition | Ref<null | { x: number ; y: number }> | The current mouse position, if over the board. |
nodes | Ref<BoardNode[]> | All the nodes currently on the board. |
placeInAvailableSpace | (node: BoardNode, radius?: number, direction?: Direction) => void | Places a node in the nearest empty space in the given direction with the specified space around it. |
receivingNode | Ref<null | BoardNode> | If dragging a node, the node it's currently being hovered over, if any. |
selectedAction | Ref<null | GenericBoardNodeAction> | The currently selected action, if any. |
selectedNode | Ref<null | BoardNode> | The currently selected node, if any. |
type | typeof BoardType | A symbol that helps identify features of the same type. |
profectus/src/features/boards/board.ts:254
• BaseBoardNodeAction: Object
The properties that are added onto a processed BoardNodeActionOptions to create an BoardNodeAction.
| Name | Type |
|---|---|
links? | Ref<BoardNodeLink[]> |
profectus/src/features/boards/board.ts:201
• BaseNodeType: Object
The properties that are added onto a processed NodeTypeOptions to create a NodeType.
| Name | Type | Description |
|---|---|---|
nodes | Ref<BoardNode[]> | The nodes currently on the board of this type. |
profectus/src/features/boards/board.ts:134
• BoardNode: Object
An object representing a node on the board.
| Name | Type |
|---|---|
id | number |
pinned? | boolean |
position | { x: number ; y: number } |
position.x | number |
position.y | number |
state? | State |
type | string |
profectus/src/features/boards/board.ts:53
• BoardNodeActionOptions: Object
An object that configures a BoardNodeAction.
| Name | Type | Description |
|---|---|---|
confirmationLabel? | NodeComputable<NodeLabel, []> | The confirmation label that appears under the action. |
fillColor? | NodeComputable<string, []> | The fill color of the action. |
icon | NodeComputable<string, []> | The icon to display for the action. |
id | string | A unique identifier for the action. |
links? | NodeComputable<BoardNodeLink[], []> | An array of board node links associated with the action. They appear when the action is focused. |
onClick | (node: BoardNode) => void | A function that is called when the action is clicked. |
tooltip | NodeComputable<NodeLabel, []> | The tooltip text to display for the action. |
visibility? | NodeComputable<boolean | Visibility, []> | Whether this action should be visible. |
profectus/src/features/boards/board.ts:179
• BoardNodeLink: Object
An object representing a link between two nodes on the board.
| Name | Type | Description |
|---|---|---|
accent-height? | Numberish | - |
accumulate? | "none" | "sum" | - |
additive? | "sum" | "replace" | - |
alignment-baseline? | "alphabetic" | "hanging" | "ideographic" | "mathematical" | "auto" | "baseline" | "before-edge" | "text-before-edge" | "middle" | "central" | "after-edge" | "text-after-edge" | "inherit" | - |
allowReorder? | "no" | "yes" | - |
alphabetic? | Numberish | - |
amplitude? | Numberish | - |
arabic-form? | "initial" | "medial" | "terminal" | "isolated" | - |
aria-activedescendant? | string | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
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. |
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. |
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. |
aria-checked? | Booleanish | "mixed" | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. See - aria-pressed - aria-selected. |
aria-colcount? | Numberish | Defines the total number of columns in a table, grid, or treegrid. See aria-colindex. |
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. |
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. |
aria-controls? | string | Identifies the element (or elements) whose contents or presence are controlled by the current element. See aria-owns. |
aria-current? | "time" | Booleanish | "page" | "step" | "location" | "date" | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby? | string | Identifies the element (or elements) that describes the object. See aria-labelledby |
aria-details? | string | Identifies the element that provides a detailed, extended description for the object. See aria-describedby. |
aria-disabled? | Booleanish | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. See - aria-hidden - aria-readonly. |
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 |
aria-errormessage? | string | Identifies the element that provides an error message for the object. See - aria-invalid - aria-describedby. |
aria-expanded? | Booleanish | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
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. |
aria-grabbed? | Booleanish | Indicates an element's "grabbed" state in a drag-and-drop operation. Deprecated in ARIA 1.1 |
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. |
aria-hidden? | Booleanish | Indicates whether the element is exposed to an accessibility API. See aria-disabled. |
aria-invalid? | Booleanish | "grammar" | "spelling" | Indicates the entered value does not conform to the format expected by the application. See aria-errormessage. |
aria-keyshortcuts? | string | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label? | string | Defines a string value that labels the current element. See aria-labelledby. |
aria-labelledby? | string | Identifies the element (or elements) that labels the current element. See aria-describedby. |
aria-level? | Numberish | Defines the hierarchical level of an element within a structure. |
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. |
aria-modal? | Booleanish | Indicates whether an element is modal when displayed. |
aria-multiline? | Booleanish | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable? | Booleanish | Indicates that the user may select more than one item from the current selectable descendants. |
aria-orientation? | "horizontal" | "vertical" | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. |
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. |
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. |
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. |
aria-pressed? | Booleanish | "mixed" | Indicates the current "pressed" state of toggle buttons. See - aria-checked - aria-selected. |
aria-readonly? | Booleanish | Indicates that the element is not editable, but is otherwise operable. See aria-disabled. |
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. |
aria-required? | Booleanish | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription? | string | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount? | Numberish | Defines the total number of rows in a table, grid, or treegrid. See aria-rowindex. |
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. |
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. |
aria-selected? | Booleanish | Indicates the current "selected" state of various widgets. See - aria-checked - aria-pressed. |
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. |
aria-sort? | "none" | "ascending" | "descending" | "other" | Indicates if items in a table or grid are sorted in ascending or descending order. |
aria-valuemax? | Numberish | Defines the maximum allowed value for a range widget. |
aria-valuemin? | Numberish | Defines the minimum allowed value for a range widget. |
aria-valuenow? | Numberish | Defines the current value for a range widget. See aria-valuetext. |
aria-valuetext? | string | Defines the human readable text alternative of aria-valuenow for a range widget. |
ascent? | Numberish | - |
attributeName? | string | - |
attributeType? | string | - |
autoReverse? | Numberish | - |
azimuth? | Numberish | - |
baseFrequency? | Numberish | - |
baseProfile? | Numberish | - |
baseline-shift? | Numberish | - |
bbox? | Numberish | - |
begin? | Numberish | - |
bias? | Numberish | - |
by? | Numberish | - |
calcMode? | Numberish | - |
cap-height? | Numberish | - |
class? | any | SVG Styling Attributes See https://www.w3.org/TR/SVG/styling.html#ElementSpecificStyling |
clip? | Numberish | - |
clip-path? | string | - |
clip-rule? | Numberish | - |
clipPathUnits? | Numberish | - |
color? | string | - |
color-interpolation? | Numberish | - |
color-interpolation-filters? | "auto" | "inherit" | "sRGB" | "linearRGB" | - |
color-profile? | Numberish | - |
color-rendering? | Numberish | - |
contentScriptType? | Numberish | - |
contentStyleType? | Numberish | - |
cursor? | Numberish | - |
cx? | Numberish | - |
cy? | Numberish | - |
d? | string | - |
decelerate? | Numberish | - |
descent? | Numberish | - |
diffuseConstant? | Numberish | - |
direction? | Numberish | - |
display? | Numberish | - |
divisor? | Numberish | - |
dominant-baseline? | Numberish | - |
dur? | Numberish | - |
dx? | Numberish | - |
dy? | Numberish | - |
edgeMode? | Numberish | - |
elevation? | Numberish | - |
enable-background? | Numberish | - |
end? | Numberish | - |
endNode | BoardNode | - |
exponent? | Numberish | - |
externalResourcesRequired? | Numberish | - |
fill? | string | - |
fill-opacity? | Numberish | - |
fill-rule? | "inherit" | "nonzero" | "evenodd" | - |
filter? | string | - |
filterRes? | Numberish | - |
filterUnits? | Numberish | - |
flood-color? | Numberish | - |
flood-opacity? | Numberish | - |
focusable? | Numberish | - |
font-family? | string | - |
font-size? | Numberish | - |
font-size-adjust? | Numberish | - |
font-stretch? | Numberish | - |
font-style? | Numberish | - |
font-variant? | Numberish | - |
font-weight? | Numberish | - |
format? | Numberish | - |
from? | Numberish | - |
fx? | Numberish | - |
fy? | Numberish | - |
g1? | Numberish | - |
g2? | Numberish | - |
glyph-name? | Numberish | - |
glyph-orientation-horizontal? | Numberish | - |
glyph-orientation-vertical? | Numberish | - |
glyphRef? | Numberish | - |
gradientTransform? | string | - |
gradientUnits? | string | - |
hanging? | Numberish | - |
height? | Numberish | - |
horiz-adv-x? | Numberish | - |
horiz-origin-x? | Numberish | - |
href? | string | - |
id? | string | - |
ideographic? | Numberish | - |
image-rendering? | Numberish | - |
in? | string | - |
in2? | Numberish | - |
innerHTML? | string | - |
intercept? | Numberish | - |
k? | Numberish | - |
k1? | Numberish | - |
k2? | Numberish | - |
k3? | Numberish | - |
k4? | Numberish | - |
kernelMatrix? | Numberish | - |
kernelUnitLength? | Numberish | - |
kerning? | Numberish | - |
keyPoints? | Numberish | - |
keySplines? | Numberish | - |
keyTimes? | Numberish | - |
lang? | string | - |
lengthAdjust? | Numberish | - |
letter-spacing? | Numberish | - |
lighting-color? | Numberish | - |
limitingConeAngle? | Numberish | - |
local? | Numberish | - |
marker-end? | string | - |
marker-mid? | string | - |
marker-start? | string | - |
markerHeight? | Numberish | - |
markerUnits? | Numberish | - |
markerWidth? | Numberish | - |
mask? | string | - |
maskContentUnits? | Numberish | - |
maskUnits? | Numberish | - |
mathematical? | Numberish | - |
max? | Numberish | - |
media? | string | - |
method? | string | - |
min? | Numberish | - |
mode? | Numberish | - |
name? | string | - |
numOctaves? | Numberish | - |
offset? | Numberish | - |
offsetEnd? | Position | - |
offsetStart? | Position | - |
onAbort? | (payload: Event) => void | - |
onAnimationend? | (payload: AnimationEvent) => void | - |
onAnimationiteration? | (payload: AnimationEvent) => void | - |
onAnimationstart? | (payload: AnimationEvent) => void | - |
onAuxclick? | (payload: MouseEvent) => void | - |
onBeforeinput? | (payload: Event) => void | - |
onBlur? | (payload: FocusEvent) => void | - |
onCanplay? | (payload: Event) => void | - |
onCanplaythrough? | (payload: Event) => void | - |
onChange? | (payload: Event) => void | - |
onClick? | (payload: MouseEvent) => void | - |
onCompositionend? | (payload: CompositionEvent) => void | - |
onCompositionstart? | (payload: CompositionEvent) => void | - |
onCompositionupdate? | (payload: CompositionEvent) => void | - |
onContextmenu? | (payload: MouseEvent) => void | - |
onCopy? | (payload: ClipboardEvent) => void | - |
onCut? | (payload: ClipboardEvent) => void | - |
onDblclick? | (payload: MouseEvent) => void | - |
onDrag? | (payload: DragEvent) => void | - |
onDragend? | (payload: DragEvent) => void | - |
onDragenter? | (payload: DragEvent) => void | - |
onDragexit? | (payload: DragEvent) => void | - |
onDragleave? | (payload: DragEvent) => void | - |
onDragover? | (payload: DragEvent) => void | - |
onDragstart? | (payload: DragEvent) => void | - |
onDrop? | (payload: DragEvent) => void | - |
onDurationchange? | (payload: Event) => void | - |
onEmptied? | (payload: Event) => void | - |
onEncrypted? | (payload: Event) => void | - |
onEnded? | (payload: Event) => void | - |
onError? | (payload: Event) => void | - |
onFocus? | (payload: FocusEvent) => void | - |
onFocusin? | (payload: FocusEvent) => void | - |
onFocusout? | (payload: FocusEvent) => void | - |
onInput? | (payload: Event) => void | - |
onInvalid? | (payload: Event) => void | - |
onKeydown? | (payload: KeyboardEvent) => void | - |
onKeypress? | (payload: KeyboardEvent) => void | - |
onKeyup? | (payload: KeyboardEvent) => void | - |
onLoad? | (payload: Event) => void | - |
onLoadeddata? | (payload: Event) => void | - |
onLoadedmetadata? | (payload: Event) => void | - |
onLoadstart? | (payload: Event) => void | - |
onMousedown? | (payload: MouseEvent) => void | - |
onMouseenter? | (payload: MouseEvent) => void | - |
onMouseleave? | (payload: MouseEvent) => void | - |
onMousemove? | (payload: MouseEvent) => void | - |
onMouseout? | (payload: MouseEvent) => void | - |
onMouseover? | (payload: MouseEvent) => void | - |
onMouseup? | (payload: MouseEvent) => void | - |
onPaste? | (payload: ClipboardEvent) => void | - |
onPause? | (payload: Event) => void | - |
onPlay? | (payload: Event) => void | - |
onPlaying? | (payload: Event) => void | - |
onPointercancel? | (payload: PointerEvent) => void | - |
onPointerdown? | (payload: PointerEvent) => void | - |
onPointerenter? | (payload: PointerEvent) => void | - |
onPointerleave? | (payload: PointerEvent) => void | - |
onPointermove? | (payload: PointerEvent) => void | - |
onPointerout? | (payload: PointerEvent) => void | - |
onPointerover? | (payload: PointerEvent) => void | - |
onPointerup? | (payload: PointerEvent) => void | - |
onProgress? | (payload: Event) => void | - |
onRatechange? | (payload: Event) => void | - |
onReset? | (payload: Event) => void | - |
onScroll? | (payload: UIEvent) => void | - |
onSeeked? | (payload: Event) => void | - |
onSeeking? | (payload: Event) => void | - |
onSelect? | (payload: Event) => void | - |
onStalled? | (payload: Event) => void | - |
onSubmit? | (payload: Event) => void | - |
onSuspend? | (payload: Event) => void | - |
onTimeupdate? | (payload: Event) => void | - |
onTouchcancel? | (payload: TouchEvent) => void | - |
onTouchend? | (payload: TouchEvent) => void | - |
onTouchmove? | (payload: TouchEvent) => void | - |
onTouchstart? | (payload: TouchEvent) => void | - |
onTransitionend? | (payload: TransitionEvent) => void | - |
onTransitionstart? | (payload: TransitionEvent) => void | - |
onVolumechange? | (payload: Event) => void | - |
onWaiting? | (payload: Event) => void | - |
onWheel? | (payload: WheelEvent) => void | - |
opacity? | Numberish | - |
operator? | Numberish | - |
order? | Numberish | - |
orient? | Numberish | - |
orientation? | Numberish | - |
origin? | Numberish | - |
overflow? | Numberish | - |
overline-position? | Numberish | - |
overline-thickness? | Numberish | - |
paint-order? | Numberish | - |
panose-1? | Numberish | - |
pathLength? | Numberish | - |
patternContentUnits? | string | - |
patternTransform? | Numberish | - |
patternUnits? | string | - |
pointer-events? | Numberish | - |
points? | string | - |
pointsAtX? | Numberish | - |
pointsAtY? | Numberish | - |
pointsAtZ? | Numberish | - |
preserveAlpha? | Numberish | - |
preserveAspectRatio? | string | - |
primitiveUnits? | Numberish | - |
pulsing? | boolean | - |
r? | Numberish | - |
radius? | Numberish | - |
refX? | Numberish | - |
refY? | Numberish | - |
renderingIntent? | Numberish | - |
repeatCount? | Numberish | - |
repeatDur? | Numberish | - |
requiredExtensions? | Numberish | - |
requiredFeatures? | Numberish | - |
restart? | Numberish | - |
result? | string | - |
role? | string | - |
rotate? | Numberish | - |
rx? | Numberish | - |
ry? | Numberish | - |
scale? | Numberish | - |
seed? | Numberish | - |
shape-rendering? | Numberish | - |
slope? | Numberish | - |
spacing? | Numberish | - |
specularConstant? | Numberish | - |
specularExponent? | Numberish | - |
speed? | Numberish | - |
spreadMethod? | string | - |
startNode | BoardNode | - |
startOffset? | Numberish | - |
stdDeviation? | Numberish | - |
stemh? | Numberish | - |
stemv? | Numberish | - |
stitchTiles? | Numberish | - |
stop-color? | string | - |
stop-opacity? | Numberish | - |
strikethrough-position? | Numberish | - |
strikethrough-thickness? | Numberish | - |
string? | Numberish | - |
stroke | string | - |
stroke-dasharray? | Numberish | - |
stroke-dashoffset? | Numberish | - |
stroke-linecap? | "inherit" | "butt" | "round" | "square" | - |
stroke-linejoin? | "inherit" | "round" | "miter" | "bevel" | - |
stroke-miterlimit? | Numberish | - |
stroke-opacity? | Numberish | - |
stroke-width? | Numberish | - |
strokeWidth | number | - |
style? | string | CSSProperties | - |
surfaceScale? | Numberish | - |
systemLanguage? | Numberish | - |
tabindex? | Numberish | - |
tableValues? | Numberish | - |
target? | string | - |
targetX? | Numberish | - |
targetY? | Numberish | - |
text-anchor? | string | - |
text-decoration? | Numberish | - |
text-rendering? | Numberish | - |
textLength? | Numberish | - |
to? | Numberish | - |
transform? | string | - |
type? | string | - |
u1? | Numberish | - |
u2? | Numberish | - |
underline-position? | Numberish | - |
underline-thickness? | Numberish | - |
unicode? | Numberish | - |
unicode-bidi? | Numberish | - |
unicode-range? | Numberish | - |
unitsPer-em? | Numberish | - |
v-alphabetic? | Numberish | - |
v-hanging? | Numberish | - |
v-ideographic? | Numberish | - |
v-mathematical? | Numberish | - |
values? | string | - |
vector-effect? | Numberish | - |
version? | string | - |
vert-adv-y? | Numberish | - |
vert-origin-x? | Numberish | - |
vert-origin-y? | Numberish | - |
viewBox? | string | - |
viewTarget? | Numberish | - |
visibility? | Numberish | - |
width? | Numberish | - |
widths? | Numberish | - |
word-spacing? | Numberish | - |
writing-mode? | Numberish | - |
x? | Numberish | - |
x-height? | Numberish | - |
x1? | Numberish | - |
x2? | Numberish | - |
xChannelSelector? | string | - |
xlinkActuate? | string | - |
xlinkArcrole? | string | - |
xlinkHref? | string | - |
xlinkRole? | string | - |
xlinkShow? | string | - |
xlinkTitle? | string | - |
xlinkType? | string | - |
xmlns? | string | - |
y? | Numberish | - |
y1? | Numberish | - |
y2? | Numberish | - |
yChannelSelector? | string | - |
z? | Numberish | - |
zoomAndPan? | string | - |
profectus/src/features/boards/board.ts:65
• BoardOptions: Object
An object that configures a Board.
| Name | Type | Description |
|---|---|---|
classes? | Computable<Record<string, boolean>> | Dictionary of CSS classes to apply to this feature. |
height? | Computable<string> | The height of the board. Defaults to 100% |
links? | Computable<null | BoardNodeLink[]> | An array of board node links to display. |
startNodes | () => Omit<BoardNode, "id">[] | A function that returns an array of initial board nodes, without IDs. |
state? | Computable<BoardData> | The persistent state of the board. |
style? | Computable<StyleValue> | CSS to apply to this feature. |
types | Record<string, NodeTypeOptions> | A dictionary of node types that can appear on the board. |
visibility? | Computable<boolean | Visibility> | Whether this board should be visible. |
width? | Computable<string> | The width of the board. Defaults to 100% |
profectus/src/features/boards/board.ts:230
• NodeLabel: Object
An object representing a label for a node.
| Name | Type |
|---|---|
color? | string |
pulsing? | boolean |
text | string |
profectus/src/features/boards/board.ts:74
• NodeTypeOptions: Object
An object that configures a NodeType.
| Name | Type | Description |
|---|---|---|
actionDistance? | NodeComputable<number, []> | The distance between the center of the node and its actions. |
actions? | BoardNodeActionOptions[] | The list of action options for the node. |
canAccept? | NodeComputable<boolean, [BoardNode]> | Whether the node can accept another node being dropped upon it. |
classes? | NodeComputable<Record<string, boolean>, []> | Dictionary of CSS classes to apply to this node. |
draggable? | NodeComputable<boolean, []> | Whether the node is draggable or not. |
fillColor? | NodeComputable<string, []> | The fill color of the node. |
label? | NodeComputable<null | NodeLabel, []> | An optional label for the node. |
onClick? | (node: BoardNode) => void | A function that is called when the node is clicked. |
onDrop? | (node: BoardNode, otherNode: BoardNode) => void | A function that is called when a node is dropped onto this node. |
outlineColor? | NodeComputable<string, []> | The outline color of the node. |
progress? | NodeComputable<number, []> | The progress value of the node. |
progressColor? | NodeComputable<string, []> | The color of the progress indicator. |
progressDisplay? | NodeComputable<ProgressDisplay, []> | How the progress should be displayed on the node. |
shape | NodeComputable<Shape, []> | The shape of the node. |
size | NodeComputable<number, []> | The size of the node - diameter for circles, width and height for squares. |
style? | NodeComputable<StyleValue, []> | CSS to apply to this node. |
title | NodeComputable<string, []> | The title to display for the node. |
titleColor? | NodeComputable<string, []> | The color of the title text. |
update? | (node: BoardNode, diff: number) => void | A function that is called for each node of this type every tick. |
profectus/src/features/boards/board.ts:90
Ƭ 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.
| Name | Type |
|---|---|
T | extends BoardOptions |
profectus/src/features/boards/board.ts:280
Ƭ BoardData: Object
The persistent data for a board.
| Name | Type |
|---|---|
nodes | BoardNode[] |
selectedAction | string | null |
selectedNode | number | null |
profectus/src/features/boards/board.ts:81
Ƭ BoardNodeAction<T>: Replace<T & BaseBoardNodeAction, { confirmationLabel: GetComputableTypeWithDefault<T["confirmationLabel"], NodeLabel> ; 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.
| Name | Type |
|---|---|
T | extends BoardNodeActionOptions |
profectus/src/features/boards/board.ts:206
Ƭ GenericBoard: Replace<Board<BoardOptions>, { links: ProcessedComputable<BoardNodeLink[] | null> ; state: ProcessedComputable<BoardData> ; visibility: ProcessedComputable<Visibility | boolean> }>
A type that matches any valid Board object.
profectus/src/features/boards/board.ts:295
Ƭ GenericBoardNodeAction: Replace<BoardNodeAction<BoardNodeActionOptions>, { confirmationLabel: NodeComputable<NodeLabel> ; visibility: NodeComputable<Visibility | boolean> }>
A type that matches any valid BoardNodeAction object.
profectus/src/features/boards/board.ts:219
Ƭ GenericNodeType: Replace<NodeType<NodeTypeOptions>, { actionDistance: NodeComputable<number> ; canAccept: NodeComputable<boolean, [BoardNode]> ; draggable: NodeComputable<boolean> ; progressColor: NodeComputable<string> ; progressDisplay: NodeComputable<ProgressDisplay> ; shape: NodeComputable<Shape> ; size: NodeComputable<number> }>
A type that matches any valid NodeType object.
profectus/src/features/boards/board.ts:163
Ƭ NodeComputable<T, S>: Computable<T> | (node: BoardNode, ...args: S) => 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.
| Name | Type |
|---|---|
T | T |
S | extends unknown[] = [] |
profectus/src/features/boards/board.ts:36
Ƭ NodeType<T>: Replace<T & BaseNodeType, { actionDistance: GetComputableTypeWithDefault<T["actionDistance"], number> ; actions?: GenericBoardNodeAction[] ; canAccept: GetComputableTypeWithDefault<T["canAccept"], false> ; classes: GetComputableType<T["classes"]> ; 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> ; style: GetComputableType<T["style"]> ; 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.
| Name | Type |
|---|---|
T | extends NodeTypeOptions |
profectus/src/features/boards/board.ts:140
• Const BoardType: typeof BoardType
A symbol used to identify Board features.
profectus/src/features/boards/board.ts:31
â–¸ createBoard<T>(optionsFunc): Board<T>
Lazily creates a board with the given options.
| Name | Type |
|---|---|
T | extends BoardOptions |
| Name | Type | Description |
|---|---|---|
optionsFunc | OptionsFunc<T, BaseBoard, GenericBoard> | Board options. |
Board<T>
profectus/src/features/boards/board.ts:308
â–¸ getNodeProperty<T, S>(property, node, ...args): T
Gets the value of a property for a specified node.
| Name | Type |
|---|---|
T | T |
S | extends unknown[] |
| Name | Type | Description |
|---|---|---|
property | NodeComputable<T, S> | The property to find the value of |
node | BoardNode | The node to get the property of |
...args | S | - |
T
profectus/src/features/boards/board.ts:607
â–¸ getUniqueNodeID(board): number
Utility to get an ID for a node that is guaranteed unique.
| Name | Type | Description |
|---|---|---|
board | GenericBoard | The board feature to generate an ID for |
number
profectus/src/features/boards/board.ts:621
| Name | Type |
|---|---|
nodes* | Ref |
types* | Record |
state* | Ref |
visibility* | ProcessedComputable |
width | ProcessedComputable |
height | ProcessedComputable |
style | ProcessedComputable |
classes | ProcessedComputable |
links* | Ref |
selectedAction* | Ref |
selectedNode* | Ref |
draggingNode* | Ref |
receivingNode* | Ref |
mousePosition* | Ref |
setReceivingNode* | TSFunctionType |
setDraggingNode* | TSFunctionType |
| Name | Type |
|---|---|
link* | BoardNodeLink |
| Name | Type |
|---|---|
node* | BoardNode |
nodeType* | GenericNodeType |
actions | GenericBoardNodeAction[] |
isSelected* | boolean |
selectedAction* | GenericBoardNodeAction | null |
| Name |
|---|
clickAction |
| Name | Type |
|---|---|
node* | BoardNode |
nodeType* | GenericNodeType |
dragging* | BoardNode | null |
dragged | { |
hasDragged | boolean |
receivingNode | boolean |
selectedNode* | BoardNode | null |
selectedAction* | GenericBoardNodeAction | null |
| Name |
|---|
mouseDown |
endDragging |
clickAction |
• BaseChallenge: Object
The properties that are added onto a processed ChallengeOptions to create a Challenge.
| Name | Type | Description |
|---|---|---|
[Component] | GenericComponent | The Vue component used to render this feature. |
[GatherProps] | () => Record<string, unknown> | A function to gather the props the vue component requires for this feature. |
active | Persistent<boolean> | Whether or not this challenge is currently active. |
canComplete | Ref<DecimalSource> | The current amount of times this challenge can be completed. |
complete | (remainInChallenge?: boolean) => void | A function to complete this challenge. |
completed | Ref<boolean> | Whether or not this challenge has been completed. |
completions | Persistent<DecimalSource> | The current number of times this challenge has been completed. |
id | string | An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates. |
maxed | Ref<boolean> | Whether or not this challenge's completion count is at its limit. |
toggle | VoidFunction | A function to enter or leave the challenge. |
type | typeof ChallengeType | A symbol that helps identify features of the same type. |
profectus/src/features/challenges/challenge.tsx:92
• ChallengeOptions: Object
An object that configures a Challenge.
| Name | Type | Description |
|---|---|---|
canStart? | Computable<boolean> | Whether this challenge can be started. |
classes? | Computable<Record<string, boolean>> | Dictionary of CSS classes to apply to this feature. |
completionLimit? | Computable<DecimalSource> | The maximum number of times the challenge can be completed. |
display? | Computable<CoercableComponent | { description: CoercableComponent ; effectDisplay?: CoercableComponent ; goal?: CoercableComponent ; reward?: CoercableComponent ; title?: CoercableComponent }> | The display to use for this challenge. |
mark? | Computable<string | boolean> | Shows a marker on the corner of the feature. |
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. |
onComplete? | VoidFunction | A function that is called when the challenge is completed. |
onEnter? | VoidFunction | A function that is called when the challenge is entered. |
onExit? | VoidFunction | A function that is called when the challenge is exited. |
requirements | Requirements | The requirement(s) to complete this challenge. |
reset? | GenericReset | The reset function for this challenge. |
style? | Computable<StyleValue> | CSS to apply to this feature. |
visibility? | Computable<boolean | Visibility> | Whether this challenge should be visible. |
profectus/src/features/challenges/challenge.tsx:46
Ƭ 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.
| Name | Type |
|---|---|
T | extends ChallengeOptions |
profectus/src/features/challenges/challenge.tsx:121
Ƭ 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.
profectus/src/features/challenges/challenge.tsx:137
• Const ChallengeType: typeof ChallengeType
A symbol used to identify Challenge features.
profectus/src/features/challenges/challenge.tsx:41
â–¸ 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)
| Name | Type | Description |
|---|---|---|
challenges | GenericChallenge[] | The list of challenges that are mutually exclusive |
Ref<GenericChallenge | null>
profectus/src/features/challenges/challenge.tsx:345
â–¸ createChallenge<T>(optionsFunc, ...decorators): Challenge<T>
Lazily creates a challenge with the given options.
| Name | Type |
|---|---|
T | extends ChallengeOptions |
| Name | Type | Description |
|---|---|---|
optionsFunc | OptionsFunc<T, BaseChallenge, GenericChallenge> | Challenge options. |
...decorators | GenericDecorator[] | - |
Challenge<T>
profectus/src/features/challenges/challenge.tsx:151
â–¸ 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.
| Name | Type | Description |
|---|---|---|
challenges | GenericChallenge[] | Ref<null | GenericChallenge> | List of challenges that are mutually exclusive |
Ref<boolean>
profectus/src/features/challenges/challenge.tsx:355
â–¸ setupAutoComplete(challenge, autoActive?, exitOnComplete?): WatchStopHandle
This will automatically complete a challenge when it's requirements are met.
| Name | Type | Default value | Description |
|---|---|---|---|
challenge | GenericChallenge | undefined | The challenge to auto-complete |
autoActive | Computable<boolean> | true | Whether or not auto-completing should currently occur |
exitOnComplete | boolean | true | Whether or not to exit the challenge after auto-completion |
WatchStopHandle
profectus/src/features/challenges/challenge.tsx:325
| Name | Type |
|---|---|
active* | processedPropType<boolean>(Boolean) |
maxed* | processedPropType<boolean>(Boolean) |
canComplete* | processedPropType<boolean>(Boolean) |
display | processedPropType<UnwrapRef<GenericChallenge["display"]>>( |
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 |
• BaseClickable: Object
The properties that are added onto a processed ClickableOptions to create an Clickable.
| Name | Type | Description |
|---|---|---|
[Component] | GenericComponent | The Vue component used to render this feature. |
[GatherProps] | () => Record<string, unknown> | A function to gather the props the vue component requires for this feature. |
id | string | An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates. |
type | typeof ClickableType | A symbol that helps identify features of the same type. |
profectus/src/features/clickables/clickable.ts:61
• ClickableOptions: Object
An object that configures a Clickable.
| Name | Type | Description |
|---|---|---|
canClick? | Computable<boolean> | Whether or not the clickable may be clicked. |
classes? | Computable<Record<string, boolean>> | Dictionary of CSS classes to apply to this feature. |
display? | Computable<CoercableComponent | { description: CoercableComponent ; title?: CoercableComponent }> | The display to use for this clickable. |
mark? | Computable<string | boolean> | Shows a marker on the corner of the feature. |
onClick? | (e?: MouseEvent | TouchEvent) => void | A function that is called when the clickable is clicked. |
onHold? | VoidFunction | A function that is called when the clickable is held down. |
small? | boolean | Toggles a smaller design for the feature. |
style? | Computable<StyleValue> | CSS to apply to this feature. |
visibility? | Computable<boolean | Visibility> | Whether this clickable should be visible. |
profectus/src/features/clickables/clickable.ts:29
Ƭ 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.
| Name | Type |
|---|---|
T | extends ClickableOptions |
profectus/src/features/clickables/clickable.ts:73
Ƭ GenericClickable: Replace<Clickable<ClickableOptions>, { canClick: ProcessedComputable<boolean> ; visibility: ProcessedComputable<Visibility | boolean> }>
A type that matches any valid Clickable object.
profectus/src/features/clickables/clickable.ts:86
• Const ClickableType: typeof ClickableType
A symbol used to identify Clickable features.
profectus/src/features/clickables/clickable.ts:24
â–¸ createClickable<T>(optionsFunc?, ...decorators): Clickable<T>
Lazily creates a clickable with the given options.
| Name | Type |
|---|---|
T | extends ClickableOptions |
| Name | Type | Description |
|---|---|---|
optionsFunc? | OptionsFunc<T, BaseClickable, GenericClickable> | Clickable options. |
...decorators | GenericDecorator[] | - |
Clickable<T>
profectus/src/features/clickables/clickable.ts:98
â–¸ setupAutoClick(layer, clickable, autoActive?): Unsubscribe
Utility to auto click a clickable whenever it can be.
| Name | Type | Default value | Description |
|---|---|---|---|
layer | BaseLayer | undefined | The layer the clickable is apart of |
clickable | GenericClickable | undefined | The clicker to click automatically |
autoActive | Computable<boolean> | true | Whether or not the clickable should currently be auto-clicking |
Unsubscribe
profectus/src/features/clickables/clickable.ts:192
| Name | Type |
|---|---|
display* | processedPropType<UnwrapRef<GenericClickable["display"]>>( |
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 |
• BaseConversion: Object
The properties that are added onto a processed ConversionOptions to create a Conversion.
| Name | Type | Description |
|---|---|---|
convert | VoidFunction | The function that performs the actual conversion. |
profectus/src/features/conversion.ts:79
• ConversionOptions: Object
An object that configures a Conversion.
| Name | Type | Description |
|---|---|---|
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. |
baseResource | Resource<DecimalSource> | The input Resource for this conversion. |
buyMax? | Computable<boolean> | Whether or not to cap the amount of the output resource gained by converting at 1. Defaults to true. |
convert? | VoidFunction | The function that performs the actual conversion from baseResource to gainResource. Typically this will be set for you in a conversion constructor. |
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. |
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. |
formula | (variable: InvertibleIntegralFormula) => 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. |
gainResource | Resource<DecimalSource> | The output Resource for this conversion. i.e. the resource being generated. |
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. |
onConvert? | (amountGained: DecimalSource) => 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) |
spend? | (amountGained: DecimalSource) => void | The function that spends the baseResource as part of the conversion. Defaults to setting the baseResource amount to 0. |
profectus/src/features/conversion.ts:17
Ƭ 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.
| Name | Type |
|---|---|
T | extends ConversionOptions |
profectus/src/features/conversion.ts:87
Ƭ 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.
profectus/src/features/conversion.ts:101
â–¸ createConversion<T>(optionsFunc, ...decorators): 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
| Name | Type |
|---|---|
T | extends ConversionOptions |
| Name | Type | Description |
|---|---|---|
optionsFunc | OptionsFunc<T, BaseConversion, GenericConversion> | Conversion options. |
...decorators | GenericDecorator[] | - |
Conversion<T>
profectus/src/features/conversion.ts:120
â–¸ 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.
| Name | Type |
|---|---|
S | extends ConversionOptions |
| Name | Type | Description |
|---|---|---|
optionsFunc | OptionsFunc<S, BaseConversion, GenericConversion> | Conversion options. |
Conversion<S>
profectus/src/features/conversion.ts:204
â–¸ 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.
| Name | Type |
|---|---|
S | extends ConversionOptions |
| Name | Type | Description |
|---|---|---|
optionsFunc | OptionsFunc<S, BaseConversion, GenericConversion> | Converison options. |
Conversion<S>
profectus/src/features/conversion.ts:215
â–¸ 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.
| Name | Type | Default value | Description |
|---|---|---|---|
layer | BaseLayer | undefined | The layer this passive generation will be associated with. Typically this when calling this function from inside a layer's options function. |
conversion | GenericConversion | undefined | The conversion that will determine how much generation there is. |
rate | Computable<DecimalSource> | 1 | A multiplier to multiply against the conversion's currentGain. |
cap | Computable<DecimalSource> | Decimal.dInf | A value that should not be passed via passive generation. |
void