std_functions.zh#

Functions#

bool	Above(npc n)
bool	Above(ffc n)
bool	Above(eweapon n)
bool	Above(lweapon n)
void	AimEWeapon(eweapon e, int aimtype)
void	AimLWeapon(lweapon l, npc n, int aimtype)
void	AimLWeapon(lweapon l, int aimtype)
int	Angle(int x1, int y1, int x2, int y2)
int	AngleDir4(int angle)
int	AngleDir8(int angle)
int	AtFrontX(int dir)
int	AtFrontY(int dir)
bool	Below(npc n)
bool	Below(ffc n)
bool	Below(eweapon n)
bool	Below(lweapon n)
bool	CanWalk(int x, int y, int dir, int step, bool full_tile)
int	CenterLinkX()
int	CenterLinkY()
int	CenterX(ffc anFFC)
int	CenterX(npc anNPC)
int	CenterX(eweapon anEWeapon)
int	CenterX(lweapon anLWeapon)
int	CenterX(itemsprite it)
int	CenterY(ffc anFFC)
int	CenterY(npc anNPC)
int	CenterY(eweapon anEWeapon)
int	CenterY(lweapon anLWeapon)
int	CenterY(itemsprite it)
bool	CircleCollision(int c1x, int c1y, int radius1, int c2x, int c2y, int radius2)
int	Clamp(int x, int low, int high)
void	ClearTileBlock(int reffirst, int reflast)
void	ClearTileRow(int ref, int length)
bool	Collision(lweapon a, eweapon b)
bool	Collision(lweapon a, lweapon b)
bool	Collision(eweapon a, eweapon b)
bool	Collision(lweapon a, npc b)
bool	Collision(eweapon a, npc b)
bool	Collision(npc a, npc b)
bool	Collision(itemsprite a, lweapon b)
bool	Collision(itemsprite a, eweapon b)
bool	Collision(itemsprite a, npc b)
bool	Collision(itemsprite a, itemsprite b)
bool	Collision(ffc f, lweapon b)
bool	Collision(ffc f, eweapon b)
bool	Collision(ffc f, npc b)
bool	Collision(ffc f, itemsprite b)
bool	Collision(ffc f, ffc f2)
bool	Collision(ffc f, int radius1, ffc f2, int radius2)
bool	Collision(eweapon a, lweapon b)
bool	Collision(npc a, lweapon b)
bool	Collision(npc a, eweapon b)
bool	Collision(lweapon a, itemsprite b)
bool	Collision(eweapon a, itemsprite b)
bool	Collision(npc a, itemsprite b)
bool	Collision(lweapon a, ffc b)
bool	Collision(eweapon a, ffc b)
bool	Collision(npc a, ffc b)
bool	Collision(itemsprite a, ffc b)
bool	Collision(eweapon b)
bool	Collision(lweapon b)
bool	Collision(itemsprite b)
bool	Collision(npc b)
bool	Collision(ffc f)
bool	Collision(combodata f)
int	ComboAt(int x, int y)
bool	ComboFI(int x, int y, int flag)
bool	ComboFI(int loc, int flag)
int	ComboX(int rpos)
int	ComboY(int rpos)
int	RegionRelativeScreenX(int scr)
int	RegionRelativeScreenY(int scr)
int	RegionWorldOffsetX(int scr)
int	RegionWorldOffsetY(int scr)
bool	RegionIncludesScreen(int scr)
int	RegionGetFFCId(int scr, int index)
T	Cond(bool cond, T a, T b) deprecated
bool	ConsumeKey(int level = `-1`)
void	CopyTileBlock(int sourcefirst, int sourcelast, int destfirst)
void	CopyTileRow(int source, int dest, int length)
void	CounterAdd(int counter, int amount)
void	CounterReduce(int counter, int amount)
eweapon	CreateEWeaponAt(int id, int x, int y)
itemsprite	CreateItemAt(int id, int x, int y)
lweapon	CreateLWeaponAt(int id, int x, int y)
npc	CreateNPCAt(int id, int x, int y)
itemsprite	CreateTimeoutItem(int id, int x, int y)
int	CrossProduct(int x1, int y1, int x2, int y2)
void	DCounterAdd(int counter, int amount)
void	DCounterReduce(int counter, int amount)
int	DefeatedLevelBoss(int level)
int	DirNormal(int dir)
int	DirAbnormal(int dir)
int	Dir4Angle(int dir)
int	DirAngle(int dir)
int	Dir4Rad(int dir)
int	DirRad(int dir)
int	DistanceSquared(int x, int y)
bool	DistXY(ffc a, int dist)
int	Div(int x, int y)
int	DMapMapGraphicsIndex(dmapdata dm)
int	DMapMapGraphicsIndex(int dmapID)
int	DMapMapGraphicsIndex()
int	DMapToMap(int screen, int dmap)
int	DotProduct(int x1, int y1, int x2, int y2)
void	DrawString(int layer, int x, int y, int font, int color, int background_color, int format, int opacity, char32[] ptr, int start)
void	DrawString(int layer, int x, int y, int font, int color, int background_color, int format, int opacity, char32[] ptr, int start, int end)
void	DrawTileSimple(int x, int y, int tile, int color)
void	DrawToLayer(ffc f, int layer, int opacity)
void	DrawToLayer(npc n, int layer, int opacity)
void	DrawToLayer(lweapon l, int layer, int opacity)
void	DrawToLayer(eweapon e, int layer, int opacity)
void	DrawToLayer(itemsprite i, int layer, int opacity)
lweapon	Duplicate(lweapon a)
eweapon	Duplicate(eweapon a)
bool	EnemiesAlive()
bool	Facing(ffc f)
int	FFCNum(ffc f)
int	FirstComboFlagOf(int t, int layer)
int	FirstComboTypeOf(int t, int layer)
int	FirstComboOf(int t, int layer)
catchalltypes	GetCatchallType(mapdata m)
int	GetEquipmentA()
int	GetEquipmentB()
int	GetEquipmentX()
int	GetEquipmentY()
bool	GetDMapFlag(int dmap, int flag)
int	GetFirstItemOf(int itemclass)
int	GetHighestLevelItem(int itemclass)
int	GetHighestLevelItem(itemsprite i)
int	GetHighestLevelItemOwned(int itemclass)
messagedata	GetInfoString(int shop_id, int str_id)
void	GetInfoString(char32[] buffer, int shop_id, int str_id)
int	GetInfoStringID(int shop_id, int str_id)
itemdata	GetItemData(itemsprite i)
bool	GetItemPickup(itemsprite i, int pickup)
int	GetLayerComboC(int layer, int pos)
int	GetLayerComboD(int layer, int pos)
int	GetLayerComboF(int layer, int pos)
int	GetLayerComboI(int layer, int pos)
int	GetLayerComboS(int layer, int pos)
int	GetLayerComboT(int layer, int pos)
bool	GetLevelItem(int level, int itm)
bool	GetLevelItem(int itm)
int	GetMapScreenEFlag(mapdata md, int category, int flag)
int	GetMapScreenEFlag(int mapid, int scr, int category, int flag)
bool	GetMapscreenFlag(mapdata m, mapscreenflags flagid)
bool	GetMapscreenFlag(int mapid, int scr, mapscreenflags flagid)
void	GetMessage(int ID, char32[] ptr)
bool	GetNPCMiscFlag(npc e, int flag)
void	GetNPCName(int npc_id, char32[] buffer)
bool	GetScreenDBit(int dmap, int screen, int d, int bit)
bool	GetScreenDBit(int screen, int d, int bit)
bool	GetScreenDBit(int d, int bit)
int	GridX(int x)
int	GridY(int y)
int	HasBossKey(int level = `-1`)
int	HasCompass(int level = `-1`)
bool	HasHeavyBoots()
int	HasMap(int level = `-1`)
bool	HasKey(int level = `-1`)
int	HasTriforce(int level)
int	HitboxBottom(eweapon a)
int	HitboxBottom(lweapon a)
int	HitboxBottom(itemsprite a)
int	HitboxBottom(npc a)
int	HitboxBottom(ffc a)
int	HitboxLeft(eweapon a)
int	HitboxLeft(lweapon a)
int	HitboxLeft(itemsprite a)
int	HitboxLeft(npc a)
int	HitboxLeft(ffc a)
int	HitboxRight(eweapon a)
int	HitboxRight(lweapon a)
int	HitboxRight(itemsprite a)
int	HitboxRight(npc a)
int	HitboxRight(ffc a)
int	HitboxTop(eweapon a)
int	HitboxTop(lweapon a)
int	HitboxTop(itemsprite a)
int	HitboxTop(npc a)
int	HitboxTop(ffc a)
bool	IsBackgroundLayer(int layer)
bool	IsBackgroundLayer(int layer, mapdata m)
int	InFrontX(int dir, int dist)
int	InFrontY(int dir, int dist)
bool	InputLeftClick()
bool	InputMiddleClick()
bool	InputRightClick()
bool	IsDungeon()
bool	IsDungeonFlag()
bool	IsEven(int x)
bool	IsInteriorFlag()
bool	IsOdd(int x)
bool	IsPit(int position)
bool	IsSideview()
bool	IsWater(int position)
int	LargeDistance(int x1, int y1, int x2, int y2, int divisor)
int	LastComboFlagOf(int t, int layer)
int	LastComboTypeOf(int t, int layer)
int	LastComboOf(int t, int layer)
bool	LeftOf(npc n)
bool	LeftOf(ffc n)
bool	LeftOf(eweapon n)
bool	LeftOf(lweapon n)
int	Lerp(int p1, int p2, int t)
bool	LinkCollision(eweapon b)
bool	LinkCollision(lweapon b)
bool	LinkCollision(itemsprite b)
bool	LinkCollision(npc b)
bool	LinkCollision(ffc f)
eweapon	LoadEWeaponOf(int type)
lweapon	LoadLWeaponOf(int type)
npc	LoadNPCOf(int type)
npc	LoadNPCOfType(int type)
int	LogToBase(int x, int base)
int	longrand(int max)
int	MapToDMap(int screen, int dmap)
void	MakeBlockable(eweapon e)
void	MakeUnblockable(eweapon e)
void	MCounterAdd(int counter, int amount)
void	MCounterReduce(int counter, int amount)
int	Midpoint(int p1, int p2)
lweapon	NextToLink(int id, int distx, int disty)
lweapon	NextToLink(int id, int dist)
eweapon	NextToNPC(npc n, int id, int distx, int disty)
eweapon	NextToNPC(npc n, int id, int dist)
void	NoAction()
int	NumberEnemies()
int	NumEWeaponsOf(int type)
int	NumItemsOf(int type)
int	NumKeys(int level = `-1`)
int	NumLWeaponsOf(int type)
int	NumNPCsOf(int type)
int	NumTriforcePieces(int maxlevel = `8`)
int	OppositeDir(int dir)
int	RadianAngle(int x1, int y1, int x2, int y2)
int	RadianAngleDir4(int angle)
int	RadianAngleDir8(int angle)
int	Rand(int min, int max)
int	Randf(int n)
int	Randf(int n1, int n2)
bool	RectCollision(int box1_x1, int box1_y1, int box1_x2, int box1_y2, int box2_x1, int box2_y1, int box2_x2, int box2_y2)
void	Remove(lweapon l)
void	Remove(eweapon e)
void	Remove(itemsprite i)
void	Remove(npc n)
bool	RightOf(npc n)
bool	RightOf(ffc n)
bool	RightOf(eweapon n)
bool	RightOf(lweapon n)
int	Round(int x)
int	RotateScalePointX(int x, int y, int centerX, int centerY, int degrees, int scaleX, int scaleY)
int	RotateScalePointY(int x, int y, int centerX, int centerY, int degrees, int scaleX, int scaleY)
int	RotatePointX(int x, int y, int centerX, int centerY, int degrees)
int	RotatePointY(int x, int y, int centerX, int centerY, int degrees)
int	ScalePointX(int x, int centerX, int scale)
int	ScalePointY(int y, int centerY, int scale)
mapdata	LoadMD(int map, int scr)
mapdata	LoadMapDataDM(int dmap, int scr)
void	ScreenCopy(int destmap, int destscr, int srcmap, int srcscr)
int	ScreenEFlag(int category, int flag)
int	ScreenEFlag(int m, int scr, int category, int flag)
int	ScreenEFlag(mapdata md, int category, int flag)
int	ScreenFlag(int category, int flag)
int	ScreenFlag(int m, int scr, int category, int flag)
int	ScreenFlag(mapdata m, int category, int flag)
int	ScreenItem()
void	SetDMapFlag(int dmap, int flag, bool state)
void	SetEquipment(int a, int b)
void	SetItemPickup(itemsprite i, int pickup, bool state)
void	SetLayerComboC(int layer, int pos, int val)
void	SetLayerComboD(int layer, int pos, int val)
void	SetLayerComboF(int layer, int pos, int val)
void	SetLayerComboI(int layer, int pos, int val)
void	SetLayerComboS(int layer, int pos, int val)
void	SetLayerComboT(int layer, int pos, int val)
void	SetLevelItem(int level, int itm, bool state)
void	SetLevelItem(int itm, bool state)
void	SetMapscreenFlag(mapdata m, mapscreenflags flagid, bool state)
void	SetMapscreenFlag(int mapid, int scr, mapscreenflags flagid, bool state)
void	SetScreenDBit(int dmap, int screen, int d, int bit, bool state)
void	SetScreenDBit(int screen, int d, int bit, bool state)
void	SetScreenDBit(int d, int bit, bool state)
void	SetVisibleOnDungeonMap(bool state)
void	SetVisibleOnDungeonMap(int scr, bool state)
void	SetVisibleOnDungeonMap(dmapdata dm, bool state)
void	SetVisibleOnDungeonMap(dmapdata dm, int scr, bool state)
void	SetVisibleOnDungeonMap(dmapdata dm, int x, int y, bool state)
void	SetVisibleOnDungeonMap(bool no_offset, bool state)
void	SetVisibleOnDungeonMap(int scr, bool no_offset, bool state)
void	SetVisibleOnDungeonMap(dmapdata dm, bool no_offset, bool state)
void	SetVisibleOnDungeonMap(dmapdata dm, int scr, bool no_offset, bool state)
int	Sign(int n)
int	SmoothStep(int p1, int p2, int t)
int	SpinDir(int dir)
int	SpinDir8(int dir)
bool	SquareCollision(int c1x, int c1y, int side1, int c2x, int c2y, int side2)
bool	SquareCollision2(int c1x, int c1y, int radius1, int c2x, int c2y, int radius2)
void	SwapTileBlock(int first, int last, int second)
void	SwapTileRow(int first, int second, int length)
int	TurnTowards(int X, int Y, int targetX, int targetY, int radian_angle, int t = `1.0`)
bool	UsingItem(int id)
int	vbound(int x, int high, int low)
int	VBound(int x, int high, int low)
int	VectorX(int len, int angle)
int	VectorY(int len, int angle)
bool	VisibleOnDungeonMap(int x, int y)
bool	VisibleOnDungeonMap()
bool	VisibleOnDungeonMap(int scr)
bool	VisibleOnDungeonMap(dmapdata dm)
bool	VisibleOnDungeonMap(dmapdata dm, int scr)
bool	VisibleOnDungeonMap(dmapdata dm, int x, int y)
bool	VisibleOnDungeonMap(bool no_offset)
bool	VisibleOnDungeonMap(int scr, bool no_offset)
bool	VisibleOnDungeonMap(dmapdata dm, bool no_offset)
bool	VisibleOnDungeonMap(dmapdata dm, int scr, bool no_offset)
void	SetVisibleOnDungeonMap(int x, int y, bool state)
void	WaitNoAction()
void	WaitNoAction(int frames)
int	WeaponTypeToID(int wpnt)
void	getScrTimeName(char32[] buf, int scrtime)
untyped	wrap(untyped x, int mod)
eweapon	FireEWeaponAngle(int type, int x, int y, int radians, int step, int dmg, int sprite = `-1`, int sfx = `0`, int scriptid = `0`, untyped[] args = `NULL`)
eweapon	FireEWeaponDegAngle(int type, int x, int y, int degrees, int step, int dmg, int sprite = `-1`, int sfx = `0`, int scriptid = `0`, untyped[] args = `NULL`)
eweapon	FireEWeaponDir(int type, int x, int y, int dir, int step, int dmg, int sprite = `-1`, int sfx = `0`, int scriptid = `0`, untyped[] args = `NULL`)
eweapon	FireEWeaponAtHero(int type, int x, int y, bool angular, int step, int dmg, int sprite = `-1`, int sfx = `0`, int scriptid = `0`, untyped[] args = `NULL`)
lweapon	FireLWeaponAngle(int type, int x, int y, int radians, int step, int dmg, int sprite = `-1`, int sfx = `0`, int scriptid = `0`, untyped[] args = `NULL`)
lweapon	FireLWeaponDegAngle(int type, int x, int y, int degrees, int step, int dmg, int sprite = `-1`, int sfx = `0`, int scriptid = `0`, untyped[] args = `NULL`)
lweapon	FireLWeaponDir(int type, int x, int y, int dir, int step, int dmg, int sprite = `-1`, int sfx = `0`, int scriptid = `0`, untyped[] args = `NULL`)
bool	GetLevelSwitchState(int level, int switchNum)
void	SetLevelSwitchState(int level, int switchNum, bool state)
int	AdjacentCombo(int cmb, int dir)
bool	ChooseB()
void	ClearFFC(int ffc_id)
int	Distance(int x1, int y1, int x2, int y2)
int	Choose(int a, int b)
int	Choose(int a, int b, int c)
int	Choose(int a, int b, int c, int d)
int	Choose(int a, int b, int c, int d, int e)
int	Choose(int a, int b, int c, int d, int e, int f)
bool	blink(int[] clkptr, int frames)

