Anonymous user
Flashlight: Difference between revisions
m
no edit summary
*>Monkey 05 06 mNo edit summary |
*>Monkey 05 06 mNo edit summary |
||
| Line 100: | Line 100: | ||
Sets the overall transparency for the darkened areas of the screen. This property can only be used in {{link||GUI mode}}. In {{link||Overlay mode}} this property will remain at 100 as Overlays cannot currently have transparency. | Sets the overall transparency for the darkened areas of the screen. This property can only be used in {{link||GUI mode}}. In {{link||Overlay mode}} this property will remain at 100 as Overlays cannot currently have transparency. | ||
==Setup== | |||
===Modes=== | |||
====GUI Mode==== | |||
To activate GUI mode you must put the following in the Flashlight module header: | |||
#define FLASHLIGHT_GUI gFlashlight | |||
Where ''gFlashlight'' is the script o-name of your GUI. The first 5 controls of this GUI '''must''' be buttons or the module will crash. | |||
====Overlay Mode==== | |||
Overlay mode is the default mode for the module. You cannot use {{link||Flashlight.Transparency|transparency}} in Overlay mode. If you want to use transparency, use {{link||GUI mode}} instead. Overlay mode depends on the ability to create 5 Overlays, so if you use background speech or are creating your own overlays be aware of this as the Overlays may fail to be created (though under normal circumstances this should not happen). | |||
===Other Setup=== | |||
In order for the Flashlight module to work, you must either: | |||
a) include a "flashlight.bmp" file in your game's Compiled folder OR | |||
b) call Flashlight.SetSprite on a valid DynamicSprite '''before''' turning the Flashlight effect on. | |||
Failure to do this will cause your game to crash. | |||
==Licensing== | ==Licensing== | ||