This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
ecs:register [2010/06/20 16:56] serialkicked created |
ecs:register [2014/04/26 13:25] (current) |
||
|---|---|---|---|
| Line 19: | Line 19: | ||
| the script will return [TRUE] if the plugin is registered correctly. | the script will return [TRUE] if the plugin is registered correctly. | ||
| - | ====== Example ====== | + | ===== Example ===== |
| I will use Pirate Guild as an example here: | I will use Pirate Guild as an example here: | ||
| Line 37: | Line 37: | ||
| Done! Your plugin is registered to ECS ! And it was the hardest part. | Done! Your plugin is registered to ECS ! And it was the hardest part. | ||
| + | |||
| + | |||
| + | ====== Removing your script from ECS ====== | ||
| + | |||
| + | When your script or plugin is uninstalled it has to unsubscribe from the ECS library using **plugin.sk.ecs.unregister**. | ||
| + | |||
| + | It needs only one parameter: | ||
| + | * plugin.id : The global variable you used to register (string) | ||
| + | |||
| + | It will remove your script from ECS. The news system will be cleared and the hot-key disabled for this script. | ||
| + | |||
| + | ===== Example ===== | ||
| + | <code> | ||
| + | $result = call script 'plugin.sk.ecs.unregister' plugin.id = 'anarkis.pirate.plugin' | ||
| + | </code> | ||