to_wound: How many hits wound the target?

In psmits/mathhammr: Tools for Dice Roll Simulations in Warhammer40k 8th

Description

After a successful hit, the attacked determines how many wounds are dealt.

Usage

to_wound(n, str, tgh, reroll = NULL, explode = NULL, expand = NULL,
  trigger = NULL)

Arguments

n	integer scalar number of hits.
str	integer scalar strength of the attack.
tgh	integer scalar toughness of the target.
reroll	integer scalar what MAXIMUM result rerolls (default NULL).
explode	integer scalar what MINIMUM result explodes (default NULL).
expand	named list of arguments for expand_dice (default NULL).
trigger	integer vector length >= 1 which values trigger special effects (default NULL).

Value

integer scalar number of successful hits UNLESS !is.null(trigger) then named list with number of successes (success) and triggers (trigger).

Examples

# hit a SM tactical with a boltgun -- how many wounds?
to_wound(n = 1, str = 4, tgh = 4)

# hit a SM tactical with a boltgun within 6" of a SM Lt -- how many wounds?
to_wound(n = 1, str = 4, tgh = 4, reroll = 1)

psmits/mathhammr documentation built on May 14, 2019, 5:16 a.m.