eweapon

Inherits: sprite

Weapons active on the screen from enemies.

Load with Screen->EWeapons[], Screen->LoadEWeapon(), or Screen->CreateEWeapon().

Variables

int	Type
int	Level
int	Max
int	Angle
int	Step
int	NumFrames
int	Frame
int	Power
bool	Angular
bool	Behind
int	ASpeed
int	FlashCSet
int	DeadState
bool	Flash
int	OriginalTile
int	OriginalCSet
const int	TotalDYOffset
npc	Parent
bool	CollDetection
int	Script
untyped[]	InitD
int	Unblockable
int	Timeout
int	BounceMult
int	BounceAdd
bool	DisableTriggers
int	PierceCount
int	DegAngle
int	Vx
int	Vy
bool	AutoRotate
bool[]	Flags
int	DeathItem
int	DeathDropset
int	DeathItemPFlags
int	DeathSprite
int	DeathSFX
int	LiftLevel
int	LiftTime
int	LiftHeight
int[]	Sprites
int[]	BurnLightRadius
int[]	BurnLightOffset
const int	UID deprecated
int	ParentUID deprecated
int	ID deprecated
int	Family deprecated

Functions

void	Max(int value) deprecated
bool	isValid()
void	UseSprite(int sprite_id)
void	Explode(int mode)
void	Remove()
bool	Switch(int effect)
void	MakeAngular()
void	MakeDirectional()

Enumerations

enum EWeaponType: 🔗 Source

EWeapon types. Used with Screen->CreateEWeapon() and Screen->LoadEWeapon().

EWeaponType EW_ARROW = 130

EWeaponType EW_BRANG = 131

EWeaponType EW_BEAM = 132

Sword beam.

EWeaponType EW_ROCK = 133

EWeaponType EW_MAGIC = 134

EWeaponType EW_FIREBALL = 129

EWeaponType EW_FIREBALL2 = 145

Arcing boss fireball.

EWeaponType EW_BOMB = 137

Projectile bomb.

EWeaponType EW_BOMBBLAST = 135

Bomb explosion.

EWeaponType EW_SBOMB = 138

Projectile super bomb.

EWeaponType EW_SBOMBBLAST = 136

Super bomb explosion.

EWeaponType EW_FIRETRAIL = 139

EWeaponType EW_FIRE = 140

EWeaponType EW_WIND = 141

Wind wizzrobe magic.

EWeaponType EW_FIRE2 = 142

EWeaponType EW_SCRIPT1 = 31

Dummy weapon, for use with scripts.

EWeaponType EW_SCRIPT2 = 32

EWeaponType EW_SCRIPT3 = 33

EWeaponType EW_SCRIPT4 = 34

EWeaponType EW_SCRIPT5 = 35

EWeaponType EW_SCRIPT6 = 36

EWeaponType EW_SCRIPT7 = 37

EWeaponType EW_SCRIPT8 = 38

EWeaponType EW_SCRIPT9 = 39

EWeaponType EW_SCRIPT10 = 40

---

Variable descriptions

int Type 🔗 Source

value EWeaponType (EW_)

The weapon type. Some types have hardcoded behaviors.

---

int Level 🔗 Source

For lweapons, the level of the weapon.

---

int Max 🔗 Source

deprecated_getter Max

Returns the max number of weapons currently allowed.

---

int Angle 🔗 Source

The angle of the weapon, in radians for Angle or degrees for DegAngle. Has no real effect if the weapon is not Angular.

---

int Step 🔗 Source

The movement speed of the weapon, in 100th’s/pixel per frame.

---

int NumFrames 🔗 Source

The number of frames in the weapon’s animation.

---

int Frame 🔗 Source

The current frame number that the animation is on.

---

int Power 🔗 Source

alias Damage

The amount of damage the weapon deals.

---

bool Angular 🔗 Source

If the weapon is angular (instead of directional)

---

bool Behind 🔗 Source

If true, the weapon’s sprite will draw behind the Hero and enemies.

---

int ASpeed 🔗 Source

The speed of the animation, in frames per frame.

---

int FlashCSet 🔗 Source

The secondary CSet used for flashing.

---

int DeadState 🔗 Source

value WeaponDeadState (WDS_)

---

bool Flash 🔗 Source

If the weapon is flashing or not. When flashing, it changes between its CSet and FlashCSet.

---

int OriginalTile 🔗 Source

The starting tile of the weapon’s animation.

---

int OriginalCSet 🔗 Source

The starting cset of the weapon.

---

const int TotalDYOffset 🔗 Source

the weapon’s total visual Y-offset.

---

npc Parent 🔗 Source

The ID of the item, or pointer of the npc (respectively for lweapon, and for eweapon) that created this weapon.

Weapons created by script have a default Parent of -1 (lweapon) and <npc>-0.0001 (eweapon).

For lweapons, this value determines what item editor index to read item flags from.

Setting it to an item of a class that does not normally generate the given weapon

type may have unexpected effects.

---

bool CollDetection 🔗 Source

If the weapon’s collision is enabled. Set to false to disable collision entirely.

---

int Script 🔗 Source

The weapon script running on this weapon.

