import{_ as e,c as t,o,N as a}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Module: game/notifications","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/game/notifications.md","lastUpdated":null}'),i={name:"api/modules/game/notifications.md"},d=a('

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

• createDismissableNotify: (element: VueFeature, shouldNotify: Ref<boolean> | () => boolean) => 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

• getHighNotifyStyle: () => { borderColor: string = "rgba(0, 0, 0, 0.125)"; boxShadow: string ; transform: string = "scale(1.05, 1.05)"; zIndex: number = 1 }

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

• getNotifyStyle: (color: string, strength: string) => { borderColor: string = "rgba(0, 0, 0, 0.125)"; boxShadow: string ; transform: string = "scale(1.05, 1.05)"; zIndex: number = 1 }

Defined in ​

profectus/src/game/notifications.ts:17

',40),r=[d];function n(l,c,s,f,h,g){return o(),t("div",null,r)}const y=e(i,[["render",n]]);export{b as __pageData,y as default};