Functions

Traps

Various functions that turn regular items into trap markers. More...


Detailed Description

Various functions that turn regular items into trap markers.

Consult traps.fos for the list of item Val parameters. Include traps_h.fos for usage.

Functions

void MakeMine (Item& mine, uint explodeOwner, uint complexity, uint hideSkill, uint bonusDamage, uint bonusRadius)
 Sets the spear trap script for the item and assigns its parameters.
void MakeSpearTrap (Item& trap, uint complexity, uint hideSkill, uint spearcount)
 Sets the spear trap script for the item and assigns its parameters.
void _SpearTrap (Item& item, bool firstTime)
void _SpearTrapWalk (Item& trap, Critter& cr, bool entered, uint8 dir)
void ShootSpear (Item& trap, Critter& cr)
void MakeGenericShotTrap (Item& trap, uint complexity, uint hideSkill, uint16 pid, uint dmgmin, uint dmgmax)
 Sets the generic shot trap script for the item and assigns its parameters.
void _GenericShot (Item& item, bool firstTime)
void _GenericShotWalk (Item& trap, Critter& cr, bool entered, uint8 dir)
void ShootGeneric (Item& trap, Critter& cr)
bool _TrapUse (Item& trap, Critter& cr, int skill)
void MakeBearTrap (Item& trap, uint complexity, uint hideSkill, uint bonusDamage)
 Sets the bear trap script for the item and assigns its parameters.
void _BearTrapInit (Item& item, bool firstTime)
void _BearTrapWalk (Item& item, Critter& cr, bool entered, uint8 dir)
uint e_Clamp (array< uint >@ values)
void MakeAlarmTrap (Item& trap, uint complexity, uint hideSkill, uint16 pid, uint8 min, uint8 max, uint16 bag, uint8 level, uint8 entire)
 Sets the alarm (critter summoning) trap script for the item and assigns its parameters.
void _AlarmTrapInit (Item& item, bool firstTime)
void _AlarmTrapWalk (Item& item, Critter& cr, bool entered, uint8 dir)
uint e_SummonEnemies (array< uint >@ values)
void ClearWalkTrap (Item& item)
 Clears the script of walk-in type trap, such as mines or bear traps.

Function Documentation

void MakeMine ( Item mine,
uint  explodeOwner,
uint  complexity,
uint  hideSkill,
uint  bonusDamage,
uint  bonusRadius 
)

Sets the spear trap script for the item and assigns its parameters.

NOTE: import this function from explode module.

Parameters:
mine The item to become a spear trap
explodeOwner Id of the critter responsible for setting the trap up
complexity Trap complexity
hideSkill The value of traps skill used to hide the item, 0 to disable
bonusDamage Bonus radius of the explosion
bonusDamage Bonus damage dealt upon the trap activation
void MakeSpearTrap ( Item trap,
uint  complexity,
uint  hideSkill,
uint  spearcount 
)

Sets the spear trap script for the item and assigns its parameters.

Parameters:
trap The item to become a spear trap
complexity Complexity level for disarming the trap
hideSkill Value of traps skill used to hide the item, 0 to disable
spearcount Number of spear ammunition
void _SpearTrap ( Item item,
bool  firstTime 
)
void _SpearTrapWalk ( Item trap,
Critter cr,
bool  entered,
uint8  dir 
)
void ShootSpear ( Item trap,
Critter cr 
)
void MakeGenericShotTrap ( Item trap,
uint  complexity,
uint  hideSkill,
uint16  pid,
uint  dmgmin,
uint  dmgmax 
)

Sets the generic shot trap script for the item and assigns its parameters.

Parameters:
trap The item to become a generic shot trap
complexity Complexity level for disarming the trap
hideSkill Value of traps skill used to hide the item, 0 to disable
pid Proto id for object to be shot
dmgmin Minimum amount of damage dealt
dmgmax Maximum amount of damage dealt
void _GenericShot ( Item item,
bool  firstTime 
)
void _GenericShotWalk ( Item trap,
Critter cr,
bool  entered,
uint8  dir 
)
void ShootGeneric ( Item trap,
Critter cr 
)
bool _TrapUse ( Item trap,
Critter cr,
int  skill 
)
void MakeBearTrap ( Item trap,
uint  complexity,
uint  hideSkill,
uint  bonusDamage 
)

Sets the bear trap script for the item and assigns its parameters.

Parameters:
trap The item to become a bear trap
complexity Complexity level for disarming the trap
hideSkill Value of traps skill used to hide the item, 0 to disable
bonusDamage Bonus damage dealt upon the trap activation
void _BearTrapInit ( Item item,
bool  firstTime 
)
void _BearTrapWalk ( Item item,
Critter cr,
bool  entered,
uint8  dir 
)
uint e_Clamp ( array< uint >@  values  ) 
void MakeAlarmTrap ( Item trap,
uint  complexity,
uint  hideSkill,
uint16  pid,
uint8  min,
uint8  max,
uint16  bag,
uint8  level,
uint8  entire 
)

Sets the alarm (critter summoning) trap script for the item and assigns its parameters.

Parameters:
trap The item to become an alarm trap
complexity Complexity level for disarming the trap
hideSkill Value of traps skill used to hide the item, 0 to disable
pid Proto id for critters spawned on trap activation
min Minimum number of critters to spawn
max Maximum number of critters to spawn
bag Bag used by the spawned critter
level Level of the spawned critters
entire Entire number around which the critters will be spawned
void _AlarmTrapInit ( Item item,
bool  firstTime 
)
void _AlarmTrapWalk ( Item item,
Critter cr,
bool  entered,
uint8  dir 
)
uint e_SummonEnemies ( array< uint >@  values  ) 
void ClearWalkTrap ( Item item  ) 

Clears the script of walk-in type trap, such as mines or bear traps.

Parameters:
item The item to be cleared