---

untyped[] InitD 🔗 Source

The 8 InitD[] arguments for the weapon script.

---

int Unblockable 🔗 Source

value UnblockableBitflags (UNBLOCK_)

Unblockable bitflags.

---

int Timeout 🔗 Source

If > 0, ticks down each frame. When ticking down to 0, kills the weapon.

---

int BounceMult 🔗 Source

Added in version 3.0.

When the weapon lands from the air, it bounces based on this multiplier of it’s downward velocity, and BounceAdd. Must be >= 0.

---

int BounceAdd 🔗 Source

Added in version 3.0.

When the weapon lands from the air, it bounces based on BounceMult, adding this value in px/frame after the multiplier. Using a negative value will dampen the bounce, and is recommended to prevent the weapon from bouncing many tiny rapid bounces as it’s velocity gets small.

---

bool DisableTriggers 🔗 Source

Added in version 3.0.

Set to true, this prevents the weapon from triggering any Combo Triggers. Also affects some melee weapon checks (ex. slash/pound combos).

This being false means that scripts are not CAUSING it to ignore triggers- it does not account for other things that may disable the weapon from activating triggers (ex. the Hammer being above the player’s head).

---

int PierceCount 🔗 Source

Added in version 3.0.

If < 0, the weapon behaves as normal. If == 0, the weapon pierces infinitely. If > 0, each time the weapon hits an enemy or the player, counts down by 1. When counting down from ‘1’ to ‘0’, the weapon dies. Some weapons have special behavior; ex. bomb blasts do not die, but will have their collision disabled so they cannot hit further targets- and the PierceCount set on a lit bomb will apply to the bomb’s blast.

---

int DegAngle 🔗 Source

The angle of the weapon, in radians for Angle or degrees for DegAngle. Has no real effect if the weapon is not Angular.

---

int Vx 🔗 Source

The velocity on the X or Y axis. Setting these will make the weapon Angular if it isn’t already, and will adjust the weapon’s Angle and Step speed.

---

int Vy 🔗 Source

The velocity on the X or Y axis. Setting these will make the weapon Angular if it isn’t already, and will adjust the weapon’s Angle and Step speed.

---

bool AutoRotate 🔗 Source

If true, the weapon’s ‘Rotation’ will be automatically set based on its Angle.

---

bool[] Flags 🔗 Source

index WeaponFlag (WFLAG_)

The weapon’s flags.

---

int DeathItem 🔗 Source

If > -1, this item will be spawned when the weapon dies.

---

int DeathDropset 🔗 Source

If > -1, this item dropset will be rolled for a drop when the weapon dies.

---

int DeathItemPFlags 🔗 Source

The itemsprite::Pickup to use for the item dropped via DeathItem or DeathDropset.

---

int DeathSprite 🔗 Source

If > -1, display this Sprite Data sprite when the weapon dies.

---

int DeathSFX 🔗 Source

If > 0, this SFX will be played when the weapon dies.

---

int LiftLevel 🔗 Source

NOTE: Not implemented - currently only lweapon can be lifted.

---

int LiftTime 🔗 Source

The time it takes to lift this weapon via engine lifting.

---

int LiftHeight 🔗 Source

The height to lift this weapon to via engine lifting.

---

int[] Sprites 🔗 Source

Various sprites used by the weapon.

---

int[] BurnLightRadius 🔗 Source

index WeaponSpriteIndex (WPN_SPRITE_)

The burning light radii associated with sprites of the weapon.

---

int[] BurnLightOffset 🔗 Source

index WeaponSpriteIndex (WPN_SPRITE_)

Added in version 3.0.

The burning light offsets associated with sprites of the weapon.

---

const int UID 🔗 Source

Deprecated:

• This is now just the internal engine ID, which is the same as doing <int>some_sprite.

---

int ParentUID 🔗 Source

Deprecated.

---

int ID 🔗 Source

value EWeaponType (EW_)

Deprecated: Exactly the same as Type, use that instead.

---

int Family 🔗 Source

value EWeaponType (EW_)

Deprecated: Exactly the same as Type, use that instead.

---

Function descriptions

void Max(int value) 🔗 Source

Sets the max number of weapons allowed to a new value. Range 1-1024.

Deprecated: Use Max instead!

---

bool isValid() 🔗 Source

Returns true if this pointer points to a valid weapon. If this returns false, using any other value of this pointer will error.

---

void UseSprite(int sprite_id) 🔗 Source

Loads the graphical information from the spritedata indicated by sprite_id to the weapon.

---

void Explode(int mode) 🔗 Source

Creates an explosion particle effect in mode 0, 1, or 2 of the sprite.

---

void Remove() 🔗 Source

Instantly deletes the weapon.

---

bool Switch(int effect) 🔗 Source

Switch the Hero with this sprite.

Valid values for effect: SwitchEffect (SW_EFF_) (SW_EFF_).

---

void MakeAngular() 🔗 Source

If the weapon is not Angular, makes it Angular, and sets its Angle based on its Dir.

---

void MakeDirectional() 🔗 Source

If the weapon is Angular, makes it not Angular, and set its Dir based on its Angle