Ver Fonte

Small documentation cleanups
* Cleaned up the inter_server.conf documentation.
* Cleaned up the script command openstorage2 documentation.

aleos89 há 8 anos atrás
pai
commit
b831287b0e
2 ficheiros alterados com 15 adições e 14 exclusões
  1. 10 9
      conf/inter_server.conf
  2. 5 5
      doc/script_commands.txt

+ 10 - 9
conf/inter_server.conf

@@ -1,22 +1,23 @@
 /**
- * Config for storages
+ * Config for Storages
  *
- * To access premium storage, use 'openstorage2' script command (except for the default storage).
- * If premium storages are added, just copy the structure of storage table then match the table name in this config.
+ * To access the premium storage, use script command 'openstorage2'.
+ * If premium storages are added, copy the structure of the storage table and match the table name in this config.
  * The 'max' of premium storages are not adjusted by 'vip_storage_increase' config nor MIN_STORAGE.
  *
  * Structure:
 {
-	id: <storage_id>          // (int) Storage ID will be used for 'openstorage2' script command.
-	name: "<storage name>"    // (string) Storage name will be sent to the client when player open the storage.
-	table: "<storage_table>"  // (string) Name of table where storage is saved, the table stucture is same like default storage name
-	max: <max_amount>         // (int) *optional* Maximum number of storage, MAX_STORAGE will be used if no value defined
+	id: <storage_id>          // (int) Storage ID will be used for script command 'openstorage2'.
+	name: "<storage name>"    // (string) Storage name will be sent to the client to display on the title bar.
+	table: "<storage_table>"  // (string) Name of table where storage is saved. The table stucture is the same as the default storage table.
+	max: <max_amount>         // (int) *optional* Maximum number of items in storage. MAX_STORAGE will be used if no value is defined.
 },					          // Use comma to add more storages
  **/
+
 storages: (
 {
-	// Default storage
-	// DO NOT CHANGE THIS EXCEPT YOU KNOW WHAT YOU ARE DOING
+	// Default Storage
+	// DO NOT CHANGE THIS UNLESS YOU KNOW WHAT YOU ARE DOING
 	id: 0
 	name: "Storage"
 	table: "storage"

+ 5 - 5
doc/script_commands.txt

@@ -5055,14 +5055,14 @@ window, to avoid any disruption when both windows overlap.
 
 *openstorage2 <storage_id>,<mode>{,<account_id>};
 
-Just like 'openstorage' command, except this command can open additional storage
-by specified 'storage_id'. For storage_id, please read the conf/inter_server.conf
-for storages groups.
+Just like the 'openstorage' command, except this command can open additional storages
+by the specified <storage_id>. For <storage_id>, please read the conf/inter_server.conf
+for storage groups.
 
-Values for 'mode' are:
+Values for <mode> are:
 	STOR_MODE_NONE : Player only can read the storage entries.
 	STOR_MODE_GET  : Player can get items from the storage.
-	STOR_MODE_PUT  : Player can put items to the storage.
+	STOR_MODE_PUT  : Player can put items in the storage.
 
 Example:
 	if (vip_status(1)) {