Function descriptions#

bool Above(npc n) 🔗 Source

Returns if Link is above an npc.

bool Above(ffc n) 🔗 Source

Returns if Link is above, below, left of, or right of an ffc.

bool Above(eweapon n) 🔗 Source

Returns if Link is above, below, left of, or right of an eweapon.

bool Above(lweapon n) 🔗 Source

Returns if Link is above, below, left of, or right of an lweapon.

void AimEWeapon(eweapon e, int aimtype) 🔗 Source

Various methods for shooting at Link and at random

void AimLWeapon(lweapon l, npc n, int aimtype) 🔗 Source

Aiming at enemies and at random

void AimLWeapon(lweapon l, int aimtype) 🔗 Source

int Angle(int x1, int y1, int x2, int y2) 🔗 Source

Returns the direction of the vector from point 1 to point 2, in degrees from -180 to 180. (0 = right)

int AngleDir4(int angle) 🔗 Source

Converts a counterclockwise degree angle (from -180 to 180) into one of the four standard directions (DIR_UP, DIR_DOWN, DIR_LEFT, DIR_RIGHT) used by ZC.

int AngleDir8(int angle) 🔗 Source

Converts a counterclockwise degree angle (from -180 to 180) into one of the eight standard directions (DIR_UP etc.) used by ZC.

