two_handed

Two Handed Component

When applied to an item it will make it two handed Only one of the component can exist on an item.

Vars
attacksound	Boolean whether to play sound on attack, if wielded
force_multiplier	The multiplier applied to force when wielded, does not work with force_wielded, and force_unwielded
force_unwielded	The force of the item when unweilded
force_wielded	The force of the item when weilded
icon_wielded	The icon that will be used when wielded
offhand_item	Reference to the offhand created for the item
require_twohands	Boolean on whether it has to be held in both hands
sharpened_increase	The amount of increase recived from sharpening the item
unwield_callback	A callback on the parent to be called when the item is unwielded
unwieldsound	Boolean whether to play sound when unwielded
wield_callback	A callback on the parent to be called when the item is wielded
wielded	Are we holding the two handed item properly
wieldsound	Boolean whether to play sound when wielded
Procs
Initialize	Two Handed component
on_attack	on_attack triggers on attack with the parent item
on_attack_self	Triggered on attack self of the item containing the component
on_destroy	Triggered on destroy of the component's offhand
on_drop	Triggered on drop of item containing the component
on_equip	Triggered on equip of the item containing the component
on_moved	on_moved Triggers on item moved
on_sharpen	on_sharpen Triggers on usage of a sharpening stone on the item
on_swapping_hands	on_swap_hands Triggers on swapping hands, blocks swap if the other hand is busy
on_update_icon	on_update_icon triggers on call to update parent items icon
unwield	Unwield the two handed item
wield	Wield the two handed item in both hands

Var Details

var
attacksound
–

Boolean whether to play sound on attack, if wielded

var
force_multiplier
–

The multiplier applied to force when wielded, does not work with force_wielded, and force_unwielded

var
force_unwielded
–

The force of the item when unweilded

var
force_wielded
–

The force of the item when weilded

var
icon_wielded
–

The icon that will be used when wielded

var
offhand_item
– /obj/item/offhand

Reference to the offhand created for the item

var
require_twohands
–

Boolean on whether it has to be held in both hands

var
sharpened_increase
–

The amount of increase recived from sharpening the item

var
unwield_callback
– /datum/callback

A callback on the parent to be called when the item is unwielded

var
unwieldsound
–

Boolean whether to play sound when unwielded

var
wield_callback
– /datum/callback

A callback on the parent to be called when the item is wielded

var
wielded
–

Are we holding the two handed item properly

var
wieldsound
–

Boolean whether to play sound when wielded

Proc Details

↑
Initialize
(require_twohands, wieldsound, unwieldsound, attacksound, force_multiplier, force_wielded, force_unwielded, icon_wielded, /datum/callback/wield_callback, /datum/callback/unwield_callback)

Two Handed component

vars:

require_twohands (optional) Does the item need both hands to be carried
wieldsound (optional) The sound to play when wielded
unwieldsound (optional) The sound to play when unwielded
attacksound (optional) The sound to play when wielded and attacking
force_multiplier (optional) The force multiplier when wielded, do not use with force_wielded, and force_unwielded
force_wielded (optional) The force setting when the item is wielded, do not use with force_multiplier
force_unwielded (optional) The force setting when the item is unwielded, do not use with force_multiplier
icon_wielded (optional) The icon to be used when wielded

proc
on_attack
(/obj/item/source, /mob/living/target, /mob/living/user)

on_attack triggers on attack with the parent item

proc
on_attack_self
(/datum/source, /mob/user)

Triggered on attack self of the item containing the component

proc
on_destroy
(/datum/source)

Triggered on destroy of the component's offhand

proc
on_drop
(/datum/source, /mob/user)

Triggered on drop of item containing the component

proc
on_equip
(/datum/source, /mob/user, slot)

Triggered on equip of the item containing the component

proc
on_moved
(/datum/source, /mob/user, dir)

on_moved Triggers on item moved

proc
on_sharpen
(/obj/item/item, amount, max_amount)

on_sharpen Triggers on usage of a sharpening stone on the item

proc
on_swapping_hands
(/mob/user, /obj/item/held_item)

on_swap_hands Triggers on swapping hands, blocks swap if the other hand is busy

proc
on_update_icon
(/obj/item/source)

on_update_icon triggers on call to update parent items icon

Updates the icon using icon_wielded if set

proc
unwield
(/mob/living/carbon/user, show_message, can_drop)

Unwield the two handed item

vars:

user The mob/living/carbon that is unwielding the item
show_message (option) show a message to chat on unwield
can_drop (option) whether 'dropItemToGround' can be called or not.

proc
wield
(/mob/living/carbon/user)

Wield the two handed item in both hands

vars:

user The mob/living/carbon that is wielding the item

two_handed /datum/component/two_handed

Vars

Procs

Var Details

var attacksound –

var force_multiplier –

var force_unwielded –

var force_wielded –

var icon_wielded –

var offhand_item – /obj/item/offhand

var require_twohands –

var sharpened_increase –

var unwield_callback – /datum/callback

var unwieldsound –

var wield_callback – /datum/callback

var wielded –

var wieldsound –

Proc Details

↑Initialize(require_twohands, wieldsound, unwieldsound, attacksound, force_multiplier, force_wielded, force_unwielded, icon_wielded, /datum/callback/wield_callback, /datum/callback/unwield_callback)

proc on_attack(/obj/item/source, /mob/living/target, /mob/living/user)

proc on_attack_self(/datum/source, /mob/user)

proc on_destroy(/datum/source)

proc on_drop(/datum/source, /mob/user)

proc on_equip(/datum/source, /mob/user, slot)

proc on_moved(/datum/source, /mob/user, dir)

proc on_sharpen(/obj/item/item, amount, max_amount)

proc on_swapping_hands(/mob/user, /obj/item/held_item)

proc on_update_icon(/obj/item/source)

proc unwield(/mob/living/carbon/user, show_message, can_drop)

proc wield(/mob/living/carbon/user)

two_handed
/datum/component/two_handed

var
attacksound
–

var
force_multiplier
–

var
force_unwielded
–

var
force_wielded
–

var
icon_wielded
–

var
offhand_item
– /obj/item/offhand

var
require_twohands
–

var
sharpened_increase
–

var
unwield_callback
– /datum/callback

var
unwieldsound
–

var
wield_callback
– /datum/callback

var
wielded
–

var
wieldsound
–

↑
Initialize
(require_twohands, wieldsound, unwieldsound, attacksound, force_multiplier, force_wielded, force_unwielded, icon_wielded, /datum/callback/wield_callback, /datum/callback/unwield_callback)

proc
on_attack
(/obj/item/source, /mob/living/target, /mob/living/user)

proc
on_attack_self
(/datum/source, /mob/user)

proc
on_destroy
(/datum/source)

proc
on_drop
(/datum/source, /mob/user)

proc
on_equip
(/datum/source, /mob/user, slot)

proc
on_moved
(/datum/source, /mob/user, dir)

proc
on_sharpen
(/obj/item/item, amount, max_amount)

proc
on_swapping_hands
(/mob/user, /obj/item/held_item)

proc
on_update_icon
(/obj/item/source)

proc
unwield
(/mob/living/carbon/user, show_message, can_drop)

proc
wield
(/mob/living/carbon/user)