DeckStacker v1.0
A card manager plugin for Unity games.
 
Loading...
Searching...
No Matches
Public Member Functions | Properties
DeckStacker.DSCardMovementHelper Class Reference
Inheritance diagram for DeckStacker.DSCardMovementHelper:

Public Member Functions

void MoveCard (Vector3 pos)
 
void OffsetCard (Vector3 pos_, Vector3 scale_)
 
bool IsOffset ()
 
void ResetOffset ()
 
void RotateCard (Quaternion newRotation_)
 
void RotateCard (Vector3 newEulerRotation_)
 
void ScaleCard (Vector3 newScale_)
 
void ResetStartScale ()
 
void Reset ()
 

Properties

Transform offsetParent [get, set]
 
string cardSpacingKey [get]
 
string moveCurveKey [get]
 
float dealDelay [get, set]
 
float moveClock [get, set]
 
float offsetClock [get, set]
 
float rotationClock [get, set]
 
float scaleClock [get, set]
 
float spdMod [get, set]
 
bool moveDone [get, set]
 
bool rotationDone [get, set]
 
bool scaleDone [get, set]
 
DSStack fromStack [get, set]
 
DSStack targetStack [get, set]
 
DSCardPlacementInDeck targetPlacementInStack [get, set]
 
int targetExactPlacementInStack [get, set]
 
bool disableOffset [get, set]
 
Vector3 startPos [get]
 
Vector3 endPos [get, set]
 
Vector3 offsetStartPos [get, set]
 
Vector3 offsetPos [get, set]
 
Vector3 offsetStartScale [get, set]
 
Vector3 offsetScale [get, set]
 
Quaternion startRotation [get]
 
Quaternion endRotation [get, set]
 
bool lockRotation [get, set]
 
Vector3 startScale [get]
 
Vector3 endScale [get, set]
 
DSCardSpacing cardSpacing [get]
 
AnimationCurve moveCurve [get]
 

Detailed Description

This script helps offload some code from the DSCardMover.

This script keeps card-specific movement data and helps trigger DSCardMover behaviors, specific to this card.

Should be attached to a DSCard prefab.

Member Function Documentation

◆ IsOffset()

bool DeckStacker.DSCardMovementHelper.IsOffset ( )
inline

A card is offset when its offsetParent object is not at the local position of (0,0,0) and/or not scaled to (1,1,1).

◆ MoveCard()

void DeckStacker.DSCardMovementHelper.MoveCard ( Vector3 pos)
inline

Moves this card to a Vector3 position (world space).

Primarily used in DSRestacker, but can be used in Undefined stacks to move a card to a specific place.

Note: This is not action code, but instead triggers card motion in the DSCardMover.cardsInMotion list.

◆ OffsetCard()

void DeckStacker.DSCardMovementHelper.OffsetCard ( Vector3 pos_,
Vector3 scale_ )
inline

Offsets the position and scale of the card to the input values until the offset is changed or reset.

Position and scale are in local space.

◆ Reset()

void DeckStacker.DSCardMovementHelper.Reset ( )
inline

Resets all values in DSCardMovementHelper.

Used when returning a card to its pool.

◆ ResetOffset()

void DeckStacker.DSCardMovementHelper.ResetOffset ( )
inline

Resets offset back to default position and scale.

◆ ResetStartScale()

void DeckStacker.DSCardMovementHelper.ResetStartScale ( )
inline

Used in the card pool to fix the start scale of cards as they are spawned into a stack.

◆ RotateCard() [1/2]

void DeckStacker.DSCardMovementHelper.RotateCard ( Quaternion newRotation_)
inline

This triggers rotation motion in the DSCardMover, associated with this card, rotating the card to the input Quaternion value.

◆ RotateCard() [2/2]

void DeckStacker.DSCardMovementHelper.RotateCard ( Vector3 newEulerRotation_)
inline

Overload to make it easier to feed in Euler vectors instead of quaternions.

◆ ScaleCard()

void DeckStacker.DSCardMovementHelper.ScaleCard ( Vector3 newScale_)
inline

Similar to MoveCard, OffsetCard, and RotateCard, this scales the card to a desired vector3

Primarily used when transferring cards between stacks with different scales.

Property Documentation

◆ cardSpacing

DSCardSpacing DeckStacker.DSCardMovementHelper.cardSpacing
get

Returns cardSpacing data from this card's card pool.

◆ cardSpacingKey

string DeckStacker.DSCardMovementHelper.cardSpacingKey
get

This key is set on the prefab and determines card spacing data for stacks with this card. This key is fed into card pools that use the card prefab, which then fetch the spacing data.

◆ dealDelay

float DeckStacker.DSCardMovementHelper.dealDelay
getset

Once a card is added to cardsWaitingToBeDealt, this will delay its transfer to cardsInMotion.

◆ disableOffset

bool DeckStacker.DSCardMovementHelper.disableOffset
getset

Disables offset code for this card.

◆ endPos

Vector3 DeckStacker.DSCardMovementHelper.endPos
getset

Card movement end of lerp

◆ endRotation

Quaternion DeckStacker.DSCardMovementHelper.endRotation
getset

Card visual offset end scale

◆ endScale

Vector3 DeckStacker.DSCardMovementHelper.endScale
getset

Card visual offset end scale

◆ fromStack

DSStack DeckStacker.DSCardMovementHelper.fromStack
getset

When cards are in motion, we need to know from where the card came from.

◆ lockRotation

bool DeckStacker.DSCardMovementHelper.lockRotation
getset

Disables DSCardMover rotation for this card.

◆ moveClock

float DeckStacker.DSCardMovementHelper.moveClock
getset

Evaluate variable in card movement lerp

◆ moveCurve

AnimationCurve DeckStacker.DSCardMovementHelper.moveCurve
get

Returns the moveCurve data from this card's card pool.

◆ moveCurveKey

string DeckStacker.DSCardMovementHelper.moveCurveKey
get

This key is used to get a MoveCurve object from the _cardMoveSettings object.

◆ moveDone

bool DeckStacker.DSCardMovementHelper.moveDone
getset

Used in card movement lerp. Without this, card movement wasn't smooth when other cards joined the stack while this one was in flight.

◆ offsetClock

float DeckStacker.DSCardMovementHelper.offsetClock
getset

Evaluate variable in card offset lerp

◆ offsetParent

Transform DeckStacker.DSCardMovementHelper.offsetParent
getset

This object in the prefab will move according to the offset calculations in DSCardMover.

◆ offsetPos

Vector3 DeckStacker.DSCardMovementHelper.offsetPos
getset

Card visual offset end position

◆ offsetScale

Vector3 DeckStacker.DSCardMovementHelper.offsetScale
getset

Card visual offset end scale

◆ offsetStartPos

Vector3 DeckStacker.DSCardMovementHelper.offsetStartPos
getset

Card visual offset start position

◆ offsetStartScale

Vector3 DeckStacker.DSCardMovementHelper.offsetStartScale
getset

Card visual offset start scale

◆ rotationClock

float DeckStacker.DSCardMovementHelper.rotationClock
getset

Evaluate variable in card rotation lerp

◆ rotationDone

bool DeckStacker.DSCardMovementHelper.rotationDone
getset

Used in card rotation lerp, similar to moveDone.

◆ scaleClock

float DeckStacker.DSCardMovementHelper.scaleClock
getset

Evaluate variable in card scale lerp

◆ scaleDone

bool DeckStacker.DSCardMovementHelper.scaleDone
getset

Used in card scale lerp, similar to moveDone.

◆ spdMod

float DeckStacker.DSCardMovementHelper.spdMod
getset

A multiplier for a card's movement speed

◆ startPos

Vector3 DeckStacker.DSCardMovementHelper.startPos
get

Card movement start of lerp

◆ startRotation

Quaternion DeckStacker.DSCardMovementHelper.startRotation
get

Card visual offset start scale

◆ startScale

Vector3 DeckStacker.DSCardMovementHelper.startScale
get

Card visual offset start scale

◆ targetExactPlacementInStack

int DeckStacker.DSCardMovementHelper.targetExactPlacementInStack
getset

Similar to _targetPlacementInStack. This allows for a specific index in the cards list of the stack.

◆ targetPlacementInStack

DSCardPlacementInDeck DeckStacker.DSCardMovementHelper.targetPlacementInStack
getset

Allows card placement to be determined on an individual card basis.

◆ targetStack

DSStack DeckStacker.DSCardMovementHelper.targetStack
getset

When cards are in motion, we need to know where they are going.

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