addRequiredBodyPart ( self,  bodyPart )

Sets the list of body parts required by this item to be properly wielded. Each element in the list should be a constant from the constants module. An interactive will not be able wield this item if the required body parts are not available or are in use.

arguments:

bodyPart

(string) the bodypart that is used to wield this wieldable (see mudlib.constants for constants)

canLeaveEnvironment ( self,  environment )

Figures out if the player can unwield the item.

see mudlib.core.Object

cannotUnwield ( self,  interactive )

This method is invoked when an interactive expresses a desire to unwield this item. It should return true if the interactive can unwield it, false otherwise. Note that this method need not worry about standard checks. Any checks in this method should be above and beyond the normal ones.

arguments:

interactive

(mudlib.living.Interactive) the interactive trying to unwield this wieldable

returns:

a failure string (true) if it cannot be unwielded or 0 (false)

cannotWield ( self,  interactive )

This method is invoked when an interactive expresses a desire to wield this item. It should return true if the interactive can wield it, false otherwise. Note that this method need not worry about standard checks, such as whether the required body parts are available. Any checks in this method should be above and beyond the normal ones.

arguments:

interactive

(mudlib.living.Interactive) the interactive trying to wield this wieldable.

returns:

a failure string (true) if it cannot be wielded or 0 (false)

createWieldable ( self )

The "constructor" for wieldable objects. You should override this method and include any required initialization, if necessary. You should NOT override __init__ or createObject.

enterEnvironment ( self,  newEnvironment )

Binds wield and unwield commands to the player.

getRequiredBodyParts ( self )

Returns a list of body parts required to wield this item. Each body part is a constant from the constants module.

leaveEnvironment ( self,  oldEnvironment )

Unbinds wield and unwield commands from the player.

unwield ( self )

This method is invoked when this item is actually unwielded by an interactive. If you want to do any special handling, you should override this method.

unwieldAction (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the unwield <wieldable> command.

wield ( self )

This method is invoked when this item is actually wielded by an interactive. If you want to do any special handling, you should override this method.

wieldAction (
        self,
        actionString,
        arguments,
        rawinput,
        )

Implements the wield <wieldable> command.