DeckStacker.DSStack Class Reference

Inheritance diagram for DeckStacker.DSStack:

Public Member Functions
List< DSCard >	GetCardsOffTop (int howManyCards_)
DSCard	TopCard ()
void	AddToRestackList ()
bool	HasSelectOffset ()
string[]	Stack_To_String_Array ()
void	ReturnCardsToPool ()

Properties
DSCardManager	cardManager [get]
List< DSCard >	cards [get, set]
RectTransform	rTransform [get]
DSStackRenderManager	renderManager [get]
DSRestackHelper	restackHelper [get]
Vector3	selectedCardPositionOffset [get, set]
Vector3	selectedCardScaleOffset [get, set]

Detailed Description

Stacks are objects that parent a collection of cards, and save data on how those cards should be arranged.

This should be attached to a stack prefab.

Similar to the DSCard script, this serves as a communication hub between the various scripts that control an individual stack's behavior.

Member Function Documentation

AddToRestackList()

void DeckStacker.DSStack.AddToRestackList ( )

inline

Stacks need to be added to the DSRestacker.restackList in order for a Restack to trigger properly.
This method adds this stack to the restack list, if it isn't there already.

GetCardsOffTop()

List< DSCard > DeckStacker.DSStack.GetCardsOffTop ( int howManyCards_ )

inline

Shortcut method that returns a list of n cards at the end of the cards list (aka At the "top" of the stack).

HasSelectOffset()

bool DeckStacker.DSStack.HasSelectOffset ( )

inline

Returns whether the stack has defined a position and / or scale offset for selected cards.

ReturnCardsToPool()

void DeckStacker.DSStack.ReturnCardsToPool ( )

inline

Returns this stack's cards to theie respective pool(s).

Stack_To_String_Array()

string[] DeckStacker.DSStack.Stack_To_String_Array ( )

inline

Returns an array of strings made from the names of the card game objects in the cards list.

Useful for recording saved game info.

TopCard()

DSCard DeckStacker.DSStack.TopCard ( )

inline

Shortcut method that returns the last card of the cards list. Similar to GetCardsOffTop, but only one card.

Property Documentation

cardManager

DSCardManager DeckStacker.DSStack.cardManager

get

Assign the stack's DSCardManager component, here.

cards

List<DSCard> DeckStacker.DSStack.cards

getset

Shortcut to Care Manager cards list because this gets used all over DeckStacker.

renderManager

DSStackRenderManager DeckStacker.DSStack.renderManager

get

Assign the stack's DSStackRenderManager component, here.

restackHelper

DSRestackHelper DeckStacker.DSStack.restackHelper

get

Assign the stack's DSRestackHelper component, here.

rTransform

RectTransform DeckStacker.DSStack.rTransform

get

Assign the stack's RectTransform component, here.
Even though the DeckStacker system doesn't use this component, explicitly, exposing this in a get call should be generally useful in many scenerios.

Example: Dynamically placing stacks in the scene in a grid layout, requiring code to know the dimensions of a stack.

selectedCardPositionOffset

Vector3 DeckStacker.DSStack.selectedCardPositionOffset

getset

Default position offset for all selected cards in this stack.
In other words, when you use the default select code in DSCardSelector, it looks for the card position offset here.

selectedCardScaleOffset

Vector3 DeckStacker.DSStack.selectedCardScaleOffset

getset

Default scale offset for all selected cards in this stack.
In other words, when you use the default select code in DSCardSelector, it looks for the card scale offset here.

---

The documentation for this class was generated from the following file:

• DeckStacker/DSCore/Scripts/Stack/DSStack.cs