SSH Productions: Module documentation for Shadow.zip

Module: Shadow 1.1, by SSH

Let all your characters have a shadow.

Download Shadow as a zip file

Author

Andrew MacCormack (SSH)

Please use the messaging function on the AGS forums to contact

me about problems with this module

Abstract

Make a circular shadow underneath characters.

Dependencies

AGS 2.72 or later

Functions

 function Shadow.SetPerspective(float factor);

Set the perspective factor of the circle. The default is for the

height of the circle to be 0.15 times the width

 function Shadow.Disable(Character *who); 

Turn off the shadow for the specified character.

 function Shadow.Enable(Character *who);

Turn on the shadow for the specified character.

 function Shadow.SetOffset(Character *who, optional int y, optional int x);

Set the y and x offset for the specified character, for example

if they generally have a lot of blank space around the edge of

their frames. Default offsets are 0. If you pass only 1 parameter, the

x offset is assumed to be 0, which is usually right.

 function Shadow.SetRGB(int red, int green, int blue);

Set the colour of the shadow. NB pure black shadows (0,0,0) do not

become transparent, so the default is (35, 35, 35).

 function Shadow.SetTransparency(int percent);

Set the transparency level for the shadow. Default is 80%

Configuration

By default, all characters in the current room will have shadows.

Example

  Just add the module, and everyone will have shadows

Caveats

Animated background frames mess it up.

Walkbehinds don't work on the shadow.

Revision History

31 Oct 06: v1.0 First release of Shadow module

5 Mar 09: v1.1 Updated to work with AGS 3.0+

Licence

Shadow AGS script module

Copyright (C) 2006, 2009 Andrew MacCormack

This module is licenced under the Creative Commons Attribution Share-alike

licence, (see http://creativecommons.org/licenses/by-sa/2.5/scotland/ )

which basically means do what you like as long as you credit me and don't

start selling modified copies of this module.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL

THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER

DEALINGS IN THE SOFTWARE.

In addition to the licences mentioned in the modules themselves, you may choose to use the following creative commons licence if you prefer for all AGS modules and open source code resources on my site.

Creative Commons License
This work is licenced under a Creative Commons Licence.