wyvern.lib
Interface MethodHookCallback

All Known Implementing Classes:

GiantShrink, GuildSkills, MonsterImpl, MovableSoundSource, NagaShift, PigLatin, RakshasaSkills, Shop, StaticBlade, SuspendableTimer, Vehicle

public interface MethodHookCallback

Used to notify objects registered on a "method hook". There are two basic classifications for hooks in the game:

• Event hooks, which are run automatically by the game engine for every event. Event hooks include "pre" and "post" event hooks, which happen before and after the event, respectively. Objects registering for event hooks use the HookCallback interface.

• Method hooks. Sometimes it's desirable to be notified when a particular method is called on an object. Java doesn't provide a direct mechanism for this, as do some other languages. The object in question must provide its own hook for its method. The naming convention is "methodNameHook", where methodName is the name of the method providing the hook.

  The callback object is notified of the method that was called (it's actually passed the name of the hook), and the object instance that was called. It's possible for objects to set up more than one hook for a given method; consult the documentation for the object in question to read about the names and semantics for such hooks.

  This interface provides the callback method for being notified of a method hook.

  Version:

  1.0, Jun 05, 1998

  Author:

  Steve Yegge

  Method Summary

  void	methodCalled(java.lang.String hookName, MethodHookable target, java.lang.Object data) Notifies the callback that a given method was called on the target object.

  Method Detail

  methodCalled

  public void methodCalled(java.lang.String hookName,
                           MethodHookable target,
                           java.lang.Object data)

  Notifies the callback that a given method was called on the target object. The name of the hook is sometimes the same as the name of the method, but it can be different, so it's best to check the documentation for the method in question.

  Don't forget to call the superclass version of the method in your implementation.

  Parameters:

  hookName - the name of the hook being run

  target - the object on which the method was invoked: a GameMap or GameObject.

  data - a method-specific data object; can be null. Check the documentation for the method hook to see if any data is passed to the callbacks.