Writing Modules for Hyperspace - Revision history

Animate Dreams: /* Getting Started */

2008-02-22T17:41:22Z

‎Getting Started

Cyan~Fire: changing Category:Tutorial to Category:Guides...

2005-05-09T14:32:05Z

changing Category:Tutorial to Category:Guides...

Akai: link

2005-03-12T09:53:38Z

link

Dr Brain: Had the link backwards

2005-01-18T13:59:23Z

Had the link backwards

Dr Brain: Added stub files and rearranged the files

2005-01-18T13:58:59Z

Added stub files and rearranged the files

Show changes

Dr Brain: Added detail the the item stuff

2005-01-11T19:19:26Z

Added detail the the item stuff

Dr Brain: added missing hscore headers

2005-01-11T18:42:27Z

added missing hscore headers

Smong: /* General Info */ typo (sensible)

2005-01-11T17:39:28Z

‎General Info: typo (sensible)

Dr Brain: Removed edit lock text

2005-01-11T16:59:57Z

Removed edit lock text

Dr Brain: Added all the content

2005-01-11T16:59:13Z

Added all the content

Show changes

@@ Line 1: / Line 1: @@
 == Getting Started ==
-The first thing you should do is check with [[Dr Brain]] to make sure someone else isn't already making a similar module. The best way to contact him is in [[Hyperspace|SSCX-A Hyperspace]] via PM, ?message or with AIM/ICQ (check the Hyperspace news file for AIM name and ICQ number).
+The first thing you should do is check with [[Dr Brain]] to make sure someone else isn't already making a similar module. The best way to contact him is in [[Hyperspace|SSCE Hyperspace]] via PM, ?message or with AIM/ICQ (check the Hyperspace news file for AIM name and ICQ number).
 == General Info ==

← Older revision		Revision as of 14:32, 9 May 2005
Line 653:		Line 653:


−	[[Category: Module]]	+	[[Category:Module]]
−	[[Category: ~~Tutorial~~]]	+	[[Category:Guides]]

@@ Line 1: / Line 1: @@
 == Getting Started ==
-The first thing you should do is check with Dr Brain to make sure someone else isn't already making a similar module. The best way to contact him is in [[Hyperspace|SSCX-A Hyperspace]] via PM, ?message or with AIM/ICQ (check the Hyperspace news file for AIM name and ICQ number).
+The first thing you should do is check with [[Dr Brain]] to make sure someone else isn't already making a similar module. The best way to contact him is in [[Hyperspace|SSCX-A Hyperspace]] via PM, ?message or with AIM/ICQ (check the Hyperspace news file for AIM name and ICQ number).
 == General Info ==

@@ Line 1: / Line 1: @@
 == Getting Started ==
-The first thing you should do is check with Dr Brain to make sure someone else isn't already making a similar module. The best way to contact him is in [[SSCX-A Hyperspace|Hyperspace]] via PM, ?message or with AIM/ICQ (check the Hyperspace news file for AIM name and ICQ number).
+The first thing you should do is check with Dr Brain to make sure someone else isn't already making a similar module. The best way to contact him is in [[Hyperspace|SSCX-A Hyperspace]] via PM, ?message or with AIM/ICQ (check the Hyperspace news file for AIM name and ICQ number).
 == General Info ==

@@ Line 2: / Line 2: @@
 The first thing you should do is check with Dr Brain to make sure someone else isn't already making a similar module. The best way to contact him is either in game (PM/?message) or via AIM/ICQ (check the Hyperspace news file).
 == General Info ==
@@ Line 11: / Line 10: @@
 Because of module naming conflicts, all official Hyperspace related modules are prefixed with hs_. So, for example, a kill spree module becomes hs_spree. This is not required for module submissions. You are free to name your module whatever you wish.
 == Style ==
@@ Line 281: / Line 279: @@
 #endif //HSCORE_TYPES_H
 </pre>
 == Money and Experience ==
@@ Line 347: / Line 344: @@
 === Giving money ===
 The first thing to decide is which money type to give. This is mainly used for tracking purposes. If in doubt, choose '''MONEY_TYPE_EVENT'''.
@@ Line 364: / Line 362: @@
 == Using Items ==
-Items are the most important part of Hyperspace after money and exp. There are two parts of items that addon modules will use. These are checking for properties and calling events.
+Items are the most important part of Hyperspace after money and exp. There are two parts of items that addon modules will use. These are checking for properties and calling events. While module writers cannot directly create items, they can request item modification/addition from subarena owners.
 Here is a copy of ''hscore_item.h'':
@@ Line 397: / Line 395: @@
 === Item properties ===
-Most items define properties that are used to change the player's ship. Properties are totalled for each ship and are checked per ship rather than per item. Most properties are related to the spawning module. However, any item can define custom properties.
+Most items define properties that are used to change the player's ship. Properties are totalled for each ship and are checked per ship rather than per item. Most properties are related to the spawning module. However, any item can define custom properties. For example, if you have a subway system, a module could check if a player has at least one subway token property. You can check if the property sum on the player's current ship for "subway" is greater than 0, and if it is, let them ride.
 <pre>
 item->getPropertySum(p, p->p_ship, "someproperty"); //Beware of spectators.
 </pre>
 === Item events ===
-Items define actions that happen on certain events. Any module can trigger an event. Some modules, for example, have actions on the ''death'' event. Triggering an event is as simple as making a function call to the '''hscore_item''' module. If no items have actions on the called event, nothing will happen (so make sure you don't typo the event name).
+Items define actions that happen on certain events. Any module can trigger an event. Some modules, for example, have actions on the ''death'' event. Triggering an event is as simple as making a function call to the '''hscore_item''' module. If no items have actions on the called event, nothing will happen (so make sure you don't typo the event name). Following on the previous example, when a player rides the subway, then you can call the "ridesubway" event. The Subway Token items can define an action of self removal on that event.
 <pre>

@@ Line 136: / Line 136: @@
 	return MM_FAIL;
+}
 </pre>

@@ Line 6: / Line 6: @@
 == General Info ==
-In general, hard coding values is frowned upon. Please try to use the arena and global configs wherever possible. Put a sensable default into the '''GetInt''' so that not every config entry needs to be present for the module to work.
+In general, hard coding values is frowned upon. Please try to use the arena and global configs wherever possible. Put a sensible default into the '''GetInt''' so that not every config entry needs to be present for the module to work.
 == Naming ==

← Older revision		Revision as of 16:59, 11 January 2005
Line 1:		Line 1:
−	~~I am editing. This may take a while. -- Dr Brain~~
−
−
	== Getting Started ==		== Getting Started ==