EntityPreHook 'bump_weapon'

[BackRaw]

No matter what I return (True or False), the player won't pick up the bumped weapon

Syntax: Select all

from memory.hooks import EntityPreHook 

@EntityPreHook('player', 'bump_weapon')
def pre_bump_weapon(args):
    """Gets called when a player walks onto a weapon."""
    # Get the entity's Entity instance
    player = Player(index_from_pointer(args[0]))

    # do something with the player

    return True  # or False - same result

[satoon101]

You don't return anything (or return None) if you don't want to block the function.

Also, just so you know, in the next release, EntityPreHook and EntityPostHook will be in entities.hooks.

[BackRaw]

You don't return anything (or return None) if you don't want to block the function.

Also, just so you know, in the next release, EntityPreHook and EntityPostHook will be in entities.hooks.

Aaaaaaahhh, that makes sense now.

[Doldol]

Why not abstract it like with CommandReturn.BLOCK, etc?

I think that would make it more obvious to people.

[satoon101]

http://forums.sourcepython.com/showthread.php?754&p=4971&viewfull=1#post4971

[Doldol]

http://forums.sourcepython.com/showthread.php?754&p=4971&viewfull=1#post4971

Is the same philosophy then not also applicable to CommandReturn?

[satoon101]

Well, the two are quite different. With commands you either want to block or continue. In fact, the only way to block is to return a False value. None or True type (or, since None, not returning anything) values will result in the command continuing.

With hooked functions, any type of value can be returned. The return value is more specific than simply continue or block. So, only returning None (or returning no value at all) is the only way to "continue". That being said, we "could" have a value for continuing that is "is" None, but there is no possible way to have a HookAction.BLOCK, as that value could be anything. That is, unless we required 2 return values, but what would be the point in that. I think proper documentation will help make this clear to everyone what is expected within a hooked function.

[L'In20Cible]

Well, I think the block/continue concept doesn't apply for hooked functionsfunctions. In fact, you simply override the returned value or not.