FischlWorks_FogWar.Shadowcaster.FogField Class Reference

Public Member Functions
void	AddColumn (LevelColumn levelColumn)
Color[]	GetColors (float fogPlaneAlpha)
void	Reset ()

Properties
LevelColumn	this[int index] [get, set]

Detailed Description

A class that holds visibility data updated based on the FOV.

This class is only instantiated and managed by a single Shadowcaster object,
and the object only lasts per session, unlike the serialized LevelData of csFogWar.
This class also has the GetColors() method, which returns the actual texture data in a 1D Color array format.

Member Function Documentation

AddColumn()

void FischlWorks_FogWar.Shadowcaster.FogField.AddColumn ( LevelColumn  levelColumn )

inline

            {
                levelRow.Add(levelColumn);
            }

Referenced by FischlWorks_FogWar.Shadowcaster.Initialize().

GetColors()

Color[] FischlWorks_FogWar.Shadowcaster.FogField.GetColors ( float  fogPlaneAlpha )

inline

            {
                if (colors == null)
                {
                    colors = new Color[levelRow.Count * levelRow[0].Count()];
                }
 
                for (int xIterator = 0; xIterator < levelRow[0].Count(); xIterator++)
                {
                    for (int yIterator = 0; yIterator < levelRow.Count; yIterator++)
                    {
                        int visibility = (int)levelRow[yIterator][levelRow[0].Count() - 1 - xIterator];
 
                        // The reason that the darker side is the revealed ones is to let users customize fog's color
                        colors[levelRow.Count() * (xIterator + 1) - (yIterator + 1)] =
                        new Color(
                            1 - visibility,
                            1 - visibility,
                            1 - visibility,
                            (1 - visibility) * fogPlaneAlpha);
                    }
                }
 
                return colors;
            }

Reset()

void FischlWorks_FogWar.Shadowcaster.FogField.Reset ( )

inline

            {
                foreach (LevelColumn levelColumn in levelRow)
                {
                    levelColumn.Reset();
                }
            }

Referenced by FischlWorks_FogWar.Shadowcaster.ResetTileVisibility().

Property Documentation

this[int index]

LevelColumn FischlWorks_FogWar.Shadowcaster.FogField.this[int index]

getset

                                               {
                get {
                    if (index >= 0 && index < levelRow.Count)
                    {
                        return levelRow[index];
                    }
                    else
                    {
                        Debug.LogErrorFormat("index given in x axis is out of range");
 
                        return null;
                    }
                }
                set {
                    if (index >= 0 && index < levelRow.Count)
                    {
                        levelRow[index] = value;
                    }
                    else
                    {
                        Debug.LogErrorFormat("index given in x axis is out of range");
 
                        return;
                    }
                }
            }

---

The documentation for this class was generated from the following file:

• C:/Users/keith/Desktop/HomebrewFogofwar/Assets/AOSFogWar/Shadowcaster.cs