Hero

Inherits: sprite

Contains functions and variables related to the playable hero character.

Access with Hero->.

Variables

int	HitDir
int	SwordJinx
int	ItemJinx
int	HP
int	MP
int	MaxHP
int	MaxMP
int	Action
int	TileMod
int	HeldItem
bool[]	Item
int[]	Steps
int	Step
int	ShoveOffset
int	Drunk
int	HealthBeep
bool	Invisible
bool	NoStepForward
bool	CollDetection
int[]	Defense
untyped[]	HitBy
const int	LadderX
const int	LadderY
int	InvFrames
bool	InvFlicker
int	HurtSound
int	ItemB
int	ItemA
int	ItemX
int	ItemY
int	Eaten
bool	Grabbed
int	Stun
int	BunnyClk
int	Pushing
int	ScriptCSet
bool	Diagonal
bool	BigHitbox
bool	Climbing
int	JumpCount
const int	PitPullDir
int	PitPullTimer
bool	ClockActive
int	ClockTimer
const bool	IsWarping
int	RespawnX
int	RespawnY
int	RespawnDMap
int	RespawnScreen
const int	SwitchTimer
const int	SwitchMaxTimer
int	Immortal
const bool	Standing
int	CoyoteTime
lweapon	LiftedWeapon
int	LiftTimer
int	LiftMaxTimer
int	LiftHeight
int	HammerState
bool[]	LiftFlags
int	ShieldJinx
int	FlickerColor
int	FlickerTransparencyPasses
const int	FlashingCSet
const int	Sliding
const int	IceCombo
int	ScriptIceCombo
int	IceVx
int	IceVy
int	IceEntryFrames
int	IceEntryMaxFrames
bool	InputStart
bool	InputMap
bool	InputUp
bool	InputDown
bool	InputLeft
bool	InputRight
bool	InputA
bool	InputB
bool	InputL
bool	InputR
bool	InputEx1
bool	InputEx2
bool	InputEx3
bool	InputEx4
bool	PressStart
bool	PressUp
bool	PressDown
bool	PressLeft
bool	PressRight
bool	PressA
bool	PressB
bool	PressL
bool	PressR
bool	PressEx1
bool	PressEx2
bool	PressEx3
bool	PressEx4
int	InputMouseX
int	InputMouseY
int	InputMouseZ
int	InputMouseB
bool	InputAxisUp
bool	InputAxisDown
bool	InputAxisLeft
bool	InputAxisRight
bool	PressAxisUp
bool	PressAxisDown
bool	PressAxisLeft
bool	PressAxisRight
bool	PressMap
const int	TotalDYOffset
int	Equipment

Functions

void	Warp(int DMap, int screen)
void	WarpEx(int[] ptr)
void	Explode(int arg1)
void	PitWarp(int arg1, int arg2)
void	SelectAWeapon(int dir)
void	SelectBWeapon(int dir)
void	SelectXWeapon(int dir)
void	SelectYWeapon(int dir)
bool	SwitchCombo(int pos, int effect)
void	Kill(bool bypass_revive = false)
bool	MoveXY(int dx, int dy, bool is_knockback = false, bool ignore_sideview = false, bool corner_shove = true)
bool	CanMoveXY(int dx, int dy, bool is_knockback = false, bool ignore_sideview = false, bool corner_shove = true)
bool	MoveAtAngle(int degrees, int pixels, bool is_knockback = false, bool ignore_sideview = false, bool corner_shove = true)
bool	CanMoveAtAngle(int degrees, int pxamnt, bool is_knockback = false, bool ignore_sideview = false, bool corner_shove = true)
bool	Move(int dir, int pixels, bool is_knockback = false, bool ignore_sideview = false, bool corner_shove = true)
bool	CanMove(int dir, int pxamnt, bool is_knockback = false, bool ignore_sideview = false, bool corner_shove = true)
lweapon	ReleaseLiftWeapon()
void	LiftWeapon(lweapon arg1, int arg2, int arg3)
bool	isFlickerFrame()
void	Warp(int arg1)
void	SetItemA(int arg1)
void	SetItemB(int arg1)
void	SetItemSlot(int itm_id, int button, int force)
int	GetOriginalTile(int arg1, int arg2)
int	GetOriginalFlip(int arg1, int arg2)

Enumerations

enum HeroSliding: 🔗 Source

HeroSliding SLD_NONE = 0

HeroSliding SLD_ICE = 1

sliding on the ground, on ice

HeroSliding SLD_AIR = 2

