BWP Architecture - Revision history

Grigbertz: /* Comm Module */

2008-09-12T09:07:53Z

Comm Module

←Older revision		Revision as of 09:07, 12 September 2008
Line 22:		Line 22:
	* <b>set name</b> Common name of all objects using the set channel		* <b>set name</b> Common name of all objects using the set channel
	* <b>receiver</b> An identifier telling the receiving end this is the action for me		* <b>receiver</b> An identifier telling the receiving end this is the action for me
-	** <b>num</b> Optional. Script number for initial filtering of link messages. Sent as the num argument in the link message.
-	** <b>id</b> Optional. Is this useful?
	* <b>sender</b> Identifies the original source of the command		* <b>sender</b> Identifies the original source of the command
-	** <b>num</b> Optional. Sent as the sender_num argument in the link message.
-	** <b>id</b> Optional. Is this useful?
	* <b>action</b> The info handled by the receiver.		* <b>action</b> The info handled by the receiver.

2008-09-06T13:26:01Z

Menu Module

←Older revision		Revision as of 13:26, 6 September 2008
Line 146:		Line 146:
	<pre>		<pre>
	---anklechains---		---anklechains---
-	* Apply chains to %o's ankle cuffs:	+	* Apply chains to ++owner name++'s ankle cuffs:

	[Add] BWP::1 \| rankle \| addchain \| lankle \| keepmenu		[Add] BWP::1 \| rankle \| addchain \| lankle \| keepmenu
Line 157:		Line 157:

	=== Variables ===		=== Variables ===
-	Variables connected to status values. %o stands for owner name in the previous example.	+	Variables connected to status values. ++owner name++ stands for owner name in the previous example.

-	~~Also conditional~~ buttons ~~and menus based on~~ status values.	+	The following example defines alternate versions of some buttons, defined by status values. The first status to match is chosen. If no match is found, the last 'default' version is used

	==== Example ====		==== Example ====
	<pre>		<pre>
	---anklechains---		---anklechains---
-	* Apply chains to %o's ankle cuffs:	+	* Apply chains to ++owner name++'s ankle cuffs:

-	++ ~~Default~~ ++	+	++ freedom state == free ++
	[Add] BWP::1 \| rankle \| addchain \| lankle \| keepmenu		[Add] BWP::1 \| rankle \| addchain \| lankle \| keepmenu
	[Remove] BWP::1 \| rankle \| removechain \| keepmenu		[Remove] BWP::1 \| rankle \| removechain \| keepmenu
	[ ]		[ ]
-	++ ~~Locked Free~~ ++	+	++ freedom state == locked free ++
	[Add] BWP::1 \| rankle \| addchain \| lankle \| keepmenu		[Add] BWP::1 \| rankle \| addchain \| lankle \| keepmenu
	[ ]		[ ]
	[ ]		[ ]
-	++ ~~Not Free~~ ++	+	++ Default ++
	[ ]		[ ]
	[ ]		[ ]

2008-09-06T13:16:43Z

Example

←Older revision		Revision as of 13:16, 6 September 2008
Line 166:		Line 166:
	* Apply chains to %o's ankle cuffs:		* Apply chains to %o's ankle cuffs:

-	~~if (%(freedom state) == free) {~~	+	++ Default ++
-	[Add] BWP::1 \| rankle \| addchain \| lankle \| keepmenu	+	[Add] BWP::1 \| rankle \| addchain \| lankle \| keepmenu
-	[Remove] BWP::1 \| rankle \| removechain \| keepmenu	+	[Remove] BWP::1 \| rankle \| removechain \| keepmenu
-	[ ]	+	[ ]
-	}	+	++ Locked Free ++
		+	[Add] BWP::1 \| rankle \| addchain \| lankle \| keepmenu
		+	[ ]
		+	[ ]
		+	++ Not Free ++
		+	[ ]
		+	[ ]
		+	[ ]
		+	+++
	[ ]		[ ]
	[Back...] menu \| options		[Back...] menu \| options
	[Main...] menu \| main		[Main...] menu \| main
	</pre>		</pre>
-
-	~~The above needs a more scripty syntax~~

	== Sessions Module ==		== Sessions Module ==
	Standalone or handled by menumodule?		Standalone or handled by menumodule?

2008-09-06T13:00:29Z

To Do

←Older revision		Revision as of 13:00, 6 September 2008
Line 37:		Line 37:
	==== To Do ====		==== To Do ====
	* How best to specify sender and recever? Should there be a standardized item identifier?		* How best to specify sender and recever? Should there be a standardized item identifier?
-	** <item name>\|<script name> might be good.	+	** <item name>\|<script name>[\|<keyword1>...\|<keyword1N>] might be good.
		+	** Receivers, 'all' keyword:
		+	*** 'all' = all scripts of entire set
		+	*** 'all\|runes = all 'runes' scripts of entire set
		+	*** 'rankle\|all = all scripts of right ankle item
		+	*** 'rankle\|links' = all 'links' scripts of right ankle item
	* Fields for handling of e-mail info		* Fields for handling of e-mail info
	* Adapt this for efficient handling of menus		* Adapt this for efficient handling of menus

2008-09-06T12:52:31Z

To Do

←Older revision		Revision as of 12:52, 6 September 2008
Line 43:		Line 43:
	* Relay info. Bitfield.		* Relay info. Bitfield.
	* Request/Response standard format		* Request/Response standard format
-	* Is it possible to rule that all scripts should use link message to item Comm script for all communication?	+	* Is it possible to rule that all scripts should use link message to item Comm script for all communication? Only receiver and action + arguments need to be specified. Anything else is added by the Comm script.

	==== Example ====		==== Example ====

2008-09-06T12:50:39Z

To Do

←Older revision		Revision as of 12:50, 6 September 2008
Line 43:		Line 43:
	* Relay info. Bitfield.		* Relay info. Bitfield.
	* Request/Response standard format		* Request/Response standard format
		+	* Is it possible to rule that all scripts should use link message to item Comm script for all communication?

	==== Example ====		==== Example ====

2008-09-06T12:47:53Z

To Do

←Older revision		Revision as of 12:47, 6 September 2008
Line 41:		Line 41:
	* Adapt this for efficient handling of menus		* Adapt this for efficient handling of menus
	* Is there any need for a unique message ID field?		* Is there any need for a unique message ID field?
		+	* Relay info. Bitfield.
		+	* Request/Response standard format

	==== Example ====		==== Example ====

2008-09-06T12:46:01Z

Fields

←Older revision		Revision as of 12:46, 6 September 2008
Line 19:		Line 19:
	** 1 - handled by Comm module only. Ignored by others.		** 1 - handled by Comm module only. Ignored by others.
	** 2 - ignored by Comm module.		** 2 - ignored by Comm module.
		+	** (Use bits instead specify what type of channels to relay to)
	* <b>set name</b> Common name of all objects using the set channel		* <b>set name</b> Common name of all objects using the set channel
	* <b>receiver</b> An identifier telling the receiving end this is the action for me		* <b>receiver</b> An identifier telling the receiving end this is the action for me

2008-09-06T12:36:31Z

Example

←Older revision		Revision as of 12:36, 6 September 2008
Line 160:		Line 160:
	[Add] BWP::1 \| rankle \| addchain \| lankle \| keepmenu		[Add] BWP::1 \| rankle \| addchain \| lankle \| keepmenu
	[Remove] BWP::1 \| rankle \| removechain \| keepmenu		[Remove] BWP::1 \| rankle \| removechain \| keepmenu
-	[ ]	+	[ ]
	}		}
	[ ]		[ ]
Line 167:		Line 167:
	</pre>		</pre>

-	The above needs more scripty syntax	+	The above needs a more scripty syntax

	== Sessions Module ==		== Sessions Module ==
	Standalone or handled by menumodule?		Standalone or handled by menumodule?

2008-09-06T12:36:07Z

Menu Module

←Older revision		Revision as of 12:36, 6 September 2008
Line 147:		Line 147:
	</pre>		</pre>

-	Variables connected to status values. %o stands for owner name in the example ~~above~~.	+	=== Variables ===
		+	Variables connected to status values. %o stands for owner name in the previous example.

	Also conditional buttons and menus based on status values.		Also conditional buttons and menus based on status values.
Line 157:		Line 158:

	if (%(freedom state) == free) {		if (%(freedom state) == free) {
-	[Add] BWP::1 \| rankle \| addchain \| lankle \| keepmenu	+	[Add] BWP::1 \| rankle \| addchain \| lankle \| keepmenu
-	[Remove] BWP::1 \| rankle \| removechain \| keepmenu	+	[Remove] BWP::1 \| rankle \| removechain \| keepmenu
	[ ]		[ ]
	}		}