Flashlight: Difference between revisions

[http://www.meleepta.com/file.php?dir=ags&file=Flashlight_2_0_BETA_2.rar Download v2.0 BETA 2]

Emulates the "flashlight" effect using a GUI or screen overlays.

====FLASHLIGHT_GUI====

Sets the module to {{link||GUI mode}}. If this macro is set, it must be defined to the script o-name of a GUI of which the first 5 controls are buttons. If not set the module will default to {{link||Overlay mode}}.

Defines the maximum radius of the flashlight beam.

=====eFlashlight_MinimumRadius=====

Defines the minimum radius of the flashlight beam.

====Flashlight.CharacterToFollow====

''writeprotected int Flashlight.CharacterToFollow''

Defines the Character the flashlight will follow. If set to '''null''' the flashlight will follow the mouse instead.

''See Also:'' {{link||Flashlight.FollowCharacter}}, {{link||Flashlight.FollowMouse}}

====Flashlight.FollowCharacter====

''void Flashlight.FollowCharacter(Character* Char)''

''void Flashlight.SetCharacterToFollow(Character* Char)''

Sets the flashlight to follow Character CHAR. If CHAR is null then the flashlight will follow the mouse instead. If "Enforce object-based scripting" is turned off this function will be implemented as Flashlight.SetCharacterToFollow. The script autocomplete will automatically detect the correct version.

''See Also:'' {{link||Flashlight.CharacterToFollow}}, {{link||Flashlight.FollowMouse}}

====Flashlight.FollowMouse====

''void Flashlight.FollowMouse()''

Sets the flashlight to follow the mouse instead of a Character. This is the same as passing '''null''' to {{link||Flashlight.FollowCharacter}}.

''See Also:'' {{link||Flashlight.CharacterToFollow}}, {{link||Flashlight.FollowCharacter}}

====Flashlight.Enabled====

''bool Flashlight.Enabled''

Turns the flashlight effect on and off.

====Flashlight.IsFollowingCharacter====

''writeprotected bool Flashlight.IsFollowingCharacter''

Returns whether the flashlight is currently following a Character. This is the opposite of {{link||Flashlight.IsFollowingMouse}}.

''See Also:'' {{link||Flashlight.FollowCharacter}}, {{link||Flashlight.IsFollowingMouse}}

''writeprotected bool Flashlight.IsFollowingMouse''

Returns whether the flashlight is currently following the mouse. This is the opposite of {{link||Flashlight.IsFollowingCharacter}}.

''See Also:'' {{link||Flashlight.FollowMouse}}, {{link||Flashlight.IsFollowingCharacter}}

====Flashlight.Radius====

''float Flashlight.Radius''

Gets/sets the radius of the flashlight beam.

''Note that this is the '''radius''', not the diameter. This means that this property is half the width of the entire beam.''

====Flashlight.SetSprite====

Allows you to set the sprite to use for the flashlight beam. To pass an existing sprite you can use {{link|DynamicSprite functions and properties|DynamicSprite.CreateFromExistingSprite}} as the parameter. This function will reject null pointers.

''See Also:'' {{link||Flashlight.Sprite}}

====Flashlight.Sprite====

''writeprotected DynamicSprite* Flashlight.Sprite''

The sprite used for the flashlight beam. You can use this property to delete the sprite before exiting your game, however you '''must''' ensure that {{link||Flashlight.Enabled}} is set to '''false''' first or your game will crash. This sprite is automatically loaded from "flashlight.bmp" in your game's Compiled folder if the file exists. If the file does not exist you '''must''' set this property with {{link||Flashlight.SetSprite}} '''before''' setting {{link||Flashlight.Enabled}} to true or your game will crash.

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.

====GUI Mode====

To activate GUI mode you must put the following in the Flashlight module header:

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).

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.