int AtFrontX(int dir) 🔗 Source

Returns the correct offset to be at the front of a sprite facing in the direction ‘dir’

int AtFrontY(int dir) 🔗 Source

bool Below(npc n) 🔗 Source

Returns if Link is below an npc.

bool Below(ffc n) 🔗 Source

Returns if Link is above, below, left of, or right of an ffc.

bool Below(eweapon n) 🔗 Source

Returns if Link is above, below, left of, or right of an eweapon.

bool Below(lweapon n) 🔗 Source

Returns if Link is above, below, left of, or right of an lweapon.

bool CanWalk(int x, int y, int dir, int step, bool full_tile) 🔗 Source

This should allow any scripted object to easily mimic Link styled LOZ solidity collision checking, be it Link, FFCs, or enemies. Note - You should use full_tile=true if you don’t want the upper eight pixels to overlap solid combos as per LOZ1 behavior.

int CenterLinkX() 🔗 Source

Get the X and Y coordinates at the center of a sprite

int CenterLinkY() 🔗 Source

int CenterX(ffc anFFC) 🔗 Source

int CenterX(npc anNPC) 🔗 Source

int CenterX(eweapon anEWeapon) 🔗 Source

int CenterX(lweapon anLWeapon) 🔗 Source

int CenterX(itemsprite it) 🔗 Source