sliding in the air (momentum from ice)

HeroSliding SLD_MAX = 3

---

Variable descriptions

int HitDir 🔗 Source

---

int SwordJinx 🔗 Source

---

int ItemJinx 🔗 Source

---

int HP 🔗 Source

---

int MP 🔗 Source

---

int MaxHP 🔗 Source

---

int MaxMP 🔗 Source

---

int Action 🔗 Source

---

int TileMod 🔗 Source

The current *total* Hero Tile Modifier.

---

int HeldItem 🔗 Source

---

bool[] Item 🔗 Source

Reading from, or writing to this array no longer causes lag.

---

int[] Steps 🔗 Source

The number of pixels that the Hero moves in a frame, based on present coordinates. The movement is taken from X and Y:

x_move_in_pixels = Hero->Steps[Hero->X&7];
y_move_in_pixels = Hero->Steps[Hero->Y&7];

The default values are: { 1, 1, 2, 1, 1, 2, 1, 1 }

You can double the speed by doubling these values.

NOTE: This only affects 4-way movement, and has no effect if the quest rule New Hero Movement is enabled.

---

int Step 🔗 Source

The rate the Hero moves at. This is similar to npc::Step: a step of 100 moves the Hero 1 pixel per frame. The default step rate is 150, which moves the Hero 1.5 pixels per frame.

NOTE: This affects BOTH 4-way and 8-way movement, but ONLY if the quest rule New Hero Movement is enabled.

---

int ShoveOffset 🔗 Source

The offset from corners that the Hero’s movement will ‘shove’ them around. Ranges from 0-16

NOTE: Only applies if Newer Hero Movement Quest Rule is enabled.

---

int Drunk 🔗 Source

---

int HealthBeep 🔗 Source

The timer for the health beep sound, if it is not constant.

Setting this to -2 suspends system control over stopping the sound, and setting this to -4 suspends system control over both stopping, and starting it.

The normal operating range used by the system is 70 to -1, where -1 wraps around to zero internally.

---

bool Invisible 🔗 Source

---

bool NoStepForward 🔗 Source

If set true, the Hero will not take two steps into NES dungeon rooms.

This value is reset to false every time that the hero sprite is initialised, so should be written ideally in the hero init script.

!! Future versions may change when this is cleared.

---

bool CollDetection 🔗 Source

---

int[] Defense 🔗 Source

Unused at this time.

---

untyped[] HitBy 🔗 Source

Stores the ID/UIDs of objects that hurt the Link this frame.

---

const int LadderX 🔗 Source

---

const int LadderY 🔗 Source

---

int InvFrames 🔗 Source

This returns how long Link will remain invincible, 0 if not invincible. Can be set.

---

bool InvFlicker 🔗 Source

If set false, Link will neither flash, nor flicker when invincible.

---

int HurtSound 🔗 Source

The sound that plays when Link is injured. By default this is 16, but you may change it at any time.

---

int ItemB 🔗 Source

Contains the item IDs of what is currently equiped to Link’s B button.

---

int ItemA 🔗 Source

Contains the item IDs of what is currently equiped to Link’s A button.

---

int ItemX 🔗 Source

Contains the item IDs of what is currently equiped to Link’s X (Ex1) button.

---

int ItemY 🔗 Source

Contains the item IDs of what is currently equiped to Link’s Y (Ex2) button.

---

int Eaten 🔗 Source

Returns 0 if the Hero is not eaten, otherwise it returns the duration of them being eaten.

---

bool Grabbed 🔗 Source

Returns if the Hero is grabbed (i.e. by wallmaster)

---

int Stun 🔗 Source

Returns the number of frames for which Link will; remain stunned.

Writing to this causes Link to be stunned for ‘n’ frames.

This decrements once per frame.

---

int BunnyClk 🔗 Source

Returns the number of frames for which the Hero will be a Bunny.

If -1, the effect will be removed by the engine if the current

dmap does not have the bunny flag, or the Hero possesses a pearl item.

-2 through -99 reserved for potential future engine use If <-100, the effect will last until script-modified

If >0, will tick down each frame

---

int Pushing 🔗 Source

Returns the number of frames that Link has been pushing against a solid object.

---

int ScriptCSet 🔗 Source

---

bool Diagonal 🔗 Source

This corresponds to whether ‘Diagonal Movement’ is enabled, or not.

---

bool BigHitbox 🔗 Source

This corresponds to whether ‘Big Hitbox’ is enabled, or not.

---

bool Climbing 🔗 Source

