Skip to content

Commit

Permalink
Added logo for Doxygen docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisgregan committed Jul 2, 2014
1 parent 22f75f4 commit 3097883
Show file tree
Hide file tree
Showing 7 changed files with 159 additions and 90 deletions.
5 changes: 5 additions & 0 deletions Assets/Fungus/Docs.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file added Assets/Fungus/Docs/Logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 46 additions & 0 deletions Assets/Fungus/Docs/Logo.png.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions Assets/Fungus/Docs/_0_mainpage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Main Page {#mainpage}
=========

Fungus is an open source library for Unity 3D for creating interactive fiction / visual novel style games. It has been designed to be easy to use and customize, and is a useful tool for people learning to make games in Unity 3D for the first time.

It was created and is maintained by Chris Gregan from [Snozbot.com](http://www.snozbot.com/).

- See the [GameController](@ref Fungus.GameController) class for a full list of supported commands.
- See http://fungus.snozbot.com for more information about the Fungus project.

4 changes: 4 additions & 0 deletions Assets/Fungus/Docs/_0_mainpage.md.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

180 changes: 92 additions & 88 deletions Assets/Fungus/Scripts/GameController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -152,24 +152,7 @@ public static void PanToPosition(Vector3 targetPosition, Quaternion targetRotati
CommandQueue commandQueue = Game.GetInstance().commandQueue;
commandQueue.AddCommand(new Command.PanToPosition(targetPosition, targetRotation, targetSize, duration, wait));
}

/**
* Pans the camera through a sequence of target Views over a period of time.
* Note: Does not support camera Rotation.
* The pan starts at the current camera position and performs a smooth pan through all Views in the list.
* Command execution blocks until the pan completes.
* If more control is required over the camera path then you should instead use an Animator component to precisely control the Camera path.
* This method returns immediately but it queues an asynchronous command for later execution.
* @param duration The length of time in seconds needed to complete the pan.
* @param targetViews A parameter list of views to visit during the pan.
*/
[Obsolete("Use a Camera animation instead.")]
public static void PanToPath(float duration, params View[] targetViews)
{
CommandQueue commandQueue = Game.GetInstance().commandQueue;
commandQueue.AddCommand(new Command.PanToPath(targetViews, duration));
}


/**
* Fades out the current camera View, and fades in again using the target View.
* This method returns immediately but it queues an asynchronous command for later execution.
Expand Down Expand Up @@ -331,76 +314,6 @@ public static void SetTimeout(float timeoutDuration, Action timeoutAction)
#endregion
#region State Methods

/**
* Sets a globally accessible integer value.
* This method returns immediately but it queues an asynchronous command for later execution.
* @param key The name of the value to set
* @param value The value to set
*/
[Obsolete("Use SetInteger() instead.")]
public static void SetValue(string key, int value)
{
SetInteger(key, value);
}

/**
* Sets a globally accessible integer value to 1.
* This method returns immediately but it queues an asynchronous command for later execution.
* @param key The name of the value to set
*/
[Obsolete("Use SetInteger() instead")]
public static void SetValue(string key)
{
SetInteger(key, 1);
}

/**
* Sets a globally accessible integer value to 0.
* This method returns immediately but it queues an asynchronous command for later execution.
* @param key The key of the value.
*/
[Obsolete("Use Variables.DeleteKey() instead")]
public static void ClearValue(string key)
{
Variables.SetInteger(key, 0);
Variables.SetFloat(key, 0);
Variables.SetBoolean(key, false);
}

/**
* Gets a globally accessible integer value.
* Returns zero if the value has not previously been set.
* @param key The name of the value
* @return The integer value for this key, or 0 if not previously set.
*/
[Obsolete("Use Variables.GetInteger() instead")]
public static int GetValue(string key)
{
return Variables.GetInteger(key);
}

/**
* Gets a globally accessible string value.
* @param key The name of the value
* @return The string value for this key, or the empty string if not previously set.
*/
[Obsolete("Use Variables.GetString() instead")]
public static string GetString(string key)
{
return Variables.GetString(key);
}

/**
* Checks if a value is non-zero.
* @param key The name of the value to check.
* @return Returns true if the value is not equal to zero.
*/
[Obsolete("Use Variables.GetInteger() or Variables.HasKey() instead")]
public static bool HasValue(string key)
{
return Variables.GetInteger(key) != 0;
}

/**
* Sets a globally accessible boolean variable.
* This method returns immediately but it queues an asynchronous command for later execution.
Expand Down Expand Up @@ -714,6 +627,8 @@ public static void PlaySound(AudioClip soundClip, float volume)
#endregion
#region Obsolete Methods

/// @cond SHOW_OBSOLETE

// These methods are provided for backwards compatibility purposes and will be removed in a future release.

/**
Expand Down Expand Up @@ -908,6 +823,95 @@ public static void Choose(string chooseText)
commandQueue.AddCommand(new Command.Choose(chooseText));
}

/**
* Pans the camera through a sequence of target Views over a period of time.
* Note: Does not support camera Rotation.
* The pan starts at the current camera position and performs a smooth pan through all Views in the list.
* Command execution blocks until the pan completes.
* If more control is required over the camera path then you should instead use an Animator component to precisely control the Camera path.
* This method returns immediately but it queues an asynchronous command for later execution.
* @param duration The length of time in seconds needed to complete the pan.
* @param targetViews A parameter list of views to visit during the pan.
*/
[Obsolete("Use a Camera animation instead.")]
public static void PanToPath(float duration, params View[] targetViews)
{
CommandQueue commandQueue = Game.GetInstance().commandQueue;
commandQueue.AddCommand(new Command.PanToPath(targetViews, duration));
}

/**
* Sets a globally accessible integer value.
* This method returns immediately but it queues an asynchronous command for later execution.
* @param key The name of the value to set
* @param value The value to set
*/
[Obsolete("Use SetInteger() instead.")]
public static void SetValue(string key, int value)
{
SetInteger(key, value);
}

/**
* Sets a globally accessible integer value to 1.
* This method returns immediately but it queues an asynchronous command for later execution.
* @param key The name of the value to set
*/
[Obsolete("Use SetInteger() instead")]
public static void SetValue(string key)
{
SetInteger(key, 1);
}

/**
* Sets a globally accessible integer value to 0.
* This method returns immediately but it queues an asynchronous command for later execution.
* @param key The key of the value.
*/
[Obsolete("Use Variables.DeleteKey() instead")]
public static void ClearValue(string key)
{
Variables.SetInteger(key, 0);
Variables.SetFloat(key, 0);
Variables.SetBoolean(key, false);
}

/**
* Gets a globally accessible integer value.
* Returns zero if the value has not previously been set.
* @param key The name of the value
* @return The integer value for this key, or 0 if not previously set.
*/
[Obsolete("Use Variables.GetInteger() instead")]
public static int GetValue(string key)
{
return Variables.GetInteger(key);
}

/**
* Gets a globally accessible string value.
* @param key The name of the value
* @return The string value for this key, or the empty string if not previously set.
*/
[Obsolete("Use Variables.GetString() instead")]
public static string GetString(string key)
{
return Variables.GetString(key);
}

/**
* Checks if a value is non-zero.
* @param key The name of the value to check.
* @return Returns true if the value is not equal to zero.
*/
[Obsolete("Use Variables.GetInteger() or Variables.HasKey() instead")]
public static bool HasValue(string key)
{
return Variables.GetInteger(key) != 0;
}

/// @endcond

#endregion
}
}
4 changes: 2 additions & 2 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PROJECT_NAME = Fungus
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER = 1.3.0
PROJECT_NUMBER = 1.4.0

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand All @@ -51,7 +51,7 @@ PROJECT_BRIEF = "An open source plugin for Unity 3D for creating graphi
# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
# to the output directory.

PROJECT_LOGO = /Users/Gregan/github/snozbot-fungus/Assets/Fungus/Sprites/FungusSmall.png
PROJECT_LOGO = /Users/Gregan/github/snozbot-fungus/Assets/Fungus/Docs/LogoMin.png

# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
Expand Down

0 comments on commit 3097883

Please sign in to comment.