Crossfire Server, Trunk  R20608
ob_methods Struct Reference

#include <ob_methods.h>

+ Collaboration diagram for ob_methods:

Data Fields

apply_func apply
 
describe_func describe
 
struct ob_methodsfallback
 
move_on_func move_on
 
process_func process
 
trigger_func trigger
 

Detailed Description

Typedefs for ob_methods. Also used in ob_types.c for storing the pointers temporarily. As a convention, callbacks parameters should begin with "ob_methods *context, object *ob", and return method_ret unless it needs to return something else.

This struct stores function pointers for actions that can be done to objects. It is currently just used for type-specific object code. Add new function pointers here when moving type specific code into the server/types/ *.c area. When adding function pointers here, be sure to add to init_ob_methods() in ob_types.c as necessary.

Definition at line 45 of file ob_methods.h.

Field Documentation

apply_func ob_methods::apply

The apply method

Definition at line 46 of file ob_methods.h.

Referenced by init_ob_method_struct(), init_ob_methods(), ob_apply(), and register_apply().

describe_func ob_methods::describe

The describe method

Definition at line 48 of file ob_methods.h.

Referenced by init_ob_method_struct(), init_ob_methods(), ob_describe(), and register_describe().

struct ob_methods* ob_methods::fallback

ob_method structure to fallback to

Definition at line 51 of file ob_methods.h.

Referenced by init_ob_method_struct(), ob_apply(), ob_describe(), ob_move_on(), ob_process(), and ob_trigger().

move_on_func ob_methods::move_on

The move_on method

Definition at line 49 of file ob_methods.h.

Referenced by init_ob_method_struct(), init_ob_methods(), ob_move_on(), and register_move_on().

process_func ob_methods::process

The process method

Definition at line 47 of file ob_methods.h.

Referenced by init_ob_method_struct(), init_ob_methods(), ob_process(), and register_process().

trigger_func ob_methods::trigger

When something is triggered via a button.

Definition at line 50 of file ob_methods.h.

Referenced by init_ob_method_struct(), ob_trigger(), and register_trigger().


The documentation for this struct was generated from the following file: