server_plugin
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
| server_plugin [2013/07/23 14:33] – external edit 127.0.0.1 | server_plugin [2025/04/18 12:51] (current) – external edit 127.0.0.1 | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== | + | ====== |
| - | Plugins enhance the game with optional features. | + | ===== General information ===== |
| + | |||
| + | Plugins enhance the Crossfire | ||
| They allow for special behaviours that can't be done through simple mapping, or require complex scripting actions - the only thing limiting is the imagination of the coder! | They allow for special behaviours that can't be done through simple mapping, or require complex scripting actions - the only thing limiting is the imagination of the coder! | ||
| Current examples include: | Current examples include: | ||
| - | * message boards, on which players can leave messages | + | * Message Boards, on which players can leave messages |
| * Imperial Post Office, that lets players exchange ingame mail | * Imperial Post Office, that lets players exchange ingame mail | ||
| - | * playing slot machines | + | * Playing Slot Machines |
| - | * [[: | + | * [[: |
| Line 17: | Line 19: | ||
| Currently existing plugins are : | Currently existing plugins are : | ||
| ^ Name ^ Description ^ Status ^ Title for the event object ^ | ^ Name ^ Description ^ Status ^ Title for the event object ^ | ||
| - | | [[cfanim]] | animate objects | experimental | Animator | | + | | [[: |
| - | | [[cfpython]] | run Python scripts | working | Python | | + | | [[:cfpython:]] | run Python scripts | working | Python | |
| - | | [[cflogger]] | logs events to a SQLITE database | experimental | SqliteLogger | | + | | [[: |
| - | | [[cfnewspaper]] | newspaper generation | experimental | Newspaper | | + | | [[: |
| - | | [[citylife]] | adds/ | + | | [[: |
| - | | [[cfrhg]] | random house generator, adds random maps to unlinked exits in specified maps | apparently stable | cfrhg | | + | | [[: |
| - | | < | + | | < |
| | template | not a real plugin, but a skeleton to create new ones | up-to-date | | | | template | not a real plugin, but a skeleton to create new ones | up-to-date | | | ||
| Line 79: | Line 81: | ||
| * bound to an arrow, it is triggered when the arrow hits something. " | * bound to an arrow, it is triggered when the arrow hits something. " | ||
| + | ==== Bought ==== | ||
| + | Archetype: event_bought | ||
| + | |||
| + | This event is triggered when the associated object was paid by a player, but not yet marked as paid. | ||
| + | |||
| + | " | ||
| + | |||
| + | Returning a non-zero value leaves the item as unpaid and prevents the player from buying still unpaid items. | ||
| ==== Close ==== | ==== Close ==== | ||
| Archetype: event_close | Archetype: event_close | ||
| Line 89: | Line 99: | ||
| Generated when the object dies. | Generated when the object dies. | ||
| + | ==== Destroy ==== | ||
| + | Archetype: event_destroy | ||
| + | |||
| + | Used when the object is totally destroyed, either by a map reset or destruction by another item. | ||
| + | |||
| + | " | ||
| + | |||
| + | The return value is ignored. | ||
| ==== Drop ==== | ==== Drop ==== | ||
| Archetype: event_drop | Archetype: event_drop | ||
| Line 150: | Line 168: | ||
| Generated when the timer connected triggered. | Generated when the timer connected triggered. | ||
| + | ==== User ==== | ||
| + | Archetype: event_user | ||
| + | |||
| + | Only triggered through a plugin call. This event can represent anything. | ||
| + | " | ||
| ===== Hooking to global events ===== | ===== Hooking to global events ===== | ||
| Line 161: | Line 184: | ||
| | Clock | Generated at each game loop. | (none) | When no player is logged, the loop " | | Clock | Generated at each game loop. | (none) | When no player is logged, the loop " | ||
| | Crash | Generated when a server crash does occur. It is not a recursive event, so if a crash occur from *inside* the crash event handling, it is not called a second time, preventing infinite loops to occur. | (none) | This event is not implemented for now. | | | Crash | Generated when a server crash does occur. It is not a recursive event, so if a crash occur from *inside* the crash event handling, it is not called a second time, preventing infinite loops to occur. | (none) | This event is not implemented for now. | | ||
| - | | Gdeath | + | | PLAYER_DEATH |
| | Gkill | Generated whenever something/ | | Gkill | Generated whenever something/ | ||
| | Kick | Generated when a player was kicked by a DM. | '' | | Kick | Generated when a player was kicked by a DM. | '' | ||
| Line 172: | Line 195: | ||
| | Mapunload | Generated when a map is being unloaded from memory. | '' | | Mapunload | Generated when a map is being unloaded from memory. | '' | ||
| | Muzzle | Generated when a player was muzzled by a DM. | '' | | Muzzle | Generated when a player was muzzled by a DM. | '' | ||
| + | | Playerdeath | Generated whenever a player dies. | '' | ||
| | Remove | Generated when a player character is removed from the game (" | | Remove | Generated when a player character is removed from the game (" | ||
| | Shout | Generated whenever someone shouts something. | '' | | Shout | Generated whenever someone shouts something. | '' | ||
server_plugin.1374607989.txt.gz · Last modified: (external edit)