1# $Header: /home/yav/catty/fkiss/RCS/fkissex.doc,v 1.2 2000/09/11 07:21:50 yav Exp $
2
3fkiss event extension notes
4
5--------
6--------------------------------
7EventHandler			- Identifier
8Indentification header for fkiss-extension.
9�C�x���g�g���̎��ʎq
10The line started ";@" after it are treated fkiss-extension description lines.
11����ȍ~��;@�ł͂��܂�s�̓C�x���g�g���̋L�q�s�Ƃ݂Ȃ��D
12
13--------------------------------
14never()				- Event
15This event is never happen.
16�������Ȃ��C�x���g�D
17So following actions are not processed.
18���̃C�x���g�ɑ΂���A�N�V�����͔������Ȃ��D
19Ignore this.
20�������邱�ƁD
21
22--------------------------------
23initialize()			- Event
24This event happen when KISS start.
25�N�����ɔ�������C�x���g�D
26(Before KISS read cel pixels etc.)
27�i�Z���f�[�^���̑��̃f�[�^�̓ǂݍ��ݑO��������Ȃ��j
28Following actions are permitted only
29���̃C�x���g�ɑ΂���A�N�V�����́C
30  nop, debug, shell, unmap.
31Don't use other actions.
32�����������‚���Ȃ��D
33
34--------------------------------
35begin()				- Event
36This event happen when KISS window is mapped first by Window manager.
37�E�B���h�E�}�l�[�W���[�ɂ����KISS�̃E�B���h�E���ŏ��Ƀ}�b�v���ꂽ����
38��������C�x���g�D
39If you want to start timer, use timer action following this event.
40initialize����begin�܂ł͊‹��ɂ���Ă̓��[�U�[�ɂ��C�ӂ̎��Ԓx����
41Because, there are any time delay between initialise to begin.
42��������̂ŁCtimer���̃A�N�V�����͂����Ŏw�肷��ׂ��ł���D
43(Don't use timer action for initialize following actions.)
44(initialize�C�x���g�ł�timer�A�N�V�������g���Ȃ���)
45
46--------------------------------
47end()				- Event
48This event happen when close window.
49[Quit]���j���[���I�����ꂽ��C�E�B���h�E�}�l�[�W���ɂ����
50[Quit] menu is selected, or destroyed by Window manager.
51KISS���I��������ꂽ�ꍇ�Ɉ�x������������C�x���g�D
52
53--------------------------------
54nop()				- Action
55No operation.
56�������Ȃ��Ƃ����A�N�V�����D
57
58--------------------------------
59debug("here!\n")		- Action
60Print arg string to stderr.
61�W���G���[�o��(�݂�����)�Ɉ����̕�������o�͂���A�N�V�����D
62For debug.
63�f�o�b�O�p�D
64
65--------------------------------
66shell("echo Hello `whoami`")	- Action
67Fork shell with argument string.
68�����̕������n����shell�����s����Ƃ����A�N�V�����D
69No compatibility! Because, the argument is depend on OS.
70���̓��e��OS�Ɉˑ�����̂Ō݊����������D
71And this action will make a SECURITY HOLE!
72�܂��C�Z�L�����e�B�z�[���ɂȂ肦��̂ŁC
73For safety, Don't execute this action.
74�ʏ�͎��s���Ȃ��ق������S�ł���D
75(My fkiss execute it only -eventshell option is specified.)
76(fkiss�ł�-eventshell�I�v�V�������w�肳�ꂽ�ꍇ�����L���ƂȂ�D)
77
78--------------------------------
79timer(2, 3000)			- Action
80Same as randomtimer(2, 3000, 1).
81randomtimer(2, 3000, 1)�Ɠ����D
82
83--------------------------------
84randomtimer(2, 3000, 5000)	- Action
85Set alarm timer.
86�A���[���^�C�}��ݒ肷��A�N�V�����D
87Channel-arg1 alarm event happen at (arg2 + (rand() % arg3)) milli-seconds
88���̃A�N�V�������w�肳��Ă���C�x���g�̔�����������
89after this action described event happen time.
90����2 + (rand() % ����3)�~���b��Ɉ���1�̃`�����l���̃A���[������������D
91If arg3 is zero, happen at arg2 milli-seconds after.
92����������3��0�̏ꍇ�́C����2�~���b��D
93If arg2 is zero, channel-arg1 timer is cleard. channel-arg1 alarm not happen.
94����2�� 0�̏ꍇ�͈���1�̃`�����l���̃^�C�}���N���A�D(�A���[���͔������Ȃ�)
95arg2 must be 0 to 32767. arg3 must be 0 to 32767-arg2.
96����2�� 0�ȏ� 32767�ȉ��C����3�� 0�ȏ� 32767-arg2�ȉ��̒l�D
97The value over 32767 is depend on system, Not recomment to use.
98����ȏ�̒l�͏����n�ˑ��ł���C�g�p�͐����ł��Ȃ��D
99rand() is pseudo randomize number function. It return a number 0 to 32767.
100rand()��0����32767�܂ł̒l���Ƃ�^�������D
101Argorithm of calcration is depend on system.
102���̐���̌v�Z���͌��ݏ����n�ˑ��D
103
104--------------------------------
105sound("bye.au")			- Action
106Play PCM audio file.
107������PCM�I�[�f�B�I�t�@�C����������D
108The format of audio file is still not defined.
109PCM�I�[�f�B�I�t�@�C���̃t�H�[�}�b�g�ɂ‚��Ă͖���D
110My fkiss support
111fkiss�ł͓������[�`���ł�
112Sun Audio file and
113Sun Audio file ����сC
11422.05KHz 1Ch 8bit unsigned RIFF-WAVE file.
11522.05KHz 1Ch 8bit unsigned��Windows WAV�t�@�C�����Đ��”\�D
116Already playing sound the effect of this action is not defined. (system depend)
117���łɁC�����Đ����̏ꍇ�̓���͏����n�ˑ��D
118
119--------------------------------
120alarm(1)			- Event
121This event happen at the time set by timer/randomtimer action.
122�����̃`�����l���̃^�C�}�[�ɐݒ肳�ꂽ�����ɂȂ����甭������C�x���g�D
123Arg is timer channel number, it must be 0 to 63.
124�^�C�}�[�`�����l���� 0����63�̒l�D
125There are some delay time for target alarm time.
126�����n�̐��\�ɂ��C
127������randomtimer�Ŏw�肳�ꂽ�������x��Ĕ�������ꍇ����D
128Next alarm time is calcurated with this delay time.
129
130--------------------------------
131press("vast.cel")		- Event
132This event happen at mouse button pressed on arg cel or object.
133�����̃Z���������̓I�u�W�F�N�g���\������Z���̏��
134�}�E�X�̃{�^���������ꂽ�ꍇ�ɔ�������C�x���g�D
135
136--------------------------------
137map("facered.cel")		- Action
138Map a cel. (Cel is visible)
139�����̃Z����\����Ԃɂ���D
140Arg must be cel filename.
141�����̓Z���t�@�C���l�[���łȂ���΂Ȃ�Ȃ��D
142My fkiss support a object as argument.
143fkiss�ł͈���1�ɃI�u�W�F�N�g���w�肵���ꍇ�C
144All cels of the object mapping status is changed.
145���̃I�u�W�F�N�g���\������S�ẴZ����\����Ԃɂ��邪�C
146But, this function sometime need very heavy processing.
147���̋@�\�͏ꍇ�ɂ���Ă͔��ɏd�������ƂȂ肦��̂Ō������D
148
149--------------------------------
150release("vast.cel")		- Event
151This event happen at mouse button released on arg cel or object.
152�����̃Z���������̓I�u�W�F�N�g���\������Z���̏��
153�}�E�X�̃{�^���������ꂽ�ꍇ�ɔ�������C�x���g�D
154In the strict sense, arg cel or object pressing is finished.
155�������C���̏ꍇ�̃Z���̏�łƂ����̂͌����ȈӖ��ł͐������Ȃ��D
156�����ɂ͈����̃Z���̃h���b�O���I�������Ƃ����Ӗ��ł���D
157
158--------------------------------
159unmap("facered.cel")		- Action
160Unmap a cel. (Cel is invisible)
161�����̃Z�����\����Ԃɂ���D
162
163--------------------------------
164catch(#1)			- Event
165This event happen at mouse button pressed on and start drugging arg object.
166�����̃I�u�W�F�N�g���h���b�O�J�n���ꂽ�ꍇ�ɔ�������C�x���g�D
167
168--------------------------------
169altmap("panties.cel")		- Action
170Alternate cel map/unmap status.
171�����̃Z���̕\��/��\���̐؂�ւ�������D
172My fkiss support a object as argument.
173fkiss�ł͈����ɃI�u�W�F�N�g���w�肳�ꂽ�ꍇ
174In this case all cels of the object status are alternated.
175���̃I�u�W�F�N�g���\������S�ẴZ���̕\��/��\����؂�ւ��邪�C
176Sometime this function need heavy processing.
177�ꍇ�ɂ���Ă͔��ɏd�������ƂȂ肦��̂Ō������D
178
179--------------------------------
180drop(#1)			- Event
181This event happen at object drugging finished.
182�����̃I�u�W�F�N�g���͂Ȃ��ꂽ�ꍇ�ɔ�������C�x���g�D
183While mouse button pressing, the object with non-zero fixed value return
184�}�E�X�{�^�����������܂܂ł��C�؂��؂��̏ꍇ�ɃI�u�W�F�N�g��
185to initial position, this event happen too.
186���̈ʒu�ɂ��ǂ����ꍇ��drop�Ƃ݂Ȃ��܂��D
187
188--------------------------------
189fixcatch(#1)			- Event
190This event happen at mouse button pressed on and start drugging
191�����̃I�u�W�F�N�g���h���b�O�J�n�����Ƃ��ɁC
192on arg object that have non-zero fixed value.
193���̃I�u�W�F�N�g�̌��݂̌Œ�l��0�łȂ��ꍇ�ɔ�������C�x���g�D
194
195--------------------------------
196fixdrop(#1)			- Event
197This event happen at finish to drug non-zero fixed value object.
198�����̃I�u�W�F�N�g�̃h���b�O���I�������Ƃ��ɁC
199���̃I�u�W�F�N�g�̌��݂̌Œ�l��0�łȂ��ꍇ�ɔ�������C�x���g�D
200
201--------------------------------
202move(#1, 10, -2)		- Action
203Move a position of arg1 object to arg2 pixels right and arg3 pixels lower.
204����1�̃I�u�W�F�N�g������2�s�N�Z���E, ����3�s�N�Z�����Ɉړ�������D
205But, object is in the area that specified *.cnf screen size description.
206�������C�Z���̒[��cnf�Ŏw�肳�ꂽ��ʃT�C�Y�����邱�Ƃ͂Ȃ��D
207(Same as normal moving by user mouse operation.)
208(�ʏ�̃}�E�X�ɂ��ړ��Ɠ���)
209
210--------------------------------
211unfix(#1)			- Event
212This event happen at arg object fixed value turn to zero.
213�����̃I�u�W�F�N�g�ւ̈��Ə�M�̍�Ƃ����������ꍇ�ɔ�������C�x���g�D
214
215--------------------------------
216changeset(2)			- Action
217Change arg set.
218�����̃Z�b�g�ɐ؂�ւ���A�N�V�����D
219
220--------------------------------
221changecol(2)			- Action
222Change arg color.
223�����̃J���[�ɐ؂�ւ���A�N�V�����D
224
225--------------------------------
226set(1)				- Event
227This event happen at arg set is selected.
228�����̃Z�b�g�ɐ؂�ւ���ꂽ�ꍇ�ɔ�������C�x���g�D
229
230--------------------------------
231col(1)				- Event
232This event happen at arg color is selected.
233�����̃J���[�ɐ؂�ւ���ꂽ�ꍇ�ɔ�������C�x���g�D
234
235--------------------------------
236quit()				- Action
237Quit KISS.
238KISS���I������A�N�V�����D
239
240
241--------------------------------
242
243�e�C�x���g�ɑΉ����镡���̃A�N�V�����̎��s�����͗��z�I�ɂ͕������ƂȂ�܂��D
244���������A�N�V�����͎w�肵�Ȃ��悤�ɂ��܂��傤�D
245�Ⴆ�΁C�Z�b�g1�ɐ؂�ւ��‚ƒZ�b�g2�ɐ؂�ւ��悤�Ƃ����ꍇ�ɂ́C
246���̃X�C�b�`������”\��������܂��D(��R)
247
248�܂��C���Ă܂��͏����n�ˑ��C�����I�ɂ͋L�q���Ƃ����Ƃ��ł��傤�D
249
250
251                                        yav <yav@bigfoot.com>
252                                                        yav
253
254