int CenterY(ffc anFFC) 🔗 Source

int CenterY(npc anNPC) 🔗 Source

int CenterY(eweapon anEWeapon) 🔗 Source

int CenterY(lweapon anLWeapon) 🔗 Source

int CenterY(itemsprite it) 🔗 Source

bool CircleCollision(int c1x, int c1y, int radius1, int c2x, int c2y, int radius2) 🔗 Source

Returns true if the two circles c1 and c2 overlap.

int Clamp(int x, int low, int high) 🔗 Source

Clamps x to the range of low, high.

void ClearTileBlock(int reffirst, int reflast) 🔗 Source

Clears a block of tiles defined by diagonal corners ‘reffirst’ and ‘reflast’

void ClearTileRow(int ref, int length) 🔗 Source

Clears a row of tiles of length ‘length’ starting from tile ‘ref’

bool Collision(lweapon a, eweapon b) 🔗 Source

Returns true if there is a collision between the hitboxes of an lweapon and an eweapon.

bool Collision(lweapon a, lweapon b) 🔗 Source

A collision between an lweapon and an lweapon.

bool Collision(eweapon a, eweapon b) 🔗 Source

A collision between an eweapon and an eweapon.

bool Collision(lweapon a, npc b) 🔗 Source

A collision between an lweapon and an npc.

bool Collision(eweapon a, npc b) 🔗 Source

A collision between an eweapon and an npc.

bool Collision(npc a, npc b) 🔗 Source

A collision between an npc and an npc.

bool Collision(itemsprite a, lweapon b) 🔗 Source

A collision between an item and an lweapon.

bool Collision(itemsprite a, eweapon b) 🔗 Source

A collision between an item and an eweapon.

bool Collision(itemsprite a, npc b) 🔗 Source

A collision between an item and an npc.

bool Collision(itemsprite a, itemsprite b) 🔗 Source

A collision between an item and an item.

bool Collision(ffc f, lweapon b) 🔗 Source

A collision between an ffc and an lweapon. Uses TileWidth and TileHeight for the FFC’s bounding box. Ignores the Z axis.

bool Collision(ffc f, eweapon b) 🔗 Source

A collision between an ffc and an eweapon. Uses TileWidth and TileHeight for the FFC’s bounding box. Ignores the Z axis.

bool Collision(ffc f, npc b) 🔗 Source

A collision between an ffc and an npc. Uses TileWidth and TileHeight for the FFC’s bounding box. Ignores the Z axis.

bool Collision(ffc f, itemsprite b) 🔗 Source

A collision between an ffc and an item. Uses TileWidth and TileHeight for the FFC’s bounding box. Ignores the Z axis.

bool Collision(ffc f, ffc f2) 🔗 Source

A collision between an ffc and an ffc. Uses TileWidth and TileHeight for the FFCs’ bounding boxes.

bool Collision(ffc f, int radius1, ffc f2, int radius2) 🔗 Source

A circular collision between an ffc and an ffc. Uses TileWidth and TileHeight to find the center of the FFCs.

bool Collision(eweapon a, lweapon b) 🔗 Source

So that you don’t have to remember the ordering of the args

bool Collision(npc a, lweapon b) 🔗 Source

bool Collision(npc a, eweapon b) 🔗 Source

bool Collision(lweapon a, itemsprite b) 🔗 Source

bool Collision(eweapon a, itemsprite b) 🔗 Source

bool Collision(npc a, itemsprite b) 🔗 Source

bool Collision(lweapon a, ffc b) 🔗 Source

bool Collision(eweapon a, ffc b) 🔗 Source

bool Collision(npc a, ffc b) 🔗 Source

bool Collision(itemsprite a, ffc b) 🔗 Source

bool Collision(eweapon b) 🔗 Source

Returns true if there is a collision between Link’s hitbox and the eweapon’s. This only checks hitboxes.

bool Collision(lweapon b) 🔗 Source

Returns true if there is a collision between Link’s hitbox and the lweapon’s. This only checks hitboxes.

bool Collision(itemsprite b) 🔗 Source

Returns true if there is a collision between Link’s hitbox and the item’s. This only checks hitboxes.

bool Collision(npc b) 🔗 Source

Returns true if there is a collision between Link’s hitbox and the npc’s. This only checks hitboxes. Uses TileWidth and TileHeight to find the center of the FFCs.

bool Collision(ffc f) 🔗 Source

Returns true if there is a collision between Link’s hitbox and the FFC’s. This only checks hitboxes.

bool Collision(combodata f) 🔗 Source

Only legal from combodata scripts as this->Collision

int ComboAt(int x, int y) 🔗 Source

Finds the location of a combo, given its (x,y) coordinates on the screen

bool ComboFI(int x, int y, int flag) 🔗 Source

Returns true if the combo at ‘(x, y)’ has either an inherent or place flag of type ‘flag’

bool ComboFI(int loc, int flag) 🔗 Source

Returns true if the combo at ‘loc’ has either an inherent or place flag of type ‘flag’

int ComboX(int rpos) 🔗 Source

Note: all of the Region->ID checks in these various functions are minor performance improvements. The functions likely work even without that. Return the coordinates of a combo on the screen

int ComboY(int rpos) 🔗 Source

int RegionRelativeScreenX(int scr) 🔗 Source

Given a screen index, returns the screen offset in the X direction in the current region. Example: If the region origin is screen 5, RegionRelativeScreenX(8) == 3

int RegionRelativeScreenY(int scr) 🔗 Source

Given a screen index, returns the screen offset in the Y direction in the current region.

int RegionWorldOffsetX(int scr) 🔗 Source

Given a screen index, returns the world offset in the x direction for the current region.

int RegionWorldOffsetY(int scr) 🔗 Source

Given a screen index, returns the world offset in the y direction for the current region.

bool RegionIncludesScreen(int scr) 🔗 Source

Returns true if the given screen index is inside the current region. When not in a region, only returns true if scr is equal to Game->CurScreen.

int RegionGetFFCId(int scr, int index) 🔗 Source

Returns the FFC ID of the screen scr, which must be within the current Region. index is the screen-specific index of the FFC (what you would see in the editor on that screen).

T Cond(bool cond, T a, T b) 🔗 Source

Returns a if cond is true, else b. Overloaded.

Warning

Deprecated! Consider using a ternary expression instead: cond ? a : b

bool ConsumeKey(int level = -1) 🔗 Source

void CopyTileBlock(int sourcefirst, int sourcelast, int destfirst) 🔗 Source

Copies a block of tiles defined by diagonal corners ‘sourcefirst’ and ‘sourcelast’ onto the block starting with top left tile ‘destfirst’

void CopyTileRow(int source, int dest, int length) 🔗 Source

Copies a row of tiles of length ‘length’ from ‘source’ onto ‘dest’

void CounterAdd(int counter, int amount) 🔗 Source

Add to a counter without rollover.

void CounterReduce(int counter, int amount) 🔗 Source

Reduce a counter without rollvoer.

eweapon CreateEWeaponAt(int id, int x, int y) 🔗 Source

Create an EWeapon and set its X and Y position in one command

itemsprite CreateItemAt(int id, int x, int y) 🔗 Source

Create an Item and set its X and Y position in one command

lweapon CreateLWeaponAt(int id, int x, int y) 🔗 Source

Create an LWeapon and set its X and Y position in one command

npc CreateNPCAt(int id, int x, int y) 🔗 Source

Create an NPC and set its X and Y position in one command

itemsprite CreateTimeoutItem(int id, int x, int y) 🔗 Source

Creates a timeout item (like a rupee or heart)

int CrossProduct(int x1, int y1, int x2, int y2) 🔗 Source

Returns the cross product of two vectors.

void DCounterAdd(int counter, int amount) 🔗 Source

D Add to a drain counter without rollover.

void DCounterReduce(int counter, int amount) 🔗 Source

Reduce a drain counter without rollvoer.

int DefeatedLevelBoss(int level) 🔗 Source

Returns if Link has defeated the dungeon boss for a given level.

int DirNormal(int dir) 🔗 Source

Normalizes a dir between 8 and 15

int DirAbnormal(int dir) 🔗 Source

The reverse

int Dir4Angle(int dir) 🔗 Source

Returns angle of the given direction.

int DirAngle(int dir) 🔗 Source

Returns angle of the given direction.

int Dir4Rad(int dir) 🔗 Source

Same as Dir4Angle, but return value is measured in radians.

int DirRad(int dir) 🔗 Source

Same as DirAngle, but return value is measured in radians.

int DistanceSquared(int x, int y) 🔗 Source

Returns the squared distance of a vector.

bool DistXY(ffc a, int dist) 🔗 Source

returns true if Link is within ‘dist’ distance of an ffc on both its X and its Y axis.

int Div(int x, int y) 🔗 Source

Returns the Quotient only of x divided by y

int DMapMapGraphicsIndex(dmapdata dm) 🔗 Source

Returns the correct index for getting minimap, or dungeon map tiles and csets to use with dmapdata->MiniMapTile[] and similar instructions. Accepts a dmapdata pointer.

int DMapMapGraphicsIndex(int dmapID) 🔗 Source

Returns the correct index for getting minimap, or dungeon map tiles and csets to use with dmapdata->MiniMapTile[] and similar instructions. Accepts a dmap ID as an integer.

int DMapMapGraphicsIndex() 🔗 Source

Returns the correct index for getting minimap, or dungeon map tiles and csets to use with dmapdata->MiniMapTile[] and similar instructions. Checks the current DMap.

int DMapToMap(int screen, int dmap) 🔗 Source

Convert between map and DMap screens

int DotProduct(int x1, int y1, int x2, int y2) 🔗 Source

Returns the dot product of two vectors.

void DrawString(int layer, int x, int y, int font, int color, int background_color, int format, int opacity, char32[] ptr, int start) 🔗 Source

Overload to Screen->DrawString which includes a position to begin drawing from in the string Does not check for overflow

void DrawString(int layer, int x, int y, int font, int color, int background_color, int format, int opacity, char32[] ptr, int start, int end) 🔗 Source

Overload to Screen->DrawString which includes a start and end position to draw the string Does not check for overflow

void DrawTileSimple(int x, int y, int tile, int color) 🔗 Source

A very simple layer 0 tile drawing routine.

void DrawToLayer(ffc f, int layer, int opacity) 🔗 Source

Draws an ffc to a given layer. If the ffc is larger than 1x1 its graphics must all be comboed

void DrawToLayer(npc n, int layer, int opacity) 🔗 Source

Draws an npc to a given layer

void DrawToLayer(lweapon l, int layer, int opacity) 🔗 Source

Draws an lweapon to a given layer

void DrawToLayer(eweapon e, int layer, int opacity) 🔗 Source

Draws an eweapon to a given layer

void DrawToLayer(itemsprite i, int layer, int opacity) 🔗 Source

Draws an item to a given layer

lweapon Duplicate(lweapon a) 🔗 Source

Creates and returns an exact copy of the passed LWeapon. Assumes that the passed pointer is valid.

eweapon Duplicate(eweapon a) 🔗 Source

Creates and returns an exact copy of the passed EWeapon. Assumes that the passed pointer is valid.

bool EnemiesAlive() 🔗 Source

E Returns if there are enemy NPCs alive on the current screen.

bool Facing(ffc f) 🔗 Source

F Returns if Link is facing an ffc.

int FFCNum(ffc f) 🔗 Source

Returns the number of an FFC, and -1 for a non-valid FFC (which should never happen)

int FirstComboFlagOf(int t, int layer) 🔗 Source

Returns the position of the first instance of the given combo flag, or -1. Checks inherent flags too!

int FirstComboTypeOf(int t, int layer) 🔗 Source

Returns the position of the first instance of the given combo, or -1.

int FirstComboOf(int t, int layer) 🔗 Source

Returns the position of the first instance of the given combo, or -1.

catchalltypes GetCatchallType(mapdata m) 🔗 Source

G Returns the catchall type used by a mapscreen passed as pointer ‘m’.

int GetEquipmentA() 🔗 Source

Returns the item ID of the item equipped to the A button

int GetEquipmentB() 🔗 Source

return (Hero->Equipment&0xFF); Returns the item ID of the item equipped to the B button

int GetEquipmentX() 🔗 Source

return ((Hero->Equipment&0xFF00)>>8); Returns the item ID of the item equipped to the X button

int GetEquipmentY() 🔗 Source

return ((Hero->Equipment&0xFF00)>>8); Returns the item ID of the item equipped to the Y button

bool GetDMapFlag(int dmap, int flag) 🔗 Source

return ((Hero->Equipment&0xFF00)>>8); Returns true if DMap bitwise flags ‘flag’ is set on dmap ‘dmap’

int GetFirstItemOf(int itemclass) 🔗 Source

int GetHighestLevelItem(int itemclass) 🔗 Source

int GetHighestLevelItem(itemsprite i) 🔗 Source

int GetHighestLevelItemOwned(int itemclass) 🔗 Source

Faster than the old function; this now works exactly how the engine handles it. -Em

messagedata GetInfoString(int shop_id, int str_id) 🔗 Source

Gets the ZString (message) ID used by a Pay for Info Shop. Argument 1 is the info shop ID, argument 2 is the shop’s string (0 to 2). Returns the string typed as messagedata, e.g. messagedata md = GetInfoString(shop, 0);

void GetInfoString(char32[] buffer, int shop_id, int str_id) 🔗 Source

Copies the ZString (message) ID used by a Pay for Info Shop to a client (ZScript) string. Argument 1 is a ZScript string pointer, Arguent 2 is the info shop ID, Argument 3 is the shop’s string (0 to 2).

int GetInfoStringID(int shop_id, int str_id) 🔗 Source

Gets the ZString (message) ID used by a Pay for Info Shop. Argument 1 is the info shop ID, argument 2 is the shop’s string (0 to 2). Returns an integer of the string ID.

itemdata GetItemData(itemsprite i) 🔗 Source

bool GetItemPickup(itemsprite i, int pickup) 🔗 Source

Returns true if an item’s Pickup state is set Use the IP_ constants for the ‘pickup’ argument of this function

int GetLayerComboC(int layer, int pos) 🔗 Source