ffc#

Inherits: sprite

“Freeform combo” (FFC) represent combos that may move freely around the screen, not tied to the grid.

Load with Screen->LoadFFC().

Variables#

const int

ID

const int

ScreenFFCIndex

int

Data

int

Layer

int

Script

int

Delay

int

Vx

int

Vy

int

Ax

int

Ay

bool[]

Flags

int

EffectWidth

int

EffectHeight

int

Link

untyped[]

InitD

int

LastChangerX

int

LastChangerY

Functions#

bool

Trigger(int trig_index = 0)

Enumerations#

enum FFCFlag: 🔗 Source

Used with ffc::Flags[].

FFCFlag FFCF_OVERLAY = 0

Draw Over (draw between layers 4 and 5).

FFCFlag FFCF_TRANS = 1

Translucent.

FFCFlag FFCF_SOLID = 2

Solidity (Partially Implemented).

FFCFlag FFCF_CARRYOVER = 3

Carry Over.

FFCFlag FFCF_STATIONARY = 4

Stationary.

FFCFlag FFCF_CHANGER = 5

Is A Changer.

FFCFlag FFCF_PRELOAD = 6

Run Script On Screen Init.

FFCFlag FFCF_LENSVIS = 7

Only Visible to Lens of Truth.

FFCFlag FFCF_RESET = 8

Script Resets When Carried Over.

FFCFlag FFCF_ETHEREAL = 9

The FFC’s Combo Type is ignored.

FFCFlag FFCF_IGNOREHOLDUP = 10

The FFC is updated while Link is holding up an item.

FFCFlag FFCF_IGNORECHANGER = 11

The FFC ignores changers.

FFCFlag FFCF_IMPRECISIONCHANGER = 12

The FFC is affected by changers if it is within 1px on both axis, not subpixel alignment.

FFCFlag FFCF_LENSINVIS = 13

Not visible to the lens of truth.

Variable descriptions#

const int ID 🔗 Source

The FFC’s ID. Valid values are between 1 and MAX_FFC.

The general formula for an FFC’s ID is the following:

> id = (screen region offset)*128 + (index into screen’s ffc array) + 1

where “screen region offset” refers to the index of the screen in the current region, like so:

0 1 2
3 4 5
6 7 8

const int ScreenFFCIndex 🔗 Source

Added in version 3.0.

The FFC’s index within the current screen (0-indexed).

int Data 🔗 Source

The combo ID used by the FFC for its visuals and type.

int Layer 🔗 Source

Added in version 3.0.

The layer the FFC draws on. Unused if FFCF_OVERLAY is set.

int Script 🔗 Source

The FFC script ID running on this FFC.

int Delay 🔗 Source

The time in frames before the FFC will begin moving.

int Vx 🔗 Source

X velocity.

int Vy 🔗 Source

Y velocity.

int Ax 🔗 Source

X acceleration.

int Ay 🔗 Source

Y acceleration.

bool[] Flags 🔗 Source

index FFCFlag (FFCF_)

Flags for the FFC.

int EffectWidth 🔗 Source

The hitbox width, in pixels (1 to 64), of the FFC. Unless the FFC is ffc::Flags[], the type of its combo will affect this area. NOTE: Not all combo types function when placed on FFCs.

int EffectHeight 🔗 Source

The hitbox height, in pixels (1 to 64), of the FFC. Unless the FFC is ffc::Flags[], the type of its combo will affect this area. NOTE: Not all combo types function when placed on FFCs.

Represents the ID of another FFC this one is ‘linked’ to.

untyped[] InitD 🔗 Source

The 8 InitD[] parameters for the FFC’s script.

int LastChangerX 🔗 Source

int LastChangerY 🔗 Source

Function descriptions#

bool Trigger(int trig_index = 0) 🔗 Source

Added in version 3.0.

Attempts to trigger the ffc’s combo with it’s trigger number ‘trig_index’. Returns true on success, false on failure.