Logging and Event Hooks - Revision history

John.Glauert: Add avatar ready event.

2023-06-30T15:36:58Z

Add avatar ready event.

← Older revision		Revision as of 15:36, 30 June 2023
Line 65:		Line 65:

	* '''avatarloaded''': '''msg''' is a string naming the avatar that has been loaded. Used for updating avatar menus in the CWASA GUI. If loading an avatar fails, the following '''avatarloaded''' event will indicate that the original avatar is reinstated.		* '''avatarloaded''': '''msg''' is a string naming the avatar that has been loaded. Used for updating avatar menus in the CWASA GUI. If loading an avatar fails, the following '''avatarloaded''' event will indicate that the original avatar is reinstated.

			* '''avatarready''': '''msg''' is null. Indicates that the avatar has been loaded and rendered.

	* '''sigmlloading''': '''msg''' is null. Indicates that SiGML data is being processed. Used to update the CWASA GUI.		* '''sigmlloading''': '''msg''' is null. Indicates that SiGML data is being processed. Used to update the CWASA GUI.

John.Glauert: Fix typos on CWASA.callHook

2023-06-30T15:11:53Z

Fix typos on CWASA.callHook

← Older revision		Revision as of 15:11, 30 June 2023
Line 88:		Line 88:
	* '''CWASA.getLogger(logger, loggerlevel)''': Configure and receive a CWASA logger.		* '''CWASA.getLogger(logger, loggerlevel)''': Configure and receive a CWASA logger.
	* '''CWASA.addHook(typ, fun, av)''': Install a hook function to be called on specific events for specific avatars.		* '''CWASA.addHook(typ, fun, av)''': Install a hook function to be called on specific events for specific avatars.
	* '''CWASA.~~callHookL~~(typ, msg, av)''': Post ~~and~~ event to be passed to appropriate hook functions.		* '''CWASA.callHook(typ, msg, av)''': Post an event to be passed to appropriate hook functions.

	----		----
	[[Main Page\|Home]] >> [[CWA Signing Avatars\|CWASA]]		[[Main Page\|Home]] >> [[CWA Signing Avatars\|CWASA]]

John.Glauert at 16:39, 23 February 2021

2021-02-23T16:39:45Z

← Older revision		Revision as of 16:39, 23 February 2021
Line 68:		Line 68:
	* '''sigmlloading''': '''msg''' is null. Indicates that SiGML data is being processed. Used to update the CWASA GUI.		* '''sigmlloading''': '''msg''' is null. Indicates that SiGML data is being processed. Used to update the CWASA GUI.

	* '''sigmlloaded''': '''msg''' is an object with fields '''s''' for the number of signs and '''f''' for the number of frames. ~~Not used~~ by the CWASA GUI.		* '''sigmlsign''': '''msg''' is a JSON object containing the frames of a sign. Available for user scripts.

			* '''sigmlloaded''': '''msg''' is an object with fields '''s''' for the number of signs and '''f''' for the number of frames. Used by the CWASA GUI.

	* '''animactive''': '''msg''' is null. Indicates that animation is in progress. Used to update the CWASA GUI. Will normally be issued before '''sigmlloaded''' has been signalled.		* '''animactive''': '''msg''' is null. Indicates that animation is in progress. Used to update the CWASA GUI. Will normally be issued before '''sigmlloaded''' has been signalled.

John.Glauert at 18:39, 15 January 2021

2021-01-15T18:39:25Z

← Older revision		Revision as of 18:39, 15 January 2021
Line 1:		Line 1:
	[[Main Page\|Home]] >> [[~~JASigning~~]]		[[Main Page\|Home]] >> [[CWA Signing Avatars\|CWASA]]
			----
	== Logging System ==		== Logging System ==

Line 89:		Line 89:

	----		----
	[[Main Page\|Home]] >> [[~~JASigning~~]]		[[Main Page\|Home]] >> [[CWA Signing Avatars\|CWASA]]

John.Glauert: Additional notes on Event Hooks.

2019-02-23T17:28:33Z

Additional notes on Event Hooks.

← Older revision		Revision as of 17:28, 23 February 2019
Line 37:		Line 37:
	=== Using Hooks ===		=== Using Hooks ===

	* '''CWASA.addHook(typ, fun, av)''': Install a hook function to be called on specific events for specific ~~avatars~~.		* '''CWASA.addHook(typ, fun, av)''': Install a hook function to be called on specific events for specific avatar instances.

	The method takes a string for the type of event, a hook function, and an optional avatar panel index. If no index is given, '''*''' is used, indicating that the hook should receive events for all panels.		The method takes a string for the type of event, a hook function, and an optional avatar panel index. If no index is given, '''*''' is used, indicating that the hook should receive events for all panels.

	This example from '''~~OneAvTest~~.html''' links to existing '''status''' events to create a log of messages in a text field.		This example from '''OneAvClientTest.html''' links to existing '''status''' events to create a log of messages in a text field.

	function addStatus(evt) {		function addStatus(evt) {
Line 56:		Line 56:
	* '''CWASA.callHookL(typ, msg, av)''': Post and event to be passed to appropriate hook functions.		* '''CWASA.callHookL(typ, msg, av)''': Post and event to be passed to appropriate hook functions.

	As before, the avatar panel index is optional. When omitted, the event will be passed to all hook functions of the given type. The data will be presented in an event object with fields '''type''', for the type, and '''av''', for avatar index. The '''msg''' field has a structure depending on the type of event. See example above.		As before, the avatar panel index is optional. When omitted, the event will be passed to all hook functions of the given type. The data will be presented in an event object with fields '''type''', for the type, and '''av''', for avatar index. The '''msg''' field has a structure depending on the type of event. See an example above and more examples on the '''OneAv*Test.html''' pages.

	=== Supported Events ===		=== Supported Events ===
Line 62:		Line 62:
	* '''status''': '''msg''' is a string. Used for reporting status changes to the console and to fields in the CWASA GUI.		* '''status''': '''msg''' is a string. Used for reporting status changes to the console and to fields in the CWASA GUI.

	~~Note~~: ~~This system~~ is ~~under development and further event types will be added~~ in the ~~near future~~.		* '''avatarloading''': '''msg''' is a string naming the avatar being loaded. Used for updating avatar menus in the CWASA GUI.

	It is perfectly possible to define your own events, install hooks for them, and generate events for them. If the type of event is unknown to CWASA there ~~should~~ be no effect on the rest of the software.		* '''avatarloaded''': '''msg''' is a string naming the avatar that has been loaded. Used for updating avatar menus in the CWASA GUI. If loading an avatar fails, the following '''avatarloaded''' event will indicate that the original avatar is reinstated.

			* '''sigmlloading''': '''msg''' is null. Indicates that SiGML data is being processed. Used to update the CWASA GUI.

			* '''sigmlloaded''': '''msg''' is an object with fields '''s''' for the number of signs and '''f''' for the number of frames. Not used by the CWASA GUI.

			* '''animactive''': '''msg''' is null. Indicates that animation is in progress. Used to update the CWASA GUI. Will normally be issued before '''sigmlloaded''' has been signalled.

			* '''animidle''': '''msg''' is null. Indicates that animation has ceased. Used to update the CWASA GUI.

			* '''avatarfps''': '''msg''' is a floating point number giving the frames per second at which the designated avatar is rendering. Used to update the CWASA GUI.

			* '''avatarframe''': '''msg''' is an object with fields '''s''' for the sign index and '''f''' for frame index. Used to update the CWASA GUI. Called per frame. The indices are based at 0 so adding 1 will give a more natural presentation.

			* '''avatarsign''': '''msg''' is an object with fields '''g''' for the sign gloss, '''s''' for the sign index and '''f''' for frame index. Used to update the CWASA GUI. Called per sign and at the end of animation. The indices are based at 0 so adding 1 will give a more natural presentation. The frame index will be in the range associated with the sign.

			It is perfectly possible to define your own events, install hooks for them, and generate events for them. If the type of event is unknown to CWASA there will be no effect on the rest of the software.

	== Public CWASA Interface ==		== Public CWASA Interface ==

John.Glauert: Initial page on Logging and Event Hooks

2019-02-16T18:00:25Z

Initial page on Logging and Event Hooks

@@ Line 1: / Line 1: @@
 * '''CWASA.getLogger(logger, loggerlevel)''': Configure and receive a CWASA logger.
 * '''CWASA.addHook(typ fun, av)''': Install a hook function to be called on specific events for specific avatars.
 * '''CWASA.callHookL(typ, msg, av)''': Post and event to be passed to appropriate hook functions.

John.Glauert: Created page with "* '''CWASA.getLogger(logger, loggerlevel)''': Configure and receive a CWASA logger. * '''CWASA.addHook(typ fun, av)''': Install a hook function to be called on specific events..."

2019-02-16T17:05:45Z

Created page with "* '''CWASA.getLogger(logger, loggerlevel)''': Configure and receive a CWASA logger. * '''CWASA.addHook(typ fun, av)''': Install a hook function to be called on specific events..."

New page

* '''CWASA.getLogger(logger, loggerlevel)''': Configure and receive a CWASA logger.
* '''CWASA.addHook(typ fun, av)''': Install a hook function to be called on specific events for specific avatars.
* '''CWASA.callHookL(typ, msg, av)''': Post and event to be passed to appropriate hook functions.