plugin_room_interface Struct Reference

interface common to any room plugin. More...

#include <plugin.h>

Collaboration diagram for plugin_room_interface:

[legend]

Data Fields
const char *(*	attr_get )(struct room *r, const char *name)
	get an attribute on a room.
int(*	attr_set )(struct room *r, const char *name, const char *value)
	set an attribute on a room.
struct room *(*	get )(unsigned room_id)
	find a room by id and return it.
void(*	put )(struct room *r)
	reduce reference count on a room
int(*	save )(struct room *r)
	save a room to disk (only if it is dirty).

---

Detailed Description

interface common to any room plugin.

Definition at line 56 of file plugin.h.

---

Field Documentation

const char*(* plugin_room_interface::attr_get)(struct room *r, const char *name)

get an attribute on a room.

value is temporary and may disappear if the room is flushed, changed or attr_get() is called again.

int(* plugin_room_interface::attr_set)(struct room *r, const char *name, const char *value)

set an attribute on a room.

struct room*(* plugin_room_interface::get)(unsigned room_id) [read]

find a room by id and return it.

increases reference count on a room.

void(* plugin_room_interface::put)(struct room *r)

reduce reference count on a room

int(* plugin_room_interface::save)(struct room *r)

save a room to disk (only if it is dirty).

---

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

• plugin.h