profectus-docs/assets/api_game_boards_board_functions_setupActions.md.ByLiDs6x.js

1 line
2.7 KiB
JavaScript
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import{_ as t,c as a,a0 as o,o as r}from"./chunks/framework.P9qPzDnn.js";const h=JSON.parse('{"title":"Function: setupActions()","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/game/boards/board/functions/setupActions.md","filePath":"api/game/boards/board/functions/setupActions.md","lastUpdated":null}'),n={name:"api/game/boards/board/functions/setupActions.md"};function s(i,e,c,d,p,u){return r(),a("div",null,e[0]||(e[0]=[o('<p><a href="./../../../../">Profectus</a> / <a href="./../">game/boards/board</a> / setupActions</p><h1 id="function-setupactions" tabindex="-1">Function: setupActions() <a class="header-anchor" href="#function-setupactions" aria-label="Permalink to &quot;Function: setupActions()&quot;"></a></h1><blockquote><p><strong>setupActions</strong>&lt;<code>T</code>&gt;(<code>options</code>): <a href="https://vuejs.org/guide/typescript/composition-api.html#typing-computed" target="_blank" rel="noreferrer"><code>ComputedRef</code></a>&lt;<code>Element</code> | <code>&quot;&quot;</code>&gt;</p></blockquote><p>Sets up a system where a list of actions, which are arbitrary JSX elements, will get displayed around a node radially, under given conditions. The actions are radially centered around 3/2 PI (Down).</p><h2 id="type-parameters" tabindex="-1">Type Parameters <a class="header-anchor" href="#type-parameters" aria-label="Permalink to &quot;Type Parameters&quot;"></a></h2><p>• <strong>T</strong> <em>extends</em> <a href="./../type-aliases/NodePosition"><code>NodePosition</code></a></p><h2 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;"></a></h2><h3 id="options" tabindex="-1">options <a class="header-anchor" href="#options" aria-label="Permalink to &quot;options&quot;"></a></h3><p><a href="./../interfaces/SetupActionsOptions"><code>SetupActionsOptions</code></a>&lt;<code>T</code>&gt;</p><p>Setup actions options.</p><h2 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;"></a></h2><p><a href="https://vuejs.org/guide/typescript/composition-api.html#typing-computed" target="_blank" rel="noreferrer"><code>ComputedRef</code></a>&lt;<code>Element</code> | <code>&quot;&quot;</code>&gt;</p><p>A JSX function to render the actions.</p><h2 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;"></a></h2><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/game/boards/board.tsx#L369" target="_blank" rel="noreferrer">profectus/src/game/boards/board.tsx:369</a></p>',15)]))}const m=t(n,[["render",s]]);export{h as __pageData,m as default};