Skip to main content

neon_crisp / Modules / utils/cardScreenUtils

Module: utils/cardScreenUtils

Table of contents​

Functions​

Functions​

createGridPlacer​

▸ createGridPlacer(objectWidth, objectHeight, rows, cols, objectWidthOffset?, objectHeightOffset?, padding?, anchor?): (index: number) => { x: number ; y: number }

Creates a function to determine the (x, y) position of an object in a grid.

Parameters​

NameTypeDefault valueDescription
objectWidthnumberundefinedThe width of each object in the grid.
objectHeightnumberundefinedThe height of each object in the grid.
rowsnumberundefinedThe number of rows in the grid.
colsnumberundefinedThe number of columns in the grid.
objectWidthOffsetnumber0The width offset to make the anchor of the object bottom left of each object in the grid.
objectHeightOffsetnumber0The height offset to make the anchor of the object bottom left of each object in the grid.
paddingnumber0padding in the grid.
anchorAnchor"center"The anchor point determining how the object is positioned within its cell.

Returns​

fn

A function that takes an index and returns the (x, y) position.

▸ (index): Object

Parameters​
NameType
indexnumber
Returns​

Object

NameType
xnumber
ynumber

Defined in​

utils/cardScreenUtils.ts:92


getCardScale​

▸ getCardScale(handSize, windowX): number

Parameters​

NameType
handSizenumber
windowXnumber

Returns​

number

Defined in​

utils/cardScreenUtils.ts:35


getRealNodeSize​

▸ getRealNodeSize(guiNode, scaledNode, newScale?): vector3

Parameters​

NameType
guiNodenode
scaledNodenode
newScale?vector3

Returns​

vector3

Defined in​

utils/cardScreenUtils.ts:64


getScreenPOSForIndex​

▸ getScreenPOSForIndex(index, windowX, windowY, topOfCenter, handLength?, cardScale?): vector3

Parameters​

NameTypeDefault value
indexnumberundefined
windowXnumberundefined
windowYnumberundefined
topOfCenterbooleanundefined
handLengthnumber4
cardScalenumber1

Returns​

vector3

Defined in​

utils/cardScreenUtils.ts:1


posForGridOfCards​

▸ posForGridOfCards(index, bottomOffset?, cardWidth?, cardHeight?, screenWidth?): vector3

Parameters​

NameTypeDefault value
indexnumberundefined
bottomOffsetnumber0
cardWidthnumber150
cardHeightnumber225
screenWidthnumber640

Returns​

vector3

Defined in​

utils/cardScreenUtils.ts:46