Returns as ‘true’ when the hero is climbing a sideview ladder

Setting to ‘false’ will let go of the ladder, and setting ‘true’ will grab the ladder

While ‘true’, gravity does not affect the hero

---

int JumpCount 🔗 Source

Returns the number of times the hero has jumped in mid-air since last landing.

If this is positive, it will be reset to 0 the next frame the hero is on the ground.

Used by Roc’s Feather items to determine how many extra jumps the hero has left

---

const int PitPullDir 🔗 Source

Returns the direction that the Hero is being pulled in by a pit

---

int PitPullTimer 🔗 Source

A timer related to pits pulling the hero

The pit will only pull the hero on frames where ‘PitPullTimer % PitSensitivity == 0’

The Pit Sensitivity is an attribyte on the pit combo

---

bool ClockActive 🔗 Source

Returns true if a stopwatch/clock is active.

Writing to this acts like picking up a stopwatch/clock item, and sets the duration of its effect based on ClockTimer. If ClockTimer is 0, the effect.

Lasts until the Hero changes screens.

---

int ClockTimer 🔗 Source

Returns the current ticks of a stopwatch/clock item countdown timer.

Writing to this while ClockActive is true sets or changes the duration of the clock effect; if no stopwatch/clock is active, it pre-sets the value so that you may start a timed effect by setting ClockActive to true.

---

const bool IsWarping 🔗 Source

Returns true if the Hero is currently being warped

Note that as scripts generally do not run in warps, this may not ever return true during a given warp, depending on the warp type, QRs, script type, etc.

---

int RespawnX 🔗 Source

The X-coordinate at which the Hero will respawn upon drowning or such.

The engine may overwrite this value upon changing screens or standing on safe ground.

---

int RespawnY 🔗 Source

The Y-coordinate at which the Hero will respawn upon drowning or such.

The engine may overwrite this value upon changing screens or standing on safe ground.

---

int RespawnDMap 🔗 Source

The DMap at which the Hero will respawn upon drowning or such.

The engine may overwrite this value upon changing screens or standing on safe ground.

---

int RespawnScreen 🔗 Source

The screen at which the Hero will respawn upon drowning or such.

The engine may overwrite this value upon changing screens or standing on safe ground.

---

const int SwitchTimer 🔗 Source

The timer for the switchhook effect. If > 0, a switch effect is active.

The Hero will swap positions with the target when this is equal to Hero->SwitchMaxTimer / 2, and the animation completes when this reaches 0.

---

const int SwitchMaxTimer 🔗 Source

The starting (max) value of the switch timer.

---

int Immortal 🔗 Source

If non-zero, the Hero will not die, even if their HP drops to 0.

This will prevent effects such as bottled fairies from being triggered.

If greater than 0, decrements by 1 each frame.

If it becomes 0 while the Hero has 0 hp, it will act as though their HP just dropped to 0 that frame, and normal effects such as fairies will trigger.

---

const bool Standing 🔗 Source

Returns true if the hero is ‘standing’, as is used to check if they are capable of jumping. Automatically accounts for sideview.

---

int CoyoteTime 🔗 Source

The number of frames the hero has been off the ground. Range 0-65535.

0 while standing. When not standing, ticks up by 1 each frame.

When jumping, is immediately set to 65535.

If this value is < 65535 and < a feather’s “Coyote Time” attribute, the feather will be able to jump despite being in the air.

Setting this to 65535 will disable coyote jumps, though this will be set to 0 upon landing on the ground again.

---

lweapon LiftedWeapon 🔗 Source

---

int LiftTimer 🔗 Source

---

int LiftMaxTimer 🔗 Source

---

int LiftHeight 🔗 Source

---

int HammerState 🔗 Source

Returns a value representing the current hammer swing. - 0 = not swinging hammer - 1 = hammer above head - 2 = hammer at angle - 3 = hammer hit the ground

---

bool[] LiftFlags 🔗 Source

---

int ShieldJinx 🔗 Source

The time, in frames, that the shield is disabled. Negative values disable indefinitely.

---

int FlickerColor 🔗 Source

This sets what color Link is drawn when flickering.

If -1, will use the default from Init Data.

If the quest rule ‘Invincible Hero Flickers’ is unchecked, this is unused.

---

int FlickerTransparencyPasses 🔗 Source

This sets how many times the transparency effect is applied to Link’s flicker effect.

If -1, will use the default from Init Data. If 0, will use a solid color.

If the quest rule ‘Invincible Hero Flickers’ is unchecked, this is unused.

---

const int FlashingCSet 🔗 Source

This returns Link’s current displayed cset when taking damage or invincible. If not in one of these states, will return his normal cset.

If called before Waitdraw() / Hero update, results may be off by a frame.

If the quest rule ‘Invincible Hero Flickers’ is checked, this is unused.

---

const int Sliding 🔗 Source

Valid values: HeroSliding (SLD_).

---

const int IceCombo 🔗 Source

The icy combo the Hero is sliding on.

---

int ScriptIceCombo 🔗 Source

Read-write. If nonzero, this combo is used instead of the IceCombo (can be used to force the Hero to slide).

If the specified combo is not an Icy Floor combo that affects the Hero, no sliding will occur.

---

int IceVx 🔗 Source

The Hero’s ice velocity (in pixels per frame). Has no effect unless the Hero is Sliding. If the Hero is not Sliding, the engine will clear these to 0.

---

int IceVy 🔗 Source

The Hero’s ice velocity (in pixels per frame). Has no effect unless the Hero is Sliding. If the Hero is not Sliding, the engine will clear these to 0.

---

int IceEntryFrames 🔗 Source

Read/write, 0-255, has no effect unless the Hero is Sliding.

Used to grant the Hero some leeway when first entering the ice.

On entering the ice, these are set to the same value, and ‘IceEntryFrames’ then ticks down each frame to 0. Instantly goes to 0 if the Hero is still.

Based on the ratio between these values, the Hero’s deceleration will be somewhere between the IceCombo’s deceleration and half of the Hero’s step speed.

---

int IceEntryMaxFrames 🔗 Source

Read/write, 0-255, has no effect unless the Hero is Sliding.

Used to grant the Hero some leeway when first entering the ice.

On entering the ice, these are set to the same value, and ‘IceEntryFrames’ then ticks down each frame to 0. Instantly goes to 0 if the Hero is still.

Based on the ratio between these values, the Hero’s deceleration will be somewhere between the IceCombo’s deceleration and half of the Hero’s step speed.

---

bool InputStart 🔗 Source

---

bool InputMap 🔗 Source

---

bool InputUp 🔗 Source

---

bool InputDown 🔗 Source

---

bool InputLeft 🔗 Source

---

bool InputRight 🔗 Source

---

bool InputA 🔗 Source

---

bool InputB 🔗 Source

---

bool InputL 🔗 Source

---

bool InputR 🔗 Source

---

bool InputEx1 🔗 Source

---

bool InputEx2 🔗 Source

---

bool InputEx3 🔗 Source

---

bool InputEx4 🔗 Source

---

bool PressStart 🔗 Source

---

bool PressUp 🔗 Source

---

bool PressDown 🔗 Source

---

bool PressLeft 🔗 Source

---

bool PressRight 🔗 Source

---

bool PressA 🔗 Source

---

bool PressB 🔗 Source

---

bool PressL 🔗 Source

---

bool PressR 🔗 Source

---

bool PressEx1 🔗 Source

---

bool PressEx2 🔗 Source

---

bool PressEx3 🔗 Source

---

bool PressEx4 🔗 Source

---

int InputMouseX 🔗 Source

---

int InputMouseY 🔗 Source

---

int InputMouseZ 🔗 Source

---

int InputMouseB 🔗 Source

---

bool InputAxisUp 🔗 Source

---

bool InputAxisDown 🔗 Source

---

bool InputAxisLeft 🔗 Source

---

bool InputAxisRight 🔗 Source

---

bool PressAxisUp 🔗 Source

---

bool PressAxisDown 🔗 Source

---

bool PressAxisLeft 🔗 Source

---

bool PressAxisRight 🔗 Source

---

bool PressMap 🔗 Source

---

const int TotalDYOffset 🔗 Source

---

int Equipment 🔗 Source

Link->Equipment is now read-write, and needs testing.

---

Function descriptions

void Warp(int DMap, int screen) 🔗 Source

Warps link to the given screen in the given DMap, just like if he’d triggered an ‘Insta-Warp’-type warp.

Uses warp return square A, unless compat rule Old 'Hero->Warp' Return Square is on, in which case it uses the warp return square of the current screen’s Sidewarp A.

---

void WarpEx(int[] ptr) 🔗 Source

---

void Explode(int arg1) 🔗 Source

---

void PitWarp(int arg1, int arg2) 🔗 Source

---

void SelectAWeapon(int dir) 🔗 Source

Changes the A button item (respectively), in the same manner the engine subscreen cursor moves. DIR_RIGHT/DIR_LEFT are equivalent to how quickswap cycles.

Does nothing if the QR allowing items to be set for that button is not enabled.

---

void SelectBWeapon(int dir) 🔗 Source

Changes the B button item (respectively), in the same manner the engine subscreen cursor moves. DIR_RIGHT/DIR_LEFT are equivalent to how quickswap cycles.

---

void SelectXWeapon(int dir) 🔗 Source

Changes the X button item (respectively), in the same manner the engine subscreen cursor moves. DIR_RIGHT/DIR_LEFT are equivalent to how quickswap cycles.

Does nothing if the QR allowing items to be set for that button is not enabled.

---

void SelectYWeapon(int dir) 🔗 Source

Changes the Y button item (respectively), in the same manner the engine subscreen cursor moves. DIR_RIGHT/DIR_LEFT are equivalent to how quickswap cycles.

Does nothing if the QR allowing items to be set for that button is not enabled.

---

bool SwitchCombo(int pos, int effect) 🔗 Source

Switch the Hero with the given combo position. Returns true if successful.

Valid values for effect: SwitchEffect (SW_EFF_).

---

void Kill(bool bypass_revive = false) 🔗 Source

Kills the Hero. Their HP will be set to 0, and ‘Immortal’ will be bypassed.

If ‘bypass_revive’ is true, bottles will not be checked for revival items, and the normal single frame delay before death that is used for script-revival will also be skipped.

Otherwise, revival processes will occur as normal.

---

bool MoveXY(int dx, int dy, bool is_knockback = false, bool ignore_sideview = false, bool corner_shove = true) 🔗 Source

Attempts to move the Hero by ‘dx, dy’; obeying solidity.

is_knockback should be true if this movement is the result of some scripted form of knockback.

This currently has no effect for the Hero… It may in the future?

‘ignore_sideview’: if this is false, and the current screen is sideview gravity, ‘dy’ will be ignored (unless the Hero is ‘Climbing’, has walk-through-walls enabled, or is sideview swimming)

corner_shove: if this is true, and the movement is not diagonal (i.e. one of dx or dy is 0), then if the movement pushes the Hero into the corner of a solid, the Hero will automatically be shoved ‘around’ the corner. (Same as how engine movement does it)

Returns true if the full distance was moved, false otherwise.

---

bool CanMoveXY(int dx, int dy, bool is_knockback = false, bool ignore_sideview = false, bool corner_shove = true) 🔗 Source

Same as MoveXY(), but does not move the Hero- instead, just returns true/false based on what MoveXY() would return.

---

bool MoveAtAngle(int degrees, int pixels, bool is_knockback = false, bool ignore_sideview = false, bool corner_shove = true) 🔗 Source

Like MoveXY(), but for a pixels movement in the degrees angle.

---

bool CanMoveAtAngle(int degrees, int pxamnt, bool is_knockback = false, bool ignore_sideview = false, bool corner_shove = true) 🔗 Source

Like MoveAtAngle(), but does not move the Hero - instead, just returns true/false based on what MoveAtAngle() would return.

---

bool Move(int dir, int pixels, bool is_knockback = false, bool ignore_sideview = false, bool corner_shove = true) 🔗 Source

Like MoveXY(), but for a pixels movement in the dir direction.

---

bool CanMove(int dir, int pxamnt, bool is_knockback = false, bool ignore_sideview = false, bool corner_shove = true) 🔗 Source

Like Move(), but does not move the Hero - instead, just returns true/false based on what Move() would return.

---

lweapon ReleaseLiftWeapon() 🔗 Source

---

void LiftWeapon(lweapon arg1, int arg2, int arg3) 🔗 Source

---

bool isFlickerFrame() 🔗 Source

This returns true if the Hero is currently in a flicker frame (either invisible or color masked).

If called before Waitdraw() / Hero update, results may be off by a frame.

If the quest rule ‘Invincible Hero Flickers’ is unchecked, this is unused.

---

void Warp(int arg1) 🔗 Source

---

void SetItemA(int arg1) 🔗 Source

---

void SetItemB(int arg1) 🔗 Source

---

void SetItemSlot(int itm_id, int button, int force) 🔗 Source

This allows you to set Link’s button items without binary operation with options for forcing them.

Use the constants ITM_REQUIRE_ and ITM_SLOT_ from <std> when passing values into this function.

---

int GetOriginalTile(int arg1, int arg2) 🔗 Source

---

int GetOriginalFlip(int arg1, int arg2) 🔗 Source