Browse Source

Added logo for Doxygen docs.

master
chrisgregan 11 years ago
parent
commit
3097883696
  1. 5
      Assets/Fungus/Docs.meta
  2. BIN
      Assets/Fungus/Docs/Logo.png
  3. 46
      Assets/Fungus/Docs/Logo.png.meta
  4. 10
      Assets/Fungus/Docs/_0_mainpage.md
  5. 4
      Assets/Fungus/Docs/_0_mainpage.md.meta
  6. 180
      Assets/Fungus/Scripts/GameController.cs
  7. 4
      Doxyfile

5
Assets/Fungus/Docs.meta

@ -0,0 +1,5 @@
fileFormatVersion: 2
guid: b2a1842979c244113ac31b4b37744a1d
folderAsset: yes
DefaultImporter:
userData:

BIN
Assets/Fungus/Docs/Logo.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

46
Assets/Fungus/Docs/Logo.png.meta

@ -0,0 +1,46 @@
fileFormatVersion: 2
guid: 0b3589cf3d9d642afb8cfd46c86a1762
TextureImporter:
serializedVersion: 2
mipmaps:
mipMapMode: 0
enableMipMap: 1
linearTexture: 0
correctGamma: 0
fadeOut: 0
borderMipMap: 0
mipMapFadeDistanceStart: 1
mipMapFadeDistanceEnd: 3
bumpmap:
convertToNormalMap: 0
externalNormalMap: 0
heightScale: .25
normalMapFilter: 0
isReadable: 0
grayScaleToAlpha: 0
generateCubemap: 0
seamlessCubemap: 0
textureFormat: -3
maxTextureSize: 2048
textureSettings:
filterMode: -1
aniso: -1
mipBias: -1
wrapMode: -1
nPOTScale: 1
lightmap: 0
compressionQuality: 50
spriteMode: 0
spriteExtrude: 1
spriteMeshType: 1
alignment: 0
spritePivot: {x: .5, y: .5}
spriteBorder: {x: 0, y: 0, z: 0, w: 0}
spritePixelsToUnits: 100
alphaIsTransparency: 0
textureType: -1
buildTargetSettings: []
spriteSheet:
sprites: []
spritePackingTag:
userData:

10
Assets/Fungus/Docs/_0_mainpage.md

@ -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
Assets/Fungus/Docs/_0_mainpage.md.meta

@ -0,0 +1,4 @@
fileFormatVersion: 2
guid: 57663d9287fa64d3db27a3f8ec4411f7
DefaultImporter:
userData:

180
Assets/Fungus/Scripts/GameController.cs

@ -152,24 +152,7 @@ namespace Fungus
CommandQueue commandQueue = Game.GetInstance().commandQueue; CommandQueue commandQueue = Game.GetInstance().commandQueue;
commandQueue.AddCommand(new Command.PanToPosition(targetPosition, targetRotation, targetSize, duration, wait)); 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. * 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. * This method returns immediately but it queues an asynchronous command for later execution.
@ -331,76 +314,6 @@ namespace Fungus
#endregion #endregion
#region State Methods #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. * Sets a globally accessible boolean variable.
* This method returns immediately but it queues an asynchronous command for later execution. * This method returns immediately but it queues an asynchronous command for later execution.
@ -714,6 +627,8 @@ namespace Fungus
#endregion #endregion
#region Obsolete Methods #region Obsolete Methods
/// @cond SHOW_OBSOLETE
// These methods are provided for backwards compatibility purposes and will be removed in a future release. // These methods are provided for backwards compatibility purposes and will be removed in a future release.
/** /**
@ -908,6 +823,95 @@ namespace Fungus
commandQueue.AddCommand(new Command.Choose(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 #endregion
} }
} }

4
Doxyfile

@ -38,7 +38,7 @@ PROJECT_NAME = Fungus
# could be handy for archiving the generated documentation or if some version # could be handy for archiving the generated documentation or if some version
# control system is used. # 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 # 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 # for a project that appears at the top of each page and should give viewer a
@ -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 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
# to the output directory. # 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 # 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 # into which the generated documentation will be written. If a relative path is

Loading…
Cancel
Save