ProfectusModule: 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
| Name | Type | Description |
|---|---|---|
element | VueFeature | The element that will dismiss the notification on hover. |
shouldNotify | Ref<boolean> | () => boolean | A 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
| Name | Type |
|---|---|
borderColor | string |
boxShadow | string |
transform | string |
zIndex | number |
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
| Name | Type | Default value | Description |
|---|---|---|---|
color | string | "white" | The color of the glow effect. |
strength | string | "8px" | The strength of the glow effect - affects its spread. |
Returns
Object
| Name | Type |
|---|---|
borderColor | string |
boxShadow | string |
transform | string |
zIndex | number |