Unify Community Wiki - User contributions [en]

Extensions

2012-08-14T07:52:57Z

AngryAnt: Fixed Path and Behave URLs.

{| align="right"
| __TOC__
|}

These extensions, or ''plugins'', allow you to add special features to your unity projects without the hassle of writing them yourself from the ground up.

There are two kinds of plugin: those containing only .NET code and those which contain binary code.

== .NET Plugins ==

.NET plugins are simply DLLs which have been built from Mono/.NET source code. When your project is built, they are merged with the compiled Mono code from your project's scripts. This means that you can use them with a Unity Indie licence as well as with Pro and in web players.

=== Cross-Platform Plugins ===

*[http://forum.unity3d.com/viewtopic.php?t=50843&start=0 Antares.dll] : a shareware part of the freeware [[Antares Project]]. Including '''Antares.Manager''' (Events message system), '''Antares.Async''' (asynchronous Asset Bundle loading and management classes) and some more helpers.

*[http://angryant.com/path Path] - Add pathfinding to your unity projects. Path implements the A* algorithm on NavMeshes, using multi-threading and several optimisation tricks to reduce calculation time.

*[http://angryant.com/behave Behave] - Via an editor extension and a runtime library, this project implements behaviour trees in unity for AI decision making. It features an easy to use drag-and-drop design interface and compiles designed behaviour trees are compiled to .NET plugins with a simple, but versatile runtime interface.

*[http://www.arges-systems.com/articles/35/unitysteer-steering-components-for-unity UnitySteer] - UnitySteer contains a series of classes that help your game characters or vehicles maneuver around a scene: how to accelerate and for how long, how to turn depending on vehicle characteristics, how to act when avoiding obstacles or neighbors, how to keep a distance from other agents, or many other cases. Some of these behaviors are quite simple, but they can easily be combined to generate more complex vehicles.

*[http://insidious.pt/#amplify Amplify] - Amplify is a Virtual Texturing extension for Unity Pro. It allows scene/level designers to use a huge amount of textures without worrying much about texture memory limits or streaming.

*[http://code.google.com/p/libnoise-dotnet/ Libnoise dotnet] - libnoise is used to generate coherent noise, a type of smoothly-changing noise. libnoise can generate Perlin noise, ridged multifractal noise, and other types of coherent-noise. Pure c# port including Improved perlin noise, simplex perlin noise, fractal filters (ridged, heterogeneous, multi, hybrid, sum, sin), all the libnoise utilities except Terragen renderer. More stuff [http://forum.unity3d.com/threads/114239-Libnoise-dotnet?p=759730 here]

=== Windows Only Plugins ===

*[http://speps.fr/xinputdotnet XInput.NET] - Add complete support for Xbox 360 Controller, all buttons, axes, trigges, buttons and vibration. API very similar to Microsoft.Xna.Framework.Input. Tested with Unity Indie 2.6.0.(If you get a missing DLL Error, then you may need to download the source files from his website, and rebuild the DLL's > I fixed this in the updated archive on my website, thanks for the tip)

== Native Code Plugins ==

Native code plugins can be written in many languages, including C and C++. A Unity Pro licence is required to use these plugins. This kind of plugin can only be used in the editor and in standalone builds. The web player is prevented from using them for security reasons.

The Unity documentation outlines how native code plugins are made [http://unity3d.com/support/documentation/Manual/Plugins.html here].

=== Cross-Platform Plugins ===

*[[QTPlayback]] - Play any QuickTime movie to a texture with synchronized sound.

*[[UniWii]] - Use Wiimotes as input devices.

=== Mac OS X Only Plugins ===

*[[AudioInput]] - Use AudioInput.Volume to provide microphone or other audio input to your Unity projects.

*[[HtmlTexturePlugin]] - Display an HTML page as a texture, for use on a mesh or in a GUI.

[[Category:.NET Plugins]]
[[Category:Native Code Plugins]]

Unity Explosivo!

2012-08-08T09:45:54Z

AngryAnt: Apparently relative URLs are no go. Replaced with new absolute ones.

== '''Welcome to Unity Explosivo!''' ==

'''Updates:'''
* Ok that's it! Explosivo! is over and '''we have winners!'''

Your winners are:

'''1st Place: ''Singularity Bomb'' - drJones''' with 42% of the vote!

'''Runner Up: ''Explosion Sculptures'' - metervara''' with 30% of the vote!

Everyone else, thanks for participating!

All in all, it looks like most everyone had a good time. Let's keep these contests going and do another soon! Thanks again for doing your part to keep this contest fun & honest!

* '''The contest entry period is over and all the entries look sweet!''' Thanks to all who entered!
* ''Page is now locked to allow for voting! :)''

'''Voting'''
* The voting criteria is simply this: '''Vote for the coolest & most imaginative explosion''' (whatever that means to you) and the entry with the most votes wins ''the grand prize!'' The entry with the next highest number of votes, takes the runner up prize! After that well, better luck next time! :)
* Let the Voting commence! Unity forum goers (goers eh? wink wink nudge nudge), place your vote here: http://forum.unity3d.com/viewtopic.php?t=6110

'''What is it?'''
* Simply, Unity users take a fixed amount of time to make cool explosions. Unity users can vote for '''the coolest & most imaginative explosion''' at the end and the explosion with the most votes wins!

Satisfy your primal need for blowing things up, in the warm and forgiving arms of Unity. This is a "for-fun" contest (meaning no out-and-out $$, but there is a grand prize incentive courtesy of OTEE!) :P

'''Rules:'''

* 0. Contest runs for 3 weeks from Saturday June 23rd, 2007 @ Midnight until '''the updated deadline of''' July 14th 2007 @ Midnight (Saturday night).

* 1. Free Reign! Anyone can enter (Unity trial, Indy, Pro, etc.)!

* 2. Voting will be done via the OTEE Unity forums here (special vote thread to be created near the contest end). [http://forum.unity3d.com/viewtopic.php?p=41137#41137 Unity Explosivo! announcement on OTEE forums]

* 3. Since this is an interactive community, the explosion needs to be user-triggered. Can be an elaborate trigger (wild & crazy) or just "press space to detonate".

* 4. All explosions need to be made public here on the wiki for the benefit of all.

* 5. Enter as many explosions as you like.

* 6. Should be a new explosion effect, made during the time of the contest. So if you are already working on a game called Explosion-A-Go-Go, try to resist the temptation to use your existing stuff eh? :)

* 7. Variety is strongly encouraged (how many ways can you express the idea of an "Explosion!") :)

'''Prizes:'''

*''1st Place'' - Winner will receive a free pass to Unite 2007 the Unity User conference, courtesy the guys at the generous and giving OTEE. The conference is October 10-12th at the San Francisco Film Centre, in (you guessed it) San Francisco California. You will need to arrange travel & lodging for the show, but it remains a $400 value! If the winner already has a pass to the show (cough cough Yoggy! cough), the prize will defer to the runner-up and so forth.

*''Runner up'' - The runner up winner will now receive a full license to Cheetah 3D, courtesy of the very generous Martin Wengenmayer! That's a $129 value folks! Check out the impressive artwork being created with this Unity friendly tool over at: http://www.cheetah3d.com! If the winner already has this prize, it will defer to the next runner-up and so forth.

*''All other entrants'' - will receive no money or prizes, but when you die, on your deathbed, you will receive total consciousness. So you'd have that going for you. Also, the satisfaction of standing out amongst your peers with all the fame and notoriety that goes with it (so nothing really!)

If enough entrants, will consider branching into various winner categories; most creative, most elaborate, etc.

And since yes, this is a "for-fun" contest, any zealots please try to stay in the rules and just have some fun will ya!

Ready? Set? '''''Blow!'''''

----

== '''Official Entries for Voting''' ==
----

== '''Independence Day Soldier''' ==
*YOU ARE SOLDIER! Can you make the biggest and bestest!
[[Image:fireworks.jpg]]
*''Links:'' [http://wiki.unity3d.com/contests/explosivo_web/Yoggy/Independence_Day_Soldier_mac.zip Independence Day Soldier Mac Standalone]

[http://wiki.unity3d.com/contests/explosivo_web/Yoggy/Independence_Day_Soldier_win.zip Independence Day Soldier Windows Standalone]

--[[User:Yoggy|yoggy]] 12:48, 3 July 2007 (MST)
----

== '''Explosion Sculptures''' ==
*Explosion sculpture generator with 17 tweakable parameters for maximum flexibility!
[[Image:Explosivo.jpg]]
*''Link:'' [http://wiki.unity3d.com/contests/explosivo_web/Metervara/explosivo.html L-System Explosion Web Player]

*[[Media:ExpSculpture.unitypackage.zip|ExpSculpture.unitypackage.zip]]

--[[User:Metervara|metervara]] 11:02 4 July 2007 (CEST)
----

== '''Kaboom''' ==
[[Image:daniels_explosivo_entry.jpg]]
*''Links:'' [http://wiki.unity3d.com/contests/explosivo_web/Daniel/explosivo.html Kaboom Web Player]

--[[User:Daniel|Daniel]] 10:52, 14 July 2007 (PDT)

== '''Leviathan Explosion''' ==
*I'm developing this for my game Phoenix Final (although all the code is totally separate for the purpose of this contest). I will be dynamically breaking the original spaceship mesh into random pieces at runtime.
[[Image:Leviathan_crash_2.jpg]]

''Links:''
*[http://wiki.unity3d.com/contests/explosivo_web/NCarter/explosivo.html Leviathan Explosion Web Player]
*[http://www.nether.org.uk/files/pf/leviathan_explosion_project.zip Unity Project]
--[[User:NCarter|NCarter]] 15:17, 5 July 2007 (PDT)
----

== '''Singularity Bomb''' ==
[[Image:Baddaboom.jpg]]
*''Links:'' [http://wiki.unity3d.com/contests/explosivo_web/DrJones/explosivo.html Singularity Bomb Web Player]
--[[User:DrJones|DrJones]] 06:02, 6 July 2007 (PDT)
----

== '''Six Bomb - Go forth and Multiply''' ==
[[Image:Sixbombcrop.jpg]]
*''Links: ''[http://wiki.unity3d.com/contests/explosivo_web/CBLarsen/explosivo.html Six Bomb Web Player]

[http://wiki.unity3d.com/contests/explosivo_web/CBLarsen/SixBomb_mac.zip Six Bomb Mac OS X Universal (7.8 MB)]

[http://wiki.unity3d.com/contests/explosivo_web/CBLarsen/SixBomb_win.zip Six Bomb Windows (3.9 MB)]

[http://proglet.com/software/SixBomb/project/SixBomb.zip SixBomb full project source (5.1MB)]

--[[User:cblarsen|cblarsen]] 17:01, 2 July 2007 (PDT)
----

== '''M-80 + Bathroom''' ==
*Hopefully this is self-explanatory ;) ... Standard WASD plus F to "fling" M-80s into the toilets etc... it's best if you stand still while throwing them or they're not going to go too far. The trash can is really hard to hit.
[[Image:picture_2.jpg]]
*''Links:'' [http://wiki.unity3d.com/contests/explosivo_web/Ethan/explosivo.html M-80 + Bathroom Web Player]

[http://wiki.unity3d.com/contests/explosivo_web/Ethan/M-80+Bathroom_UB.zip Mac Universal Standalone]

[http://www.antennatree.net/examples/M-80Project.zip M-80 + Bathroom Project]

--[[User:Ethan|Ethan]] 8:10, 7 July 2007 (EST)
----

== '''Kablooey!''' ==
*I wanted to blow up something big. unfinished but oh well :P Use A & D to activate explosions.
[[Image:petes_explosivo_entry.jpg]]
*''Links:'' [http://wiki.unity3d.com/contests/explosivo_web/Pete/explosivo.html Kablooey! Web Player]
--[[User:Pete|Pete]] 8:10, 7 July 2007 (EST)
----

== '''Explosives''' ==
*Hi, my entry, the instructions are in the HTML itself, master the plasma! is the best!
[[Image:omars_explosivo_entry.jpg]]
*''Links:'' [http://wiki.unity3d.com/contests/explosivo_web/Omar/explosivo.html Explosives Web Player]
--[[User:Omar Rojo|Omar Rojo]] 06:38, 12 July 2007 (PDT)
----

== '''Bomb the Barn''' ==
*Title is topic. Right-click and choose Go Fullscreen for the most effect. Happy bombing...
[[Image:BtB.jpg]]
*''Links:'' [http://wiki.unity3d.com/contests/explosivo_web/Timo/explosivo.html Bomb the Barn Web Player]

[http://wiki.unity3d.com/contests/explosivo_web/Timo/BombTheBarn_MacUni.app.zip Bomb the Barn Mac Universal Standalone]

[http://wiki.unity3d.com/contests/explosivo_web/Timo/BombTheBarn_Win.zip Bomb the Barn Windows Standalone]

[[Media:BombTheBarn_projectfolder.zip|Unity Project Folder]]

--[[User:T|Timo]] 14 July 2007

----

== '''Non-Voting Entries''' ==
Entries that, for whatever reason, were pulled from the contest.
----
----
== '''Direct Action Training''' ==
* ''The author requested that this entry be pulled from the contest'' :(
* Booom Booom !
[[Image:targos_explosivo_entry.jpg]]
*''Links [http://wiki.unity3d.com/contests/explosivo_web/Targos/explosivo.html Direct Action Training Web Player]''
Link is to pre-deadline version.

--[[User:Targos|Targos]] 05:17, 13 July 2007 (PDT)
----

Main Page

2012-08-07T12:55:49Z

AngryAnt: Removed hosting donations link.

{| style="width: 100%;" cellspacing="5" cellpadding="0"
| colspan="3" | <div style="width: 60%; margin: auto; background: #FFFFF; border: 1px solid #131313"><div style="background: #C8C4BD; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center;">Welcome to the UnifyWiki<br />The UnifyWiki is part of the [http://unifycommunity.com Unify Community] and is a place to find and share [http://unity3d.com/ Unity] knowledge. <br /></div></div>

|-

{| style="width: 100%; margin: auto; text-align: center; border: none;"
| [[File:Splash.jpg|link=Main_Page]]
|}

{| style="width: 100%;" cellspacing="5" cellpadding="0"

| colspan="2" style="background: #FFFFFF; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #787878; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Wiki News</div>

<div style="padding-left: 1em;">
* Unity Tech has taken over hosting and day to day maintenance of the community wiki. Aside from that, everything should be business as usual. We would like to thank the previous maintainers of the wiki for their amazing dedication and hard work. - ''AngryAnt''

* <span style="color: #F00;">'''IMPORTANT:'''</span> syntax highlighting now uses different tags. Where you previously could write '''<nowiki><csharp>, <javascript></nowiki>''' or '''<nowiki><boo></nowiki>''', you now have to write '''<nowiki><syntaxhighlight lang="csharp"></nowiki>'''. The names used for each language have not changed. You can learn more about the syntax highlighter's features [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi here].

* The spam filter has been tightened a bit. If the wiki refuses an edit because it says it's spam and you don't know why, please contact an administrator.

* It is possible to upload '''zip''' archives to the Unify wiki. We encourage you to provide a zipped copy of your script or shader when adding a new article, as this will help to avoid problems with various web browsers where garbage characters are introduced into text which is copied and pasted from these pages.

* The maximum file size for any uploaded file is now '''512KB''', and this includes images as well as zip files. Unfortunately, '''unityPackage''' files are not directly supported at present, as we have been unable to make MediaWiki recognise the unusually long filename extension. If you wish to add a unityPackage to the wiki, please zip it first.
</div>

| style="width: 40%; background: #FFFFFF; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #787878; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Notes</div>
<div style="padding-left: 1em;">
Special thanks to [[User:Aarku|Aarku]], [[User:Dho|Dho]], [[User:NCarter|NCarter]], [[User:KeliHlodversson|Freyr]], [[User:Outcast|Outcast]] and others.

We're currently working on [[Special:Statistics|{{NUMBEROFARTICLES}}]] [[Special:Allpages|articles]] about Unity and related subjects.

Please see the [[:Talk:Main Page|discussion page]] of the main page for current goals and status. '''Please read these [[:Help:Contents|general guidelines]] before you begin editing.'''

To create a new page, add a link to an existing page, then follow the link and edit the new page. It's a good idea to copy the layout from an existing page initially, to ensure that your contribution matches the conventions used in our existing articles. If you just want to experiment, you can do so in the [[:Unify Community Wiki:Sandbox|sandbox]].

</div>
|-
| style="width: 33%; background: #FFFFFF; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #787878; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Main Sections</div>
<div style="padding-left: 1em;">
* [[Extensions]] - Further extend the functionality of Unity with .NET plugins (suitable for any Unity licence) and native code plugins (for Pro users only).

* [[Particle Library]] - Pre-configured particle systems for use in your own projects.

* [[Programming]] - Unity programming resources

* [[Scripts]] - Everything from general purpose effects to debugging.

* [[Shaders]] - Specialised shaders to make your materials more refined.

* [[Wizards]] - Scripts to extend the Unity editor.
</div>
| style="width: 33%; background: #FFFFFF; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #787878; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Extras</div>
<div style="padding-left: 1em;">

* [[Tips|Tips, Tools & Tricks]] - Tips and tricks for editing Unity content and supported tools & applications.

* [[Tutorials]] - Tutorials for all things Unity. These are usually of larger scope than [[Tips|Tips and Tricks]].

* [[Contests]] - User contests for fun and fame!

* [[Unity Projects]] - Community development efforts to extend Unity.

* [[IRC|IRC Chatroom]] - Your portal to the Unity community.

* [[Unify Community Wiki:Community Portal|Community Portal]] - Your portal to the Unity community.
</div>
| style="width: 33%; background: #FFFFFF; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #787878; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Support</div>
<div style="padding-left: 1em;">
*Please see [http://meta.wikipedia.org/wiki/MediaWiki_i18n documentation on customizing the interface] and the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide MediaWiki User's Guide] for usage and configuration help.
</div>

Main Page

2012-08-07T12:49:39Z

AngryAnt: Thanks as well :)

{| style="width: 100%;" cellspacing="5" cellpadding="0"
| colspan="3" | <div style="width: 60%; margin: auto; background: #FFFFF; border: 1px solid #131313"><div style="background: #C8C4BD; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center;">Welcome to the UnifyWiki<br />The UnifyWiki is part of the [http://unifycommunity.com Unify Community] and is a place to find and share [http://unity3d.com/ Unity] knowledge. <br /></div></div>

|-

{| style="width: 100%; margin: auto; text-align: center; border: none;"
| [[File:Splash.jpg|link=Main_Page]]
|}

{| style="width: 100%;" cellspacing="5" cellpadding="0"

| colspan="2" style="background: #FFFFFF; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #787878; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Wiki News</div>

<div style="padding-left: 1em;">
* Unity Tech has taken over hosting and day to day maintenance of the community wiki. Aside from that, everything should be business as usual. We would like to thank the previous maintainers of the wiki for their amazing dedication and hard work. - ''AngryAnt''

* <span style="color: #F00;">'''IMPORTANT:'''</span> syntax highlighting now uses different tags. Where you previously could write '''<nowiki><csharp>, <javascript></nowiki>''' or '''<nowiki><boo></nowiki>''', you now have to write '''<nowiki><syntaxhighlight lang="csharp"></nowiki>'''. The names used for each language have not changed. You can learn more about the syntax highlighter's features [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi here].

* The spam filter has been tightened a bit. If the wiki refuses an edit because it says it's spam and you don't know why, please contact an administrator.

* It is possible to upload '''zip''' archives to the Unify wiki. We encourage you to provide a zipped copy of your script or shader when adding a new article, as this will help to avoid problems with various web browsers where garbage characters are introduced into text which is copied and pasted from these pages.

* The maximum file size for any uploaded file is now '''512KB''', and this includes images as well as zip files. Unfortunately, '''unityPackage''' files are not directly supported at present, as we have been unable to make MediaWiki recognise the unusually long filename extension. If you wish to add a unityPackage to the wiki, please zip it first.
</div>

| style="width: 40%; background: #FFFFFF; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #787878; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Notes</div>
<div style="padding-left: 1em;">
Special thanks to [[User:Aarku|Aarku]], [[User:Dho|Dho]], [[User:NCarter|NCarter]], [[User:KeliHlodversson|Freyr]], [[User:Outcast|Outcast]] and others.

We're currently working on [[Special:Statistics|{{NUMBEROFARTICLES}}]] [[Special:Allpages|articles]] about Unity and related subjects.

Please see the [[:Talk:Main Page|discussion page]] of the main page for current goals and status. '''Please read these [[:Help:Contents|general guidelines]] before you begin editing.'''

To create a new page, add a link to an existing page, then follow the link and edit the new page. It's a good idea to copy the layout from an existing page initially, to ensure that your contribution matches the conventions used in our existing articles. If you just want to experiment, you can do so in the [[:Unify Community Wiki:Sandbox|sandbox]].

</div>
|-
| style="width: 33%; background: #FFFFFF; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #787878; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Main Sections</div>
<div style="padding-left: 1em;">
* [[Extensions]] - Further extend the functionality of Unity with .NET plugins (suitable for any Unity licence) and native code plugins (for Pro users only).

* [[Particle Library]] - Pre-configured particle systems for use in your own projects.

* [[Programming]] - Unity programming resources

* [[Scripts]] - Everything from general purpose effects to debugging.

* [[Shaders]] - Specialised shaders to make your materials more refined.

* [[Wizards]] - Scripts to extend the Unity editor.
</div>
| style="width: 33%; background: #FFFFFF; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #787878; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Extras</div>
<div style="padding-left: 1em;">

* [[Tips|Tips, Tools & Tricks]] - Tips and tricks for editing Unity content and supported tools & applications.

* [[Tutorials]] - Tutorials for all things Unity. These are usually of larger scope than [[Tips|Tips and Tricks]].

* [[Contests]] - User contests for fun and fame!

* [[Unity Projects]] - Community development efforts to extend Unity.

* [[IRC|IRC Chatroom]] - Your portal to the Unity community.

* [[Unify Community Wiki:Community Portal|Community Portal]] - Your portal to the Unity community.
</div>
| style="width: 33%; background: #FFFFFF; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #787878; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Support Unify Wiki</div>
<div style="padding-left: 1em;">

*[http://www.dreamhost.com/donate.cgi?id=9231 Donate towards hosting of this wiki!]

*[http://www.printfection.com/unifycommunity/ Unify Community Merch]

*Please see [http://meta.wikipedia.org/wiki/MediaWiki_i18n documentation on customizing the interface] and the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide MediaWiki User's Guide] for usage and configuration help.

</div>

Main Page

2012-08-07T12:45:21Z

AngryAnt: Less elaborate.

{| style="width: 100%;" cellspacing="5" cellpadding="0"
| colspan="3" | <div style="width: 60%; margin: auto; background: #FFFFF; border: 1px solid #131313"><div style="background: #C8C4BD; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center;">Welcome to the UnifyWiki<br />The UnifyWiki is part of the [http://unifycommunity.com Unify Community] and is a place to find and share [http://unity3d.com/ Unity] knowledge. <br /></div></div>

|-

{| style="width: 100%; margin: auto; text-align: center; border: none;"
| [[File:Splash.jpg|link=Main_Page]]
|}

{| style="width: 100%;" cellspacing="5" cellpadding="0"

| colspan="2" style="background: #FFFFFF; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #787878; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Wiki News</div>

<div style="padding-left: 1em;">
* Unity Tech has taken over hosting and day to day maintenance of the community wiki. Aside from that, everything should be business as usual. - ''AngryAnt''

* <span style="color: #F00;">'''IMPORTANT:'''</span> syntax highlighting now uses different tags. Where you previously could write '''<nowiki><csharp>, <javascript></nowiki>''' or '''<nowiki><boo></nowiki>''', you now have to write '''<nowiki><syntaxhighlight lang="csharp"></nowiki>'''. The names used for each language have not changed. You can learn more about the syntax highlighter's features [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi here].

* The spam filter has been tightened a bit. If the wiki refuses an edit because it says it's spam and you don't know why, please contact an administrator.

* It is possible to upload '''zip''' archives to the Unify wiki. We encourage you to provide a zipped copy of your script or shader when adding a new article, as this will help to avoid problems with various web browsers where garbage characters are introduced into text which is copied and pasted from these pages.

* The maximum file size for any uploaded file is now '''512KB''', and this includes images as well as zip files. Unfortunately, '''unityPackage''' files are not directly supported at present, as we have been unable to make MediaWiki recognise the unusually long filename extension. If you wish to add a unityPackage to the wiki, please zip it first.
</div>

| style="width: 40%; background: #FFFFFF; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #787878; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Notes</div>
<div style="padding-left: 1em;">
Special thanks to [[User:Aarku|Aarku]], [[User:Dho|Dho]], [[User:NCarter|NCarter]], [[User:KeliHlodversson|Freyr]], [[User:Outcast|Outcast]] and others.

We're currently working on [[Special:Statistics|{{NUMBEROFARTICLES}}]] [[Special:Allpages|articles]] about Unity and related subjects.

Please see the [[:Talk:Main Page|discussion page]] of the main page for current goals and status. '''Please read these [[:Help:Contents|general guidelines]] before you begin editing.'''

To create a new page, add a link to an existing page, then follow the link and edit the new page. It's a good idea to copy the layout from an existing page initially, to ensure that your contribution matches the conventions used in our existing articles. If you just want to experiment, you can do so in the [[:Unify Community Wiki:Sandbox|sandbox]].

</div>
|-
| style="width: 33%; background: #FFFFFF; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #787878; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Main Sections</div>
<div style="padding-left: 1em;">
* [[Extensions]] - Further extend the functionality of Unity with .NET plugins (suitable for any Unity licence) and native code plugins (for Pro users only).

* [[Particle Library]] - Pre-configured particle systems for use in your own projects.

* [[Programming]] - Unity programming resources

* [[Scripts]] - Everything from general purpose effects to debugging.

* [[Shaders]] - Specialised shaders to make your materials more refined.

* [[Wizards]] - Scripts to extend the Unity editor.
</div>
| style="width: 33%; background: #FFFFFF; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #787878; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Extras</div>
<div style="padding-left: 1em;">

* [[Tips|Tips, Tools & Tricks]] - Tips and tricks for editing Unity content and supported tools & applications.

* [[Tutorials]] - Tutorials for all things Unity. These are usually of larger scope than [[Tips|Tips and Tricks]].

* [[Contests]] - User contests for fun and fame!

* [[Unity Projects]] - Community development efforts to extend Unity.

* [[IRC|IRC Chatroom]] - Your portal to the Unity community.

* [[Unify Community Wiki:Community Portal|Community Portal]] - Your portal to the Unity community.
</div>
| style="width: 33%; background: #FFFFFF; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #787878; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Support Unify Wiki</div>
<div style="padding-left: 1em;">

*[http://www.dreamhost.com/donate.cgi?id=9231 Donate towards hosting of this wiki!]

*[http://www.printfection.com/unifycommunity/ Unify Community Merch]

*Please see [http://meta.wikipedia.org/wiki/MediaWiki_i18n documentation on customizing the interface] and the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide MediaWiki User's Guide] for usage and configuration help.

</div>

Main Page

2012-08-07T12:38:28Z

AngryAnt: Added news about wiki administration.

{| style="width: 100%;" cellspacing="5" cellpadding="0"
| colspan="3" | <div style="width: 60%; margin: auto; background: #FFFFF; border: 1px solid #131313"><div style="background: #C8C4BD; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center;">Welcome to the UnifyWiki<br />The UnifyWiki is part of the [http://unifycommunity.com Unify Community] and is a place to find and share [http://unity3d.com/ Unity] knowledge. <br /></div></div>

|-

{| style="width: 100%; margin: auto; text-align: center; border: none;"
| [[File:Splash.jpg|link=Main_Page]]
|}

{| style="width: 100%;" cellspacing="5" cellpadding="0"

| colspan="2" style="background: #FFFFFF; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #787878; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Wiki News</div>

<div style="padding-left: 1em;">
* Due to frequent hacking and a fall in the number of people involved in maintaining the wiki, Unity Technologies has taken over hosting and day to day maintenance of the community wiki. We have no plans on changing anything other than the uptime of the site. All content on the wiki remains public domain and we encourage everyone to contribute as per usual. - ''AngryAnt''

* <span style="color: #F00;">'''IMPORTANT:'''</span> syntax highlighting now uses different tags. Where you previously could write '''<nowiki><csharp>, <javascript></nowiki>''' or '''<nowiki><boo></nowiki>''', you now have to write '''<nowiki><syntaxhighlight lang="csharp"></nowiki>'''. The names used for each language have not changed. You can learn more about the syntax highlighter's features [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi here].

* The spam filter has been tightened a bit. If the wiki refuses an edit because it says it's spam and you don't know why, please contact an administrator.

* It is possible to upload '''zip''' archives to the Unify wiki. We encourage you to provide a zipped copy of your script or shader when adding a new article, as this will help to avoid problems with various web browsers where garbage characters are introduced into text which is copied and pasted from these pages.

* The maximum file size for any uploaded file is now '''512KB''', and this includes images as well as zip files. Unfortunately, '''unityPackage''' files are not directly supported at present, as we have been unable to make MediaWiki recognise the unusually long filename extension. If you wish to add a unityPackage to the wiki, please zip it first.
</div>

| style="width: 40%; background: #FFFFFF; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #787878; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Notes</div>
<div style="padding-left: 1em;">
Special thanks to [[User:Aarku|Aarku]], [[User:Dho|Dho]], [[User:NCarter|NCarter]], [[User:KeliHlodversson|Freyr]], [[User:Outcast|Outcast]] and others.

We're currently working on [[Special:Statistics|{{NUMBEROFARTICLES}}]] [[Special:Allpages|articles]] about Unity and related subjects.

Please see the [[:Talk:Main Page|discussion page]] of the main page for current goals and status. '''Please read these [[:Help:Contents|general guidelines]] before you begin editing.'''

To create a new page, add a link to an existing page, then follow the link and edit the new page. It's a good idea to copy the layout from an existing page initially, to ensure that your contribution matches the conventions used in our existing articles. If you just want to experiment, you can do so in the [[:Unify Community Wiki:Sandbox|sandbox]].

</div>
|-
| style="width: 33%; background: #FFFFFF; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #787878; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Main Sections</div>
<div style="padding-left: 1em;">
* [[Extensions]] - Further extend the functionality of Unity with .NET plugins (suitable for any Unity licence) and native code plugins (for Pro users only).

* [[Particle Library]] - Pre-configured particle systems for use in your own projects.

* [[Programming]] - Unity programming resources

* [[Scripts]] - Everything from general purpose effects to debugging.

* [[Shaders]] - Specialised shaders to make your materials more refined.

* [[Wizards]] - Scripts to extend the Unity editor.
</div>
| style="width: 33%; background: #FFFFFF; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #787878; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Extras</div>
<div style="padding-left: 1em;">

* [[Tips|Tips, Tools & Tricks]] - Tips and tricks for editing Unity content and supported tools & applications.

* [[Tutorials]] - Tutorials for all things Unity. These are usually of larger scope than [[Tips|Tips and Tricks]].

* [[Contests]] - User contests for fun and fame!

* [[Unity Projects]] - Community development efforts to extend Unity.

* [[IRC|IRC Chatroom]] - Your portal to the Unity community.

* [[Unify Community Wiki:Community Portal|Community Portal]] - Your portal to the Unity community.
</div>
| style="width: 33%; background: #FFFFFF; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #787878; border: 1px solid #131313; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Support Unify Wiki</div>
<div style="padding-left: 1em;">

*[http://www.dreamhost.com/donate.cgi?id=9231 Donate towards hosting of this wiki!]

*[http://www.printfection.com/unifycommunity/ Unify Community Merch]

*Please see [http://meta.wikipedia.org/wiki/MediaWiki_i18n documentation on customizing the interface] and the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide MediaWiki User's Guide] for usage and configuration help.

</div>

Singleton

2010-05-06T07:48:53Z

AngryAnt: /* Mapping static methods to singleton methods */

By AngryAnt.
[[Category: Concepts]]
[[Category: Controller]]
[[Category: Design Patterns]]
[[Category: MonoBehaviour]]
[[Category: Programming]]
[[Category: Scripting]]
[[Category: C Sharp]]

== Description ==

People have recently asked about singleton creation quite often in [[IRC|the IRC channel]] so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton ()
{
if (instance != null)
{
Debug.LogError ("Cannot have two instances of singleton. Self destruction in 3...");
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if (instance == null)
{
new MySingleton ();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public static MySingleton Instance
{
get
{
if (instance == null)
{
instance = new GameObject ("MySingleton").AddComponent<MySingleton> ();
}

return instance;
}
}

public void OnApplicationQuit ()
{
instance = null;
}
}</csharp>

== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score += 5;
Debug.Log ("Score is now: " + MySingleton.Instance.Score);</csharp>

And the singleton class:
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton ()
{
if (instance != null)
{
Debug.LogError ("Cannot have two instances of singleton. Self destruction in 3...");
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if (instance == null)
{
new MySingleton ();
}

return instance;
}
}

private int score;

public int Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>

== Time tracking and GameOver broadcasting singleton ==
This singleton works similarly to the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the tracked timer reaches zero or lower. The timer is set just like the score is in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register (gameObject);
MySingleton.Instance.Unregister (gameObject);</csharp>
Registering and unregistering would likely make sense to do in Awake and OnDisable of a script attached to the GameObjects needing it.
And the singleton class:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton ()
{
if (instance != null)
{
Debug.LogError ("Cannot have two instances of singleton. Self destruction in 3...");
return;
}

instance = this;
Init ();
}

public static MySingleton Instance
{
get
{
if (instance == null)
{
new MySingleton ();
}

return instance;
}
}

private int timer;
private ArrayList listeners;

private void Init ()
{
listeners = new ArrayList ();
}

public int Timer
{
get
{
return timer;
}
set
{
timer = value;
if (timer <= 0)
{
foreach (GameObject listener in listeners)
{
listener.SendMessage ("GameOver");
}
}
}
}

public GameObject RegisterListener (GameObject listener)
{
listeners.Add (listener);

return listener;
}

public bool UnregisterListener (GameObject listener)
{
if (!listeners.Contains (listener))
{
return false;
}

listeners.Remove (listener);
}
}</csharp>

== Mapping static methods to singleton methods ==
Having to go through the Instance property for every function of the singleton gets old fast. Really the user most of the time does not need to know that he is dealing with a singleton, so this:
<csharp>MySingleton.Instance.Register (gameObject);
MySingleton.Instance.Unregister (gameObject);</csharp>
should for simplicity be remapped to this:
<csharp>MySingleton.Register (gameObject);
MySingleton.Unregister (gameObject);</csharp>
To make the above true, simply make your methods static and have *them* take the pain of going through the Instance property - like so:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton ()
{
if (instance != null)
{
Debug.LogError ("Cannot have two instances of singleton. Self destruction in 3...");
return;
}

instance = this;
Init ();
}

private static MySingleton Instance
{
get
{
if (instance == null)
{
new MySingleton ();
}

return instance;
}
}

private int timer;
private ArrayList listeners;

private void Init ()
{
listeners = new ArrayList ();
}

public static int Timer
{
get
{
return Instance.timer;
}
set
{
Instance.timer = value;
if (value <= 0)
{
foreach (GameObject listener in Instance.listeners)
{
listener.SendMessage ("GameOver");
}
}
}
}

public static GameObject RegisterListener (GameObject listener)
{
Instance.listeners.Add (listener);

return listener;
}

public static bool UnregisterListener (GameObject listener)
{
if (!Instance.listeners.Contains (listener))
{
return false;
}

Instance.listeners.Remove (listener);
}
}</csharp>
Voilá! Less cruft in the world! Everyone rejoice!

Singleton

2010-05-04T13:08:16Z

AngryAnt:

By AngryAnt.
[[Category: Concepts]]
[[Category: Controller]]
[[Category: Design Patterns]]
[[Category: MonoBehaviour]]
[[Category: Programming]]
[[Category: Scripting]]
[[Category: C Sharp]]

== Description ==

People have recently asked about singleton creation quite often in [[IRC|the IRC channel]] so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton ()
{
if (instance != null)
{
Debug.LogError ("Cannot have two instances of singleton. Self destruction in 3...");
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if (instance == null)
{
new MySingleton ();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public static MySingleton Instance
{
get
{
if (instance == null)
{
instance = new GameObject ("MySingleton").AddComponent<MySingleton> ();
}

return instance;
}
}

public void OnApplicationQuit ()
{
instance = null;
}
}</csharp>

== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score += 5;
Debug.Log ("Score is now: " + MySingleton.Instance.Score);</csharp>

And the singleton class:
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton ()
{
if (instance != null)
{
Debug.LogError ("Cannot have two instances of singleton. Self destruction in 3...");
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if (instance == null)
{
new MySingleton ();
}

return instance;
}
}

private int score;

public int Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>

== Time tracking and GameOver broadcasting singleton ==
This singleton works similarly to the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the tracked timer reaches zero or lower. The timer is set just like the score is in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register (gameObject);
MySingleton.Instance.Unregister (gameObject);</csharp>
Registering and unregistering would likely make sense to do in Awake and OnDisable of a script attached to the GameObjects needing it.
And the singleton class:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton ()
{
if (instance != null)
{
Debug.LogError ("Cannot have two instances of singleton. Self destruction in 3...");
return;
}

instance = this;
Init ();
}

public static MySingleton Instance
{
get
{
if (instance == null)
{
new MySingleton ();
}

return instance;
}
}

private int timer;
private ArrayList listeners;

private void Init ()
{
listeners = new ArrayList ();
}

public int Timer
{
get
{
return timer;
}
set
{
timer = value;
if (timer <= 0)
{
foreach (GameObject listener in listeners)
{
listener.SendMessage ("GameOver");
}
}
}
}

public GameObject RegisterListener (GameObject listener)
{
listeners.Add (listener);

return listener;
}

public bool UnregisterListener (GameObject listener)
{
if (!listeners.Contains (listener))
{
return false;
}

listeners.Remove (listener);
}
}</csharp>

== Mapping static methods to singleton methods ==
Having to go through the Instance property for every function of the singleton gets old fast. Really the user most of the time does not need to know that he is dealing with a singleton, so this:
<csharp>MySingleton.Instance.Register (gameObject);
MySingleton.Instance.Unregister (gameObject);</csharp>
is really quite simple when it should just be this:
<csharp>MySingleton.Register (gameObject);
MySingleton.Unregister (gameObject);</csharp>
To make the above true, simply make your methods static and have *them* take the pain of going through the Instance property - like so:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton ()
{
if (instance != null)
{
Debug.LogError ("Cannot have two instances of singleton. Self destruction in 3...");
return;
}

instance = this;
Init ();
}

private static MySingleton Instance
{
get
{
if (instance == null)
{
new MySingleton ();
}

return instance;
}
}

private int timer;
private ArrayList listeners;

private void Init ()
{
listeners = new ArrayList ();
}

public static int Timer
{
get
{
return Instance.timer;
}
set
{
Instance.timer = value;
if (value <= 0)
{
foreach (GameObject listener in Instance.listeners)
{
listener.SendMessage ("GameOver");
}
}
}
}

public static GameObject RegisterListener (GameObject listener)
{
Instance.listeners.Add (listener);

return listener;
}

public static bool UnregisterListener (GameObject listener)
{
if (!Instance.listeners.Contains (listener))
{
return false;
}

Instance.listeners.Remove (listener);
}
}</csharp>
Voilá! Less cruft in the world! Everyone rejoice!

Singleton

2010-05-04T13:03:23Z

AngryAnt:

By AngryAnt.
[[Category: Concepts]]
[[Category: Controller]]
[[Category: Design Patterns]]
[[Category: MonoBehaviour]]
[[Category: Programming]]
[[Category: Scripting]]
[[Category: C Sharp]]

== Description ==

People have recently asked about singleton creation quite often in [[IRC|the IRC channel]] so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

Note, however that for the component-based singleton (the second implementation), you shouldn't attempt to access the instance earlier than in Start of the calling component.

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton ()
{
if (instance != null)
{
Debug.LogError ("Cannot have two instances of singleton. Self destruction in 3...");
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if (instance == null)
{
new MySingleton ();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public static MySingleton Instance
{
get
{
if (instance == null)
{
instance = new GameObject ("MySingleton").AddComponent<MySingleton> ();
}

return instance;
}
}

public void OnApplicationQuit ()
{
instance = null;
}
}</csharp>

== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score += 5;
Debug.Log ("Score is now: " + MySingleton.Instance.Score);</csharp>

And the singleton class:
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton ()
{
if (instance != null)
{
Debug.LogError ("Cannot have two instances of singleton. Self destruction in 3...");
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if (instance == null)
{
new MySingleton ();
}

return instance;
}
}

private int score;

public int Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>

== Time tracking and GameOver broadcasting singleton ==
This singleton works similarly to the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the tracked timer reaches zero or lower. The timer is set just like the score is in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register (gameObject);
MySingleton.Instance.Unregister (gameObject);</csharp>
Registering and unregistering would likely make sense to do in Awake and OnDisable of a script attached to the GameObjects needing it.
And the singleton class:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton ()
{
if (instance != null)
{
Debug.LogError ("Cannot have two instances of singleton. Self destruction in 3...");
return;
}

instance = this;
Init ();
}

public static MySingleton Instance
{
get
{
if (instance == null)
{
new MySingleton ();
}

return instance;
}
}

private int timer;
private ArrayList listeners;

private void Init ()
{
listeners = new ArrayList ();
}

public int Timer
{
get
{
return timer;
}
set
{
timer = value;
if (timer <= 0)
{
foreach (GameObject listener in listeners)
{
listener.SendMessage ("GameOver");
}
}
}
}

public GameObject RegisterListener (GameObject listener)
{
listeners.Add (listener);

return listener;
}

public bool UnregisterListener (GameObject listener)
{
if (!listeners.Contains (listener))
{
return false;
}

listeners.Remove (listener);
}
}</csharp>

== Mapping static methods to singleton methods ==
Having to go through the Instance property for every function of the singleton gets old fast. Really the user most of the time does not need to know that he is dealing with a singleton, so this:
<csharp>MySingleton.Instance.Register (gameObject);
MySingleton.Instance.Unregister (gameObject);</csharp>
is really quite simple when it should just be this:
<csharp>MySingleton.Register (gameObject);
MySingleton.Unregister (gameObject);</csharp>
To make the above true, simply make your methods static and have *them* take the pain of going through the Instance property - like so:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton ()
{
if (instance != null)
{
Debug.LogError ("Cannot have two instances of singleton. Self destruction in 3...");
return;
}

instance = this;
Init ();
}

private static MySingleton Instance
{
get
{
if (instance == null)
{
new MySingleton ();
}

return instance;
}
}

private int timer;
private ArrayList listeners;

private void Init ()
{
listeners = new ArrayList ();
}

public static int Timer
{
get
{
return Instance.timer;
}
set
{
Instance.timer = value;
if (value <= 0)
{
foreach (GameObject listener in Instance.listeners)
{
listener.SendMessage ("GameOver");
}
}
}
}

public static GameObject RegisterListener (GameObject listener)
{
Instance.listeners.Add (listener);

return listener;
}

public static bool UnregisterListener (GameObject listener)
{
if (!Instance.listeners.Contains (listener))
{
return false;
}

Instance.listeners.Remove (listener);
}
}</csharp>
Voilá! Less cruft in the world! Everyone rejoice!

Singleton

2010-05-04T12:11:11Z

AngryAnt:

By AngryAnt.
[[Category: Concepts]]
[[Category: Controller]]
[[Category: Design Patterns]]
[[Category: MonoBehaviour]]
[[Category: Programming]]
[[Category: Scripting]]
[[Category: C Sharp]]

== Description ==

People have recently asked about singleton creation quite often in [[IRC|the IRC channel]] so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

Note, however that for the component-based singleton (the second implementation), you shouldn't attempt to access the instance earlier than in Start of the calling component.

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton ()
{
if (instance != null)
{
Debug.LogError ("Cannot have two instances of singleton. Self destruction in 3...");
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if (instance == null)
{
new MySingleton ();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public static MySingleton Instance
{
get
{
GameObject go;

if (instance == null)
{
go = new GameObject ("MySingleton");
instance = (MySingleton)go.AddComponent (typeof (MySingleton));
}

return instance;
}
}

public void OnApplicationQuit ()
{
instance = null;
}
}</csharp>

== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score += 5;
Debug.Log ("Score is now: " + MySingleton.Instance.Score);</csharp>

And the singleton class:
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton ()
{
if (instance != null)
{
Debug.LogError ("Cannot have two instances of singleton. Self destruction in 3...");
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if (instance == null)
{
new MySingleton ();
}

return instance;
}
}

private int score;

public int Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>

== Time tracking and GameOver broadcasting singleton ==
This singleton works similarly to the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the tracked timer reaches zero or lower. The timer is set just like the score is in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register (gameObject);
MySingleton.Instance.Unregister (gameObject);</csharp>
Registering and unregistering would likely make sense to do in Awake and OnDisable of a script attached to the GameObjects needing it.
And the singleton class:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton ()
{
if (instance != null)
{
Debug.LogError ("Cannot have two instances of singleton. Self destruction in 3...");
return;
}

instance = this;
Init ();
}

public static MySingleton Instance
{
get
{
if (instance == null)
{
new MySingleton ();
}

return instance;
}
}

private int timer;
private ArrayList listeners;

private void Init ()
{
listeners = new ArrayList ();
}

public int Timer
{
get
{
return timer;
}
set
{
timer = value;
if (timer <= 0)
{
foreach (GameObject listener in listeners)
{
listener.SendMessage ("GameOver");
}
}
}
}

public GameObject RegisterListener (GameObject listener)
{
listeners.Add (listener);

return listener;
}

public bool UnregisterListener (GameObject listener)
{
if (!listeners.Contains (listener))
{
return false;
}

listeners.Remove (listener);
}
}</csharp>

== Mapping static methods to singleton methods ==
Having to go through the Instance property for every function of the singleton gets old fast. Really the user most of the time does not need to know that he is dealing with a singleton, so this:
<csharp>MySingleton.Instance.Register (gameObject);
MySingleton.Instance.Unregister (gameObject);</csharp>
is really quite simple when it should just be this:
<csharp>MySingleton.Register (gameObject);
MySingleton.Unregister (gameObject);</csharp>
To make the above true, simply make your methods static and have *them* take the pain of going through the Instance property - like so:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton ()
{
if (instance != null)
{
Debug.LogError ("Cannot have two instances of singleton. Self destruction in 3...");
return;
}

instance = this;
Init ();
}

private static MySingleton Instance
{
get
{
if (instance == null)
{
new MySingleton ();
}

return instance;
}
}

private int timer;
private ArrayList listeners;

private void Init ()
{
listeners = new ArrayList ();
}

public static int Timer
{
get
{
return Instance.timer;
}
set
{
Instance.timer = value;
if (value <= 0)
{
foreach (GameObject listener in Instance.listeners)
{
listener.SendMessage ("GameOver");
}
}
}
}

public static GameObject RegisterListener (GameObject listener)
{
Instance.listeners.Add (listener);

return listener;
}

public static bool UnregisterListener (GameObject listener)
{
if (!Instance.listeners.Contains (listener))
{
return false;
}

Instance.listeners.Remove (listener);
}
}</csharp>
Voilá! Less cruft in the world! Everyone rejoice!

Singleton

2010-05-04T12:09:34Z

AngryAnt: Added example of using static methods for singleton functionality

By AngryAnt.
[[Category: Concepts]]
[[Category: Controller]]
[[Category: Design Patterns]]
[[Category: MonoBehaviour]]
[[Category: Programming]]
[[Category: Scripting]]
[[Category: C Sharp]]

== Description ==

People have recently asked about singleton creation quite often in [[IRC|the IRC channel]] so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

Note, however that for the component-based singleton (the second implementation), you shouldn't attempt to access the instance earlier than in Start of the calling component.

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton ()
{
if (instance != null)
{
Debug.LogError ("Cannot have two instances of singleton. Self destruction in 3...");
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if (instance == null)
{
new MySingleton ();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public static MySingleton Instance
{
get
{
GameObject go;

if (instance == null)
{
go = new GameObject ("MySingleton");
instance = (MySingleton)go.AddComponent (typeof (MySingleton));
}

return instance;
}
}

public void OnApplicationQuit ()
{
instance = null;
}
}</csharp>

== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score += 5;
Debug.Log ("Score is now: " + MySingleton.Instance.Score);</csharp>

And the singleton class:
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton ()
{
if (instance != null)
{
Debug.LogError ("Cannot have two instances of singleton. Self destruction in 3...");
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if (instance == null)
{
new MySingleton ();
}

return instance;
}
}

private int score;

public int Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>

== Time tracking and GameOver broadcasting singleton ==
This singleton works similarly to the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the tracked timer reaches zero or lower. The timer is set just like the score is in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register (gameObject);
MySingleton.Instance.Unregister (gameObject);</csharp>
Registering and unregistering would likely make sense to do in Awake and OnDisable of a script attached to the GameObjects needing it.
And the singleton class:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton ()
{
if (instance != null)
{
Debug.LogError ("Cannot have two instances of singleton. Self destruction in 3...");
return;
}

instance = this;
Init ();
}

public static MySingleton Instance
{
get
{
if (instance == null)
{
new MySingleton ();
}

return instance;
}
}

private int timer;
private ArrayList listeners;

private void Init ()
{
listeners = new ArrayList ();
}

public int Timer
{
get
{
return timer;
}
set
{
timer = value;
if (timer <= 0)
{
foreach (GameObject listener in listeners)
{
listener.SendMessage ("GameOver");
}
}
}
}

public GameObject RegisterListener (GameObject listener)
{
listeners.Add (listener);

return listener;
}

public bool UnregisterListener (GameObject listener)
{
if (!listeners.Contains (listener))
{
return false;
}

listeners.Remove (listener);
}
}</csharp>

== Mapping static methods to singleton methods ==
Having to go through the Instance property for every function of the singleton gets old fast. Really the user most of the time does not need to know that he is dealing with a singleton, so this:
<csharp>MySingleton.Instance.Register( gameObject );
MySingleton.Instance.Unregister( gameObject );</csharp>
is really quite simple when it should just be this:
<csharp>MySingleton.Register (gameObject);
MySingleton.Unregister (gameObject);</csharp>
To make the above true, simply make your methods static and have *them* take the pain of going through the Instance property - like so:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton ()
{
if (instance != null)
{
Debug.LogError ("Cannot have two instances of singleton. Self destruction in 3...");
return;
}

instance = this;
Init ();
}

private static MySingleton Instance
{
get
{
if (instance == null)
{
new MySingleton ();
}

return instance;
}
}

private int timer;
private ArrayList listeners;

private void Init ()
{
listeners = new ArrayList ();
}

public static int Timer
{
get
{
return Instance.timer;
}
set
{
Instance.timer = value;
if (value <= 0)
{
foreach (GameObject listener in Instance.listeners)
{
listener.SendMessage ("GameOver");
}
}
}
}

public static GameObject RegisterListener (GameObject listener)
{
Instance.listeners.Add (listener);

return listener;
}

public static bool UnregisterListener (GameObject listener)
{
if (!Instance.listeners.Contains (listener))
{
return false;
}

Instance.listeners.Remove (listener);
}
}</csharp>
Voilá! Less cruft in the world! Everyone rejoice!

Singleton

2009-09-22T14:12:26Z

AngryAnt: /* Component-based example */

By AngryAnt.
[[Category: Concepts]]
[[Category: Controller]]
[[Category: Design Patterns]]
[[Category: MonoBehaviour]]
[[Category: Programming]]
[[Category: Scripting]]
[[Category: C Sharp]]

== Description ==

People have recently asked about singleton creation quite often in [[IRC|the IRC channel]] so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

Note, however that for the component-based singleton (the second implementation), you shouldn't attempt to access the instance earlier than in Start of the calling component.

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public static MySingleton Instance
{
get
{
GameObject go;

if (instance == null)
{
go = new GameObject ("MySingleton");
instance = (MySingleton) go.AddComponent (typeof (MySingleton));
}

return instance;
}
}

public void OnApplicationQuit()
{
instance = null;
}
}</csharp>

== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score += 5;
Debug.Log( "Score is now: " + MySingleton.Instance.Score );</csharp>

And the singleton class:
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}

private int score;

public int Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>

== Time tracking and GameOver broadcasting singleton ==
This singleton works similarly to the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the tracked timer reaches zero or lower. The timer is set just like the score is in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register( gameObject );
MySingleton.Instance.Unregister( gameObject );</csharp>
Registering and unregistering would likely make sense to do in Awake and OnDisable of a script attached to the GameObjects needing it.
And the singleton class:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
Init();
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}

private int timer;
private ArrayList listeners;

private void Init()
{
listeners = new ArrayList();
}

public int Timer
{
get
{
return timer;
}
set
{
timer = value;
if( timer <= 0 )
{
foreach( GameObject listener in listeners )
{
listener.SendMessage( "GameOver" );
}
}
}
}

public GameObject RegisterListener( GameObject listener )
{
listeners.Add( listener );

return listener;
}

public bool UnregisterListener( GameObject listener )
{
if( !listeners.Contains( listener ) )
{
return false;
}

listeners.Remove( listener );
}
}</csharp>

CameraViewer

2009-08-06T12:28:44Z

AngryAnt: /* Editor script code */

By AngryAnt.

== Description ==

Note: Unity Pro only.

Install in Assets/Editor to add a "Camera viewer" item to the "Window" menu. Clicking this will launch a window which renders the output of the selected camera GameObject.

== Editor script code ==

<csharp>using UnityEngine;
using UnityEditor;
using System.Collections;

public class CameraViewer : EditorWindow
{
bool liveUpdate = false;
Camera camera;
RenderTexture renderTexture, originalTarget;

[ MenuItem( "Window/Camera viewer" ) ]
static void Launch()
{
EditorWindow editorWindow = GetWindow( typeof( CameraViewer ) );

editorWindow.Show();
}

void Update()
{
if( camera != null )
{
camera.Render();
if( liveUpdate )
{
Repaint();
}
}
}

void OnSelectionChange()
{
Camera newCamera = ( Selection.activeTransform == null ) ? null : Selection.activeTransform.gameObject.camera;

if( newCamera != camera )
{
if( originalTarget != null )
{
camera.targetTexture = originalTarget;
}

camera = newCamera;
if( camera != null )
{
originalTarget = camera.targetTexture;
camera.targetTexture = renderTexture;
}
else
{
originalTarget = null;
}
}
}

void OnGUI()
{
if( camera == null )
{
ToolbarGUI( "No camera selection" );
return;
}

if( renderTexture == null || renderTexture.width != position.width || renderTexture.height != position.height )
{
renderTexture = new RenderTexture( ( int )position.width, ( int )position.height, ( int )RenderTextureFormat.ARGB32 );
camera.targetTexture = renderTexture;
}

GUI.DrawTexture( new Rect( 0.0f, 0.0f, position.width, position.height ), renderTexture );

ToolbarGUI( camera.gameObject.name );
}

void ToolbarGUI( string title )
{
GUILayout.BeginHorizontal( "Toolbar" );
GUILayout.Label( title );
GUILayout.FlexibleSpace();
liveUpdate = GUILayout.Toggle( liveUpdate, "Live update", "ToolbarButton" );
GUILayout.EndHorizontal();
}
}
</csharp>

CameraViewer

2009-08-06T12:26:40Z

AngryAnt: New page: By AngryAnt. == Description == Note: Unity Pro only. Install in Assets/Editor to add a "Camera viewer" item to the "Window" menu. Clicking this will launch a window which renders the ou...

By AngryAnt.

== Description ==

Note: Unity Pro only.

Install in Assets/Editor to add a "Camera viewer" item to the "Window" menu. Clicking this will launch a window which renders the output of the selected camera GameObject.

== Component code ==

<csharp>using UnityEngine;
using UnityEditor;
using System.Collections;

public class CameraViewer : EditorWindow
{
bool liveUpdate = false;
Camera camera;
RenderTexture renderTexture, originalTarget;

[ MenuItem( "Window/Camera viewer" ) ]
static void Launch()
{
EditorWindow editorWindow = GetWindow( typeof( CameraViewer ) );

editorWindow.Show();
}

public void Update()
{
if( camera != null )
{
camera.Render();
if( liveUpdate )
{
Repaint();
}
}
}

void OnSelectionChange()
{
Camera newCamera = ( Selection.activeTransform == null ) ? null : Selection.activeTransform.gameObject.camera;

if( newCamera != camera )
{
if( originalTarget != null )
{
camera.targetTexture = originalTarget;
}

camera = newCamera;
if( camera != null )
{
originalTarget = camera.targetTexture;
camera.targetTexture = renderTexture;
}
else
{
originalTarget = null;
}
}
}

void OnGUI()
{
if( camera == null )
{
ToolbarGUI( "No camera selection" );
return;
}

if( renderTexture == null || renderTexture.width != position.width || renderTexture.height != position.height )
{
renderTexture = new RenderTexture( ( int )position.width, ( int )position.height, ( int )RenderTextureFormat.ARGB32 );
camera.targetTexture = renderTexture;
}

GUI.DrawTexture( new Rect( 0.0f, 0.0f, position.width, position.height ), renderTexture );

ToolbarGUI( camera.gameObject.name );
}

void ToolbarGUI( string title )
{
GUILayout.BeginHorizontal( "Toolbar" );
GUILayout.Label( title );
GUILayout.FlexibleSpace();
liveUpdate = GUILayout.Toggle( liveUpdate, "Live update", "ToolbarButton" );
GUILayout.EndHorizontal();
}
}
</csharp>

Extensions

2009-02-15T13:02:20Z

AngryAnt: Rephrased wording in introduction which originally suggested that all binary plugins are platform dependant.

Singleton

2009-02-14T16:38:40Z

AngryAnt: /* Time tracking and GameOver broadcasting singleton */

By AngryAnt.
[[Category: Concepts]]
[[Category: Controller]]
[[Category: Design Patterns]]
[[Category: MonoBehaviour]]
[[Category: Programming]]
[[Category: Scripting]]
[[Category: C Sharp]]

== Description ==

People have recently asked about singleton creation quite often in [[IRC|the IRC channel]] so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

Note, however that for the component-based singleton (the second implementation), you shouldn't attempt to access the instance earlier than in Start of the calling component.

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public void Awake()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
Destroy( this );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
Debug.LogError( "Attempt to access instance of MonoBehaviour singleton earlier than Start or without it being attached to a GameObject." );
}

return instance;
}
}

public void OnApplicationQuit()
{
instance = null;
}
}</csharp>

== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score += 5;
Debug.Log( "Score is now: " + MySingleton.Instance.Score );</csharp>

And the singleton class:
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}

private int score;

public int Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>

== Time tracking and GameOver broadcasting singleton ==
This singleton works similarly to the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the tracked timer reaches zero or lower. The timer is set just like the score is in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register( gameObject );
MySingleton.Instance.Unregister( gameObject );</csharp>
Registering and unregistering would likely make sense to do in Awake and OnDisable of a script attached to the GameObjects needing it.
And the singleton class:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
Init();
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}

private int timer;
private ArrayList listeners;

private void Init()
{
listeners = new ArrayList();
}

public int Timer
{
get
{
return timer;
}
set
{
timer = value;
if( timer <= 0 )
{
foreach( GameObject listener in listeners )
{
listener.SendMessage( "GameOver" );
}
}
}
}

public GameObject RegisterListener( GameObject listener )
{
listeners.Add( listener );

return listener;
}

public bool UnregisterListener( GameObject listener )
{
if( !listeners.Contains( listener ) )
{
return false;
}

listeners.Remove( listener );
}
}</csharp>

Singleton

2009-02-13T12:26:25Z

AngryAnt: /* Component-based example */

By AngryAnt.
[[Category: Concepts]]
[[Category: Controller]]
[[Category: Design Patterns]]
[[Category: MonoBehaviour]]
[[Category: Programming]]
[[Category: Scripting]]
[[Category: C Sharp]]

== Description ==

People have recently asked about singleton creation quite often in [[IRC|the IRC channel]] so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

Note, however that for the component-based singleton (the second implementation), you shouldn't attempt to access the instance earlier than in Start of the calling component.

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public void Awake()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
Destroy( this );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
Debug.LogError( "Attempt to access instance of MonoBehaviour singleton earlier than Start or without it being attached to a GameObject." );
}

return instance;
}
}

public void OnApplicationQuit()
{
instance = null;
}
}</csharp>

== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score += 5;
Debug.Log( "Score is now: " + MySingleton.Instance.Score );</csharp>

And the singleton class:
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}

private int score;

public int Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>

== Time tracking and GameOver broadcasting singleton ==
This singleton works similarly to the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the tracked timer reaches zero or lower. The timer is set just like the score is in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register( gameObject );
MySingleton.Instance.Unregister( gameObject );</csharp>
Registering and unregistering would likely make sense to do in Awake and OnDisable of a script attached to the GameObjects needing it.
And the singleton class:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
Init();
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}

private int timer;
private ArrayList listener;

private void Init()
{
listener = new ArrayList();
}

public int Timer
{
get
{
return timer;
}
set
{
timer = value;
if( timer <= 0 )
{
foreach( GameObject listener in listeners )
{
listener.SendMessage( "GameOver" );
}
}
}
}

public GameObject RegisterListener( GameObject listener )
{
listeners.Add( listener );

return listener;
}

public bool UnregisterListener( GameObject listener )
{
if( !listeners.Contains( listener ) )
{
return false;
}

listeners.Remove( listener );
}
}</csharp>

Singleton

2009-02-13T12:18:50Z

AngryAnt: /* Time tracking and GameOver broadcasting singleton */

By AngryAnt.
[[Category: Concepts]]
[[Category: Controller]]
[[Category: Design Patterns]]
[[Category: MonoBehaviour]]
[[Category: Programming]]
[[Category: Scripting]]
[[Category: C Sharp]]

== Description ==

People have recently asked about singleton creation quite often in [[IRC|the IRC channel]] so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

Note, however that for the component-based singleton (the second implementation), you shouldn't attempt to access the instance earlier than in Start of the calling component.

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public void Awake()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
Destroy( this );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
return instance;
}
}

public void OnApplicationQuit()
{
instance = null;
}
}</csharp>
== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score += 5;
Debug.Log( "Score is now: " + MySingleton.Instance.Score );</csharp>

And the singleton class:
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}

private int score;

public int Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>

== Time tracking and GameOver broadcasting singleton ==
This singleton works similarly to the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the tracked timer reaches zero or lower. The timer is set just like the score is in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register( gameObject );
MySingleton.Instance.Unregister( gameObject );</csharp>
Registering and unregistering would likely make sense to do in Awake and OnDisable of a script attached to the GameObjects needing it.
And the singleton class:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
Init();
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}

private int timer;
private ArrayList listener;

private void Init()
{
listener = new ArrayList();
}

public int Timer
{
get
{
return timer;
}
set
{
timer = value;
if( timer <= 0 )
{
foreach( GameObject listener in listeners )
{
listener.SendMessage( "GameOver" );
}
}
}
}

public GameObject RegisterListener( GameObject listener )
{
listeners.Add( listener );

return listener;
}

public bool UnregisterListener( GameObject listener )
{
if( !listeners.Contains( listener ) )
{
return false;
}

listeners.Remove( listener );
}
}</csharp>

Singleton

2009-02-05T13:36:37Z

AngryAnt: /* Time tracking and GameOver broadcasting singleton */

By AngryAnt.
[[Category: Concepts]]
[[Category: Controller]]
[[Category: Design Patterns]]
[[Category: MonoBehaviour]]
[[Category: Programming]]
[[Category: Scripting]]
[[Category: C Sharp]]

== Description ==

People have recently asked about singleton creation quite often in [[IRC|the IRC channel]] so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

Note, however that for the component-based singleton (the second implementation), you shouldn't attempt to access the instance earlier than in Start of the calling component.

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public void Awake()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
Destroy( this );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
return instance;
}
}

public void OnApplicationQuit()
{
instance = null;
}
}</csharp>
== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score += 5;
Debug.Log( "Score is now: " + MySingleton.Instance.Score );</csharp>

And the singleton class:
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}

private int score;

public int Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>

== Time tracking and GameOver broadcasting singleton ==
This singleton works similarly to the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the tracked timer reaches zero or lower. The timer is set just like the score is in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register( gameObject );
MySingleton.Instance.Unregister( gameObject );</csharp>
Registering and unregistering would likely make sense to do in Awake and OnDisable of a script attached to the GameObjects needing it.
And the singleton class:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
instance.Init();
}

return instance;
}
}

private int timer;
private ArrayList listener;

private void Init()
{
listener = new ArrayList();
}

public int Timer
{
get
{
return timer;
}
set
{
timer = value;
if( timer <= 0 )
{
foreach( GameObject listener in listeners )
{
listener.SendMessage( "GameOver" );
}
}
}
}

public GameObject RegisterListener( GameObject listener )
{
listeners.Add( listener );

return listener;
}

public bool UnregisterListener( GameObject listener )
{
if( !listeners.Contains( listener ) )
{
return false;
}

listeners.Remove( listener );
}
}</csharp>

Singleton

2009-02-05T13:35:58Z

AngryAnt: /* Score tracking singleton */

By AngryAnt.
[[Category: Concepts]]
[[Category: Controller]]
[[Category: Design Patterns]]
[[Category: MonoBehaviour]]
[[Category: Programming]]
[[Category: Scripting]]
[[Category: C Sharp]]

== Description ==

People have recently asked about singleton creation quite often in [[IRC|the IRC channel]] so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

Note, however that for the component-based singleton (the second implementation), you shouldn't attempt to access the instance earlier than in Start of the calling component.

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public void Awake()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
Destroy( this );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
return instance;
}
}

public void OnApplicationQuit()
{
instance = null;
}
}</csharp>
== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score += 5;
Debug.Log( "Score is now: " + MySingleton.Instance.Score );</csharp>

And the singleton class:
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}

private int score;

public int Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>

== Time tracking and GameOver broadcasting singleton ==
This singleton works similarly to the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the tracked timer reaches zero or lower. The timer is set just like the score is in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register( gameObject );
MySingleton.Instance.Unregister( gameObject );</csharp>
Registering and unregistering would likely make sense to do in Awake and OnDisable of a script attached to the GameObjects needing it.
And the singleton class:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
instance.Init();
}

return instance;
}
}

private int timer;
private ArrayList listener;

private void Init()
{
listener = new ArrayList();
}

public Timer
{
get
{
return timer;
}
set
{
timer = value;
if( timer <= 0 )
{
foreach( GameObject listener in listeners )
{
listener.SendMessage( "GameOver" );
}
}
}
}

public GameObject RegisterListener( GameObject listener )
{
listeners.Add( listener );

return listener;
}

public bool UnregisterListener( GameObject listener )
{
if( !listeners.Contains( listener ) )
{
return false;
}

listeners.Remove( listener );
}
}</csharp>

Singleton

2009-01-29T13:08:59Z

AngryAnt:

By AngryAnt.
[[Category: Concepts]]
[[Category: Controller]]
[[Category: Design Patterns]]
[[Category: MonoBehaviour]]
[[Category: Programming]]
[[Category: Scripting]]
[[Category: C Sharp]]

== Description ==

People have recently asked about singleton creation quite often in [[IRC|the IRC channel]] so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

Note, however that for the component-based singleton (the second implementation), you shouldn't attempt to access the instance earlier than in Start of the calling component.

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public void Awake()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
Destroy( this );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
return instance;
}
}

public void OnApplicationQuit()
{
instance = null;
}
}</csharp>
== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score += 5;
Debug.Log( "Score is now: " + MySingleton.Instance.Score );</csharp>

And the singleton class:
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}

private int score;

public Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>

== Time tracking and GameOver broadcasting singleton ==
This singleton works similarly to the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the tracked timer reaches zero or lower. The timer is set just like the score is in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register( gameObject );
MySingleton.Instance.Unregister( gameObject );</csharp>
Registering and unregistering would likely make sense to do in Awake and OnDisable of a script attached to the GameObjects needing it.
And the singleton class:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
instance.Init();
}

return instance;
}
}

private int timer;
private ArrayList listener;

private void Init()
{
listener = new ArrayList();
}

public Timer
{
get
{
return timer;
}
set
{
timer = value;
if( timer <= 0 )
{
foreach( GameObject listener in listeners )
{
listener.SendMessage( "GameOver" );
}
}
}
}

public GameObject RegisterListener( GameObject listener )
{
listeners.Add( listener );

return listener;
}

public bool UnregisterListener( GameObject listener )
{
if( !listeners.Contains( listener ) )
{
return false;
}

listeners.Remove( listener );
}
}</csharp>

AManagerClass

2009-01-29T13:08:12Z

AngryAnt:

[[Category: Concepts]]
[[Category: Controller]]
[[Category: Design Patterns]]
[[Category: MonoBehaviour]]
[[Category: C Sharp]]
[[Category: JavaScript]]
[[Category: Boo]]
Author: Keli Hlodversson (freyr)

== Description ==
'''Note: This article is quite dated and missing a bit of explaining. Read in conjunction with [[Singleton]].'''

The following snippet shows how to add a static property called ''instance'' that will automatically find an instance of the class in the scene and return it.

This is useful for managers and other behaviours that only have one instance in the scene and need to be accessed from other classes, as it avoids having each class to keep a reference to the manager object.

'''Hint:''' A nice place to put game managers in a scene hierarchy is to create an empty game object called ''Managers'' and attach all manager behaviours to it.

== Usage ==

Use the code example as a template when creating a manager-type script. Remember to replace all occurrences of AManager with the name of your class. To access a function, say, Foo() in the manager you call (assuming the GameObject with the Manager script is named Manager) it with: <javascript>Manager.instance.Foo();</javascript>

== C# - AManager.cs ==
<csharp>
using UnityEngine;
using System.Collections;

/// AManager is a singleton.
/// To avoid having to manually link an instance to every class that needs it, it has a static property called
/// instance, so other objects that need to access it can just call:
/// AManager.instance.DoSomeThing();
///
public class AManager : MonoBehaviour {
// s_Instance is used to cache the instance found in the scene so we don't have to look it up every time.
private static AManager s_Instance = null;

// This defines a static instance property that attempts to find the manager object in the scene and
// returns it to the caller.
public static AManager instance {
get {
if (s_Instance == null) {
// This is where the magic happens.
// FindObjectOfType(...) returns the first AManager object in the scene.
s_Instance = FindObjectOfType(typeof (AManager)) as AManager;
if (s_Instance == null)
Debug.Log ("Could not locate an AManager object. \
You have to have exactly one AManager in the scene.");
}

return s_Instance;
}
}

// Ensure that the instance is destroyed when the game is stopped in the editor.
void OnApplicationQuit() {
s_Instance = null;
}

// Add the rest of the code here...
public void DoSomeThing() {
Debug.Log("Doing something now", this);
}

}
</csharp>

== Boo - AManager.boo ==
''I haven't tested that one btw... so please fix it if you find any errors'' -- Keli
<boo>
import UnityEngine

class AManager (MonoBehaviour) :
"""
AManager is a singleton.
To avoid having to manually link an instance to every class that needs it, it has a static property called
instance, so other objects that need to access it can just call:
AManager.instance.DoSomeThing()
"""

# s_Instance is used to cache the instance found in the scene so we don't have to look it up every time.
private static s_Instance as AManager

#This defines a static instance property that attempts to find the manager object in the scene and
# returns it to the caller.
public static instance :
get :
if s_Instance == null :
# This is where the magic happens.
# FindObjectOfType(...) returns the first AManager object in the scene.
s_Instance = FindObjectOfType(AManager)
if s_Instance == null:
Debug.Log ("Could not locate an AManager object. \
You have to have exactly one AManager in the scene.")

return s_Instance

# Ensure that the instance is destroyed when the game is stopped in the editor.
def OnApplicationQuit() :
s_Instance = null

# Add the rest of the code here...
def DoSomeThing() :
Debug.Log("Doing something now", self)
</boo>

== Javascript - AManager.js ==
'''Note:''' Unity Javascript does not have a way to declare properties, so the instance property has been replaced with a static variable that gets initialised upon start. This also means that one can not be sure that ''instance'' has been initialised if it is accessed during initialisation.

<javascript>
/// AManager is a singleton.
/// To avoid having to manually link an instance to every class that needs it, it has a static variabe called
/// instance, so other objects that need to access it can just call:
/// AManager.instance.DoSomeThing();
///
static var instance : AManager;

// This is where the magic happens.
// FindObjectOfType(...) returns the first AManager object in the scene.
instance = FindObjectOfType(AManager);
if (instance == null)
Debug.Log ("Could not locate an AManager object. \
You have to have exactly one AManager in the scene.");

// Ensure that the instance is destroyed when the game is stopped in the editor.
function OnApplicationQuit() {
instance = null;
}

// Add the rest of the code here...

function DoSomeThing() {
Debug.Log("Doing something now", this);
}
</javascript>

Common Scripting Pitfalls

2009-01-29T08:46:01Z

AngryAnt:

== Coroutines in C# ==

In C#, a coroutine must return a value of type '''IEnumerator''', as mentioned in the [http://unity3d.com/Documentation/ScriptReference/index.Writing_Scripts_in_Csharp_or_Boo.html documentation]. However, if you return the similarly-named '''IEnumerable''', the coroutine won't work, and it won't return an error either!

== Floating point variables and methods ==
A common thing to do in scripting is to Lerp, or linearlly interpolate between two values. Unity has built in functions to lerp variables of type float, Vector3, Color, Material, and Quaternion, to name a few. The key thing to get sorted out is that all of the methods that operate on these different classes are within the class itself, except for float. To lerp a float, or to do other common operations dealing with floating point numbers, see the Mathf class. It contains Lerp, Min, Max, Abs, Sin, and all sorts of handy math functions. See the wiki's own [[Mathfx]] (short for Mathf eXtended) for even more handy math functions.

== My script hangs/beachballs Unity! ==
The most likely cause of this is that your script enters some loop and does not give control back to the Unity engine at all. You probably are forgetting to put a yield statement in your loop. See the Unity documentation on [http://unity3d.com/Documentation/ScriptReference/index.Coroutines_or_the_Yield_Statement.html coroutines and the yield statement].

Also if you hit a null reference exception, the first time it happens will take a while showing a beach ball, as the exception is also caught by Apple's crash reporter, which spends some time creating a stack trace of Unity. On slower machines this may give the impressions that Unity is hanging.

There are more possible causes of Unity hangs that should be elaborated on later.

== My scripts seem to be frame rate dependent! ==
If your script performs some incremental operation that should happen over a certain period of time, rather than a certain number of graphical updates, (This is most likely what you do not want!) you need to multiply your specific operation by [http://unity3d.com/Documentation/ScriptReference/Time-deltaTime.html Time.deltaTime].

For example, in C#:
<csharp>transform.position += Vector3.up * 5f;</csharp>
Should become:
<csharp>transform.position += Vector3.up * 5f * Time.deltaTime;</csharp>

In JavaScript:
<javascript>transform.position += Vector3.up * 5;</javascript>
Should become:
<javascript>transform.position += Vector3.up * 5 * Time.deltaTime;</javascript>

Since Time.deltaTime is usually a very small number, you will probably need to increase the number 5f (or just 5 in JavaScript) to something larger as well. Additionally, you should probably just make this a public variable in your script to take advantage of Unity's feature which allows you to modify variable values right in the Inspector!

== My Editor script won't compile! ==
If you get an error message like ''The type namespace name `UnityEditor` could not be found: Are you missing directive or an assembly reference?'', you have saved the script in the wrong place. All scripts using the [http://unity3d.com/Documentation/ScriptReference/20_class_hierarchy.Editor_Classes.html UnityEditor namespace] must be placed in the Assets/Editor folder in your project folder.

== I keep getting errors about my script/class types not being valid types ==
Make sure that the script containing the type you are trying to refer to is compiled before the script from which you try to refer it. For script compilation order, read the unity documentation on [http://unity3d.com/support/documentation/ScriptReference/index.Script_compilation_28Advanced29.html Overview: Script compilation (Advanced)].

Singleton

2009-01-28T14:07:24Z

AngryAnt: /* Description */

By AngryAnt.

== Description ==

People have recently asked about singleton creation quite often in [[IRC|the IRC channel]] so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

Note, however that for the component-based singleton (the second implementation), you shouldn't attempt to access the instance earlier than in Start of the calling component.

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public void Awake()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
Destroy( this );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
return instance;
}
}

public void OnApplicationQuit()
{
instance = null;
}
}</csharp>
== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score += 5;
Debug.Log( "Score is now: " + MySingleton.Instance.Score );</csharp>

And the singleton class:
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}

private int score;

public Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>

== Time tracking and GameOver broadcasting singleton ==
This singleton works similarly to the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the tracked timer reaches zero or lower. The timer is set just like the score is in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register( gameObject );
MySingleton.Instance.Unregister( gameObject );</csharp>
Registering and unregistering would likely make sense to do in Awake and OnDisable of a script attached to the GameObjects needing it.
And the singleton class:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
instance.Init();
}

return instance;
}
}

private int timer;
private ArrayList listener;

private void Init()
{
listener = new ArrayList();
}

public Timer
{
get
{
return timer;
}
set
{
timer = value;
if( timer <= 0 )
{
foreach( GameObject listener in listeners )
{
listener.SendMessage( "GameOver" );
}
}
}
}

public GameObject RegisterListener( GameObject listener )
{
listeners.Add( listener );

return listener;
}

public bool UnregisterListener( GameObject listener )
{
if( !listeners.Contains( listener ) )
{
return false;
}

listeners.Remove( listener );
}
}</csharp>

Singleton

2009-01-28T13:31:12Z

AngryAnt: /* Time tracking and GameOver broadcasting singleton */

By AngryAnt.

== Description ==

People have recently asked about singleton creation quite often in the IRC channel so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

Note, however that for the component-based singleton (the second implementation), you shouldn't attempt to access the instance earlier than in Start of the calling component.

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public void Awake()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
Destroy( this );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
return instance;
}
}

public void OnApplicationQuit()
{
instance = null;
}
}</csharp>
== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score += 5;
Debug.Log( "Score is now: " + MySingleton.Instance.Score );</csharp>

And the singleton class:
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}

private int score;

public Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>

== Time tracking and GameOver broadcasting singleton ==
This singleton works similarly to the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the tracked timer reaches zero or lower. The timer is set just like the score is in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register( gameObject );
MySingleton.Instance.Unregister( gameObject );</csharp>
Registering and unregistering would likely make sense to do in Awake and OnDisable of a script attached to the GameObjects needing it.
And the singleton class:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
instance.Init();
}

return instance;
}
}

private int timer;
private ArrayList listener;

private void Init()
{
listener = new ArrayList();
}

public Timer
{
get
{
return timer;
}
set
{
timer = value;
if( timer <= 0 )
{
foreach( GameObject listener in listeners )
{
listener.SendMessage( "GameOver" );
}
}
}
}

public GameObject RegisterListener( GameObject listener )
{
listeners.Add( listener );

return listener;
}

public bool UnregisterListener( GameObject listener )
{
if( !listeners.Contains( listener ) )
{
return false;
}

listeners.Remove( listener );
}
}</csharp>

Singleton

2009-01-28T13:25:27Z

AngryAnt: /* Score tracking singleton */

By AngryAnt.

== Description ==

People have recently asked about singleton creation quite often in the IRC channel so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

Note, however that for the component-based singleton (the second implementation), you shouldn't attempt to access the instance earlier than in Start of the calling component.

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public void Awake()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
Destroy( this );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
return instance;
}
}

public void OnApplicationQuit()
{
instance = null;
}
}</csharp>
== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score += 5;
Debug.Log( "Score is now: " + MySingleton.Instance.Score );</csharp>

And the singleton class:
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}

private int score;

public Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>

== Time tracking and GameOver broadcasting singleton ==
This singleton works similarly to the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the tracked timer reaches zero or lower. The timer is set just like the score is in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register( gameObject );
MySingleton.Instance.Unregister( gameObject );</csharp>

And the singleton class:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
instance.Init();
}

return instance;
}
}

private int timer;
private ArrayList listener;

private void Init()
{
listener = new ArrayList();
}

public Timer
{
get
{
return timer;
}
set
{
timer = value;
if( timer <= 0 )
{
foreach( GameObject listener in listeners )
{
listener.SendMessage( "GameOver" );
}
}
}
}

public GameObject RegisterListener( GameObject listener )
{
listeners.Add( listener );

return listener;
}

public bool UnregisterListener( GameObject listener )
{
if( !listeners.Contains( listener ) )
{
return false;
}

listeners.Remove( listener );
}
}</csharp>

Singleton

2009-01-28T13:21:30Z

AngryAnt: /* Score tracking and GameOver broadcasting singleton */

By AngryAnt.

== Description ==

People have recently asked about singleton creation quite often in the IRC channel so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

Note, however that for the component-based singleton (the second implementation), you shouldn't attempt to access the instance earlier than in Start of the calling component.

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public void Awake()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
Destroy( this );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
return instance;
}
}

public void OnApplicationQuit()
{
instance = null;
}
}</csharp>
== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score += 5;</csharp>

And the singleton class:
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}

private int score;

public Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>

== Time tracking and GameOver broadcasting singleton ==
This singleton works similarly to the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the tracked timer reaches zero or lower. The timer is set just like the score is in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register( gameObject );
MySingleton.Instance.Unregister( gameObject );</csharp>

And the singleton class:
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
instance.Init();
}

return instance;
}
}

private int timer;
private ArrayList listener;

private void Init()
{
listener = new ArrayList();
}

public Timer
{
get
{
return timer;
}
set
{
timer = value;
if( timer <= 0 )
{
foreach( GameObject listener in listeners )
{
listener.SendMessage( "GameOver" );
}
}
}
}

public GameObject RegisterListener( GameObject listener )
{
listeners.Add( listener );

return listener;
}

public bool UnregisterListener( GameObject listener )
{
if( !listeners.Contains( listener ) )
{
return false;
}

listeners.Remove( listener );
}
}</csharp>

Singleton

2009-01-28T13:19:01Z

AngryAnt: /* Score tracking singleton */

By AngryAnt.

== Description ==

People have recently asked about singleton creation quite often in the IRC channel so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

Note, however that for the component-based singleton (the second implementation), you shouldn't attempt to access the instance earlier than in Start of the calling component.

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public void Awake()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
Destroy( this );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
return instance;
}
}

public void OnApplicationQuit()
{
instance = null;
}
}</csharp>
== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score += 5;</csharp>

And the singleton class:
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}

private int score;

public Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>

== Score tracking and GameOver broadcasting singleton ==
This singleton expands on the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the score reaches zero or lower. The score is set just like in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register( gameObject );
MySingleton.Instance.Unregister( gameObject );</csharp>
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
instance.Init();
}

return instance;
}
}

private int score;
private ArrayList listener;

private void Init()
{
listener = new ArrayList();
}

public Score
{
get
{
return score;
}
set
{
score = value;
if( score <= 0 )
{
foreach( GameObject listener in listeners )
{
listener.SendMessage( "GameOver" );
}
}
}
}

public GameObject RegisterListener( GameObject listener )
{
listeners.Add( listener );

return listener;
}

public bool UnregisterListener( GameObject listener )
{
if( !listeners.Contains( listener ) )
{
return false;
}

listeners.Remove( listener );
}
}</csharp>

Singleton

2009-01-28T13:18:27Z

AngryAnt: /* Score tracking singleton */

By AngryAnt.

== Description ==

People have recently asked about singleton creation quite often in the IRC channel so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

Note, however that for the component-based singleton (the second implementation), you shouldn't attempt to access the instance earlier than in Start of the calling component.

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public void Awake()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
Destroy( this );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
return instance;
}
}

public void OnApplicationQuit()
{
instance = null;
}
}</csharp>
== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score += 5;</csharp>

<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}

private int score;

public Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>

== Score tracking and GameOver broadcasting singleton ==
This singleton expands on the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the score reaches zero or lower. The score is set just like in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register( gameObject );
MySingleton.Instance.Unregister( gameObject );</csharp>
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
instance.Init();
}

return instance;
}
}

private int score;
private ArrayList listener;

private void Init()
{
listener = new ArrayList();
}

public Score
{
get
{
return score;
}
set
{
score = value;
if( score <= 0 )
{
foreach( GameObject listener in listeners )
{
listener.SendMessage( "GameOver" );
}
}
}
}

public GameObject RegisterListener( GameObject listener )
{
listeners.Add( listener );

return listener;
}

public bool UnregisterListener( GameObject listener )
{
if( !listeners.Contains( listener ) )
{
return false;
}

listeners.Remove( listener );
}
}</csharp>

Singleton

2009-01-28T13:18:08Z

AngryAnt: /* Score tracking singleton */

By AngryAnt.

== Description ==

People have recently asked about singleton creation quite often in the IRC channel so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

Note, however that for the component-based singleton (the second implementation), you shouldn't attempt to access the instance earlier than in Start of the calling component.

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public void Awake()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
Destroy( this );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
return instance;
}
}

public void OnApplicationQuit()
{
instance = null;
}
}</csharp>
== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score += 5;</csharp>
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}

private int score;

public Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>

== Score tracking and GameOver broadcasting singleton ==
This singleton expands on the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the score reaches zero or lower. The score is set just like in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register( gameObject );
MySingleton.Instance.Unregister( gameObject );</csharp>
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
instance.Init();
}

return instance;
}
}

private int score;
private ArrayList listener;

private void Init()
{
listener = new ArrayList();
}

public Score
{
get
{
return score;
}
set
{
score = value;
if( score <= 0 )
{
foreach( GameObject listener in listeners )
{
listener.SendMessage( "GameOver" );
}
}
}
}

public GameObject RegisterListener( GameObject listener )
{
listeners.Add( listener );

return listener;
}

public bool UnregisterListener( GameObject listener )
{
if( !listeners.Contains( listener ) )
{
return false;
}

listeners.Remove( listener );
}
}</csharp>

Singleton

2009-01-28T13:13:50Z

AngryAnt: /* Score tracking and GameOver broadcasting example */

By AngryAnt.

== Description ==

People have recently asked about singleton creation quite often in the IRC channel so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

Note, however that for the component-based singleton (the second implementation), you shouldn't attempt to access the instance earlier than in Start of the calling component.

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public void Awake()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
Destroy( this );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
return instance;
}
}

public void OnApplicationQuit()
{
instance = null;
}
}</csharp>
== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score = 5;</csharp>
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}

private int score;

public Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>
== Score tracking and GameOver broadcasting singleton ==
This singleton expands on the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the score reaches zero or lower. The score is set just like in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register( gameObject );
MySingleton.Instance.Unregister( gameObject );</csharp>
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
instance.Init();
}

return instance;
}
}

private int score;
private ArrayList listener;

private void Init()
{
listener = new ArrayList();
}

public Score
{
get
{
return score;
}
set
{
score = value;
if( score <= 0 )
{
foreach( GameObject listener in listeners )
{
listener.SendMessage( "GameOver" );
}
}
}
}

public GameObject RegisterListener( GameObject listener )
{
listeners.Add( listener );

return listener;
}

public bool UnregisterListener( GameObject listener )
{
if( !listeners.Contains( listener ) )
{
return false;
}

listeners.Remove( listener );
}
}</csharp>

Singleton

2009-01-28T13:13:21Z

AngryAnt:

By AngryAnt.

== Description ==

People have recently asked about singleton creation quite often in the IRC channel so rather than retyping a basic implementation each time, I'll have this to link to. Yay! :)

Curious, but not quite sure what a singleton is? Ask a friend: [http://en.wikipedia.org/wiki/Singleton_pattern]

Singletons are generally handy for providing easy access to game state and control code. I've provided example implementation for a basic class type which needn't be attached to a game object in order to function and after this an implementation which works as any other component.

Members of both singleton types are accessed the same way:

<csharp>MySingleton.Instance.MySingletonMember;</csharp>

Note, however that for the component-based singleton (the second implementation), you shouldn't attempt to access the instance earlier than in Start of the calling component.

== The non-component example ==
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}
}</csharp>
== Component-based example ==
<csharp>using UnityEngine;

public class MySingleton : MonoBehaviour
{
private static MySingleton instance;

public void Awake()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
Destroy( this );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
return instance;
}
}

public void OnApplicationQuit()
{
instance = null;
}
}</csharp>
== Score tracking singleton ==
The singleton in this example keeps track of the game score. Getting and setting this value is done like so:
<csharp>MySingleton.Instance.Score = 5;</csharp>
<csharp>public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
}

return instance;
}
}

private int score;

public Score
{
get
{
return score;
}
set
{
score = value;
}
}
}</csharp>
== Score tracking and GameOver broadcasting example ==
This singleton expands on the score tracking singleton by also maintaining a list of GameObjects which register and unregister themselves with the singleton in order to receive a "GameOver" message when the score reaches zero or lower. The score is set just like in the singleton above and GameObjects register and unregister with the singleton like so:
<csharp>MySingleton.Instance.Register( gameObject );
MySingleton.Instance.Unregister( gameObject );</csharp>
<csharp>using System.Collections;
using UnityEngine;

public class MySingleton
{
private static MySingleton instance;

public MySingleton()
{
if( instance != null )
{
Debug.LogError( "Cannot have two instances of singleton. Self destruction in 3..." );
return;
}

instance = this;
}

public static MySingleton Instance
{
get
{
if( instance == null )
{
new MySingleton();
instance.Init();
}

return instance;
}
}

private int score;
private ArrayList listener;

private void Init()
{
listener = new ArrayList();
}

public Score
{
get
{
return score;
}
set
{
score = value;
if( score <= 0 )
{
foreach( GameObject listener in listeners )
{
listener.SendMessage( "GameOver" );
}
}
}
}

public GameObject RegisterListener( GameObject listener )
{
listeners.Add( listener );

return listener;
}

public bool UnregisterListener( GameObject listener )
{
if( !listeners.Contains( listener ) )
{
return false;
}

listeners.Remove( listener );
}
}</csharp>

Singleton

2009-01-21T10:23:57Z

AngryAnt: New page: By AngryAnt. == Description == People have recently asked about singleton creation quite often in the IRC channel so rather than retyping a basic implementation each time, I'll have this...

SelectList

2008-11-10T18:01:42Z

AngryAnt: /* Usage */

By AngryAnt.

== Description ==

Visualises a list of strings or objects overriding ToString and returns the item selected by the user. Clicking a selected item will deselect it.

Optionally, the OnListItemGUI delegate can be used to do custom GUI rendering of list items.

== Component code ==

<csharp> public static object SelectList( ICollection list, object selected, GUIStyle defaultStyle, GUIStyle selectedStyle )
{
foreach( object item in list )
{
if( GUILayout.Button( item.ToString(), ( selected == item ) ? selectedStyle : defaultStyle ) )
{
if( selected == item )
// Clicked an already selected item. Deselect.
{
selected = null;
}
else
{
selected = item;
}
}
}

return selected;
}

public delegate bool OnListItemGUI( object item, bool selected, ICollection list );

public static object SelectList( ICollection list, object selected, OnListItemGUI itemHandler )
{
ArrayList itemList;

itemList = new ArrayList( list );

foreach( object item in itemList )
{
if( itemHandler( item, item == selected, list ) )
{
selected = item;
}
else if( selected == item )
// If we *were* selected, but aren't any more then deselect
{
selected = null;
}
}

return selected;
}
</csharp>

== Usage ==

<csharp> currentSeletion = SelectList( myList, currentSelection, GUI.skin.GetStyle( "Button" ), GUI.skin.GetStyle( "Label" ) );
</csharp>

In this example, myList could be an ArrayList of strings or instances of your own type, returning the desired list label in ToString.

<csharp> currentSeletion = SelectList( myList, currentSelection, OnCheckboxItemGUI );

private bool OnCheckboxItemGUI( object item, bool selected, ICollection list )
{
return GUILayout.Toggle( selected, item.ToString() );
}
</csharp>

In this example, the same list is used, only this time it is visualised using a custom list item rendering function.

Further advancing the use of custom list item rendering functions, you could implement nested lists similar to this:

[[Image:SelectListNested.png]]

File:SelectListNested.png

2008-11-10T17:59:06Z

AngryAnt: Screenshot of how SelectList could be used to create nested select lists.

Screenshot of how SelectList could be used to create nested select lists.

SelectList

2008-11-10T17:56:05Z

AngryAnt: /* Usage */

SelectList

2008-11-10T17:49:48Z

AngryAnt: /* Description */

SelectList

2008-11-10T17:47:34Z

AngryAnt: /* Component code */

By AngryAnt.

== Description ==

Visualises a list of strings or objects overriding ToString and returns the item selected by the user.

== Component code ==

<csharp> public static object SelectList( ICollection list, object selected, GUIStyle defaultStyle, GUIStyle selectedStyle )
{
foreach( object item in list )
{
if( GUILayout.Button( item.ToString(), ( selected == item ) ? selectedStyle : defaultStyle ) )
{
if( selected == item )
// Clicked an already selected item. Deselect.
{
selected = null;
}
else
{
selected = item;
}
}
}

return selected;
}

public delegate bool OnListItemGUI( object item, bool selected, ICollection list );

public static object SelectList( ICollection list, object selected, OnListItemGUI itemHandler )
{
ArrayList itemList;

itemList = new ArrayList( list );

foreach( object item in itemList )
{
if( itemHandler( item, item == selected, list ) )
{
selected = item;
}
else if( selected == item )
// If we *were* selected, but aren't any more then deselect
{
selected = null;
}
}

return selected;
}
</csharp>

== Usage ==

<csharp> currentSeletion = SelectList( myList, currentSelection, GUI.skin.GetStyle( "Button" ), GUI.skin.GetStyle( "Label" ) );
</csharp>

In this example, myList could be an ArrayList of strings or instances of your own type, returning the desired list label in ToString.

Unify:Community Portal

2008-10-05T20:54:24Z

AngryAnt: /* Developers using Unity */

== What is the UnifyWiki? ==

The UnifyWiki project is a site where you can expand your knowledge about Unity. It is meant for anyone to contribute, so if you know something we don't, go ahead and make a page about it. Learn more about how [http://meta.wikimedia.org/wiki/MediaWiki_User's_Guide here]. Make sure you read [[:Help:Contents|this]] as well.

== Links ==

=== Unity Technologies ===
*[http://unity3d.com/ Unity Technologies]
*[http://forum.unity3d.com/ Forum]

=== Community sites ===
*[http://unify.bluegillweb.com/ Unify Unity collaboration community]
*[http://unify.bluegillweb.com/unitree/ UniTree]
*The [irc://irc.freenode.net/unity3d #unity3d] IRC channel at freenode. ''[[IRC|(What is IRC?)]]''

=== Developers using Unity ===
*[http://angryant.com AngryAnt.com] - AI solutions for unity
*[http://www.bluegillflame.com/ BlueGill Flame] - Formerly known as BlueGill Studios
*[http://www.graveck.com/ Graveck Interactive] - Aarku and co.
*[http://www.nether.org.uk/ Neil Carter]
*[http://seriousgames.dk Serious Games Interactive] - Unity Technologies' sister company
*[http://www.widgetmonkeys.com Widget Monkeys] - Seriously simple fun
*[http://www.eduweb.com/ Educational Web Adventures] - Producers of [http://www.wolfquest.org/ WolfQuest]
*[http://www.bydesigngames.com/ ByDesign Games - Joe Schultz] Freshness Guaranteed!
*[http://www.vrshell.com/ VRshell Games] - Developer of VR simulations on Mac.
*[http://games.sector3.com.au/ Sector3 Games] - Awesome 3D games for Mac & PC

=== Publishers ===
*[http://www.ambrosiasw.com/ Ambrosia] - publisher of OTEE's [http://www.AmbrosiaSW.com/games/gooball/ Gooball].
*[http://www.freeverse.com/ Freeverse] - publisher of a lot of great Mac games of all shapes and sizes and supporters of [http://www.freeverse.com/omg/ Original Mac Games].

=== Content that can be licensed and used ===
*[http://www.arteria-gaming.com/ Arteria Gaming] - Many packs available via "all-you-can-eat" yearly subscriptions
*[http://www.cubixstudio.com/ Cubix Studio] - Human and weapon models for under $20.

=== Other ===
*[http://en.wikipedia.org/wiki/Unity_game_engine Unity entry on Wikipedia]

FileBrowser

2008-10-02T21:12:11Z

AngryAnt: /* Description */

By AngryAnt.

== Description ==

Implements a crude file browser in unity 2.0 GUI. This code uses the [[SelectList]] script.

Note that by crude I mean you might want to have a GUILayout pretty it up and at some point someone (me perhaps?) should pull the script around a bit so the file and directory representations in the lists aren't by complete path. Also the root check only works for unix environments at the moment. That should be an easy rewrite though.

This is how the browser could look:

[[Image:FileBrowser.png]]

== Component code ==

<csharp>public static bool FileBrowser( ref string location, ref Vector2 directoryScroll, ref Vector2 fileScroll )
{
bool complete;
DirectoryInfo directoryInfo;
DirectoryInfo directorySelection;
FileInfo fileSelection;
int contentWidth;

// Our return state - altered by the "Select" button
complete = false;

// Get the directory info of the current location
fileSelection = new FileInfo( location );
if( fileSelection.Attributes == FileAttributes.Directory )
{
directoryInfo = new DirectoryInfo( location );
}
else
{
directoryInfo = fileSelection.Directory;
}

if( location != "/" && GUI.Button( new Rect( 10, 20, 410, 20 ), "Up one level" ) )
{
directoryInfo = directoryInfo.Parent;
location = directoryInfo.FullName;
}

// Handle the directories list
GUILayout.BeginArea( new Rect( 10, 40, 200, 300 ) );
GUILayout.Label( "Directories:" );
directoryScroll = GUILayout.BeginScrollView( directoryScroll );
directorySelection = BehaveLibrary.Resources.SelectList( directoryInfo.GetDirectories(), null ) as DirectoryInfo;
GUILayout.EndScrollView();
GUILayout.EndArea();

if( directorySelection != null )
// If a directory was selected, jump there
{
location = directorySelection.FullName;
}

// Handle the files list
GUILayout.BeginArea( new Rect( 220, 40, 200, 300 ) );
GUILayout.Label( "Files:" );
fileScroll = GUILayout.BeginScrollView( fileScroll );
fileSelection = BehaveLibrary.Resources.SelectList( directoryInfo.GetFiles(), null ) as FileInfo;
GUILayout.EndScrollView();
GUILayout.EndArea();

if( fileSelection != null )
// If a file was selected, update our location to it
{
location = fileSelection.FullName;
}

// The manual location box and the select button
GUILayout.BeginArea( new Rect( 10, 350, 410, 20 ) );
GUILayout.BeginHorizontal();
location = GUILayout.TextArea( location );

contentWidth = ( int )GUI.skin.GetStyle( "Button" ).CalcSize( new GUIContent( "Select" ) ).x;
if( GUILayout.Button( "Select", GUILayout.Width( contentWidth ) ) )
{
complete = true;
}
GUILayout.EndHorizontal();
GUILayout.EndArea();

return complete;
}
</csharp>

== Usage ==

<csharp> public void FileBrowserWindow( int idx )
{
if( FileBrowser( ref location, ref directoryScroll, ref fileScroll ) )
{
fileBrowser = false;
}
}

public void OnGUI()
{
if( fileBrowser )
{
GUI.Window( 0, new Rect( ( Screen.width - 430 ) / 2, ( Screen.height - 380 ) / 2, 430, 380 ), FileBrowserWindow, "Browse" );
return;
}
}
</csharp>

File:FileBrowser.png

2008-10-02T21:10:54Z

AngryAnt: Screenshot of how the FileBrowser script could look.

Screenshot of how the FileBrowser script could look.

Scripts

2008-10-02T21:03:48Z

AngryAnt: /* Unity 2.0 GUI Scripts */

{| align="right"
| __TOC__
|}

= General =

== General Concepts ==

*[[AManagerClass]] - How to add easy access to a singleton class in a scene.
*[[BasicDataStructures]] - Discussion of the use of the data-structures available in Unity.
*[[SimpleRegex]] - How one might use regular expressions in Unity.
*[[ToggleGravity]] - How to toggle a property, in this case the global gravity setting, by the left mouse button.

== Utility Scripts ==

*[[Angle]] - Helper class to work with angles.
*[[CustomRandom]] - C# Random number generator, when you must have a random number generator that works the same way on all platforms!
*[[deepSearch]] - Searches recursively from the parent down.
*[[ExpandoObject]] - Create ECMAScript-style expando objects in Unity Javascript.
*[[HexConverter]] - Functions for converting decimal colors to hexadecimal... and back.
*[[HSBColor]] - This utility script provides a HSB color model in addition to Unity's built in RGB Color class.
*[[LABColor]] - This utility script provides an LAB color model in addition to Unity's built in RGB Color class.
*[[Layers]] - A utility script for holding easily-accessible layers and easily creating masks.
*[[Mathfx]] - This script contains a growing number of small and useful math functions (short for Mathf eXtended).
*[[Matrix]] - A class for doing 3D matrix math against Vector3 objects.
*[[MazeGenerator]] - Randomly generates a maze.
*[[MD5]] - Generate an MD5 hash for a string.
*[[MetadataSystem]] - Mechanism for ciphered, compressed preferences and declarative metadata system with runtime overrides.
*[[MixupGO]] - Flatten GameObjects and all attached components into a single object using duck typing in Unity Javascript.
*[[ObjExporter]] - A simple utility class for exporting a mesh to an obj file.
*[[PrintPolyCount]] - Prints total vertex and triangle count in the object hierarchy.
*[[Set]] - A set data structure.
*[[Shell]] - A replacement for the built-in shell function removed from Unity 1.6.1.
*[[StringToValue]] - Functions for finding data within a string.
*[[StringUtil]] - Word wrap and line count functions.
*[[TerrainObjExporter]] - Export Unity 2.0 Terrain objects as obj files.
*[[TextScanner]] - A utility class for parsing strings using std C sscanf format strings.
*[[VertexInfo]] - Displays the vertex numbers of a mesh at the runtime.

== Really Simple Scripts ==

*[[ConstantVelocity]] - Set a local velocity to an object (useful for missiles perhaps?)
*[[OnCollideExplode]] - Spawn a prefab (explosion) on collision, and remove the GameObject from the game.
*[[OnCollideSound]] - Spawn a prefab (preferably a sound) if a collision is over a certain magnitude.
*[[OnExplosionEffect]] - Give an explosive effect over an area.
*[[SwitchCamera]] - Switches between cameras in your scene.
*[[PointerManager]] - Hides the mouse pointer when it is not in use.

== Code Snippets ==

*[[Calculating Lead For Projectiles]] - These script fragments allow you to add some lead ahead of the target allowing projectiles/missiles to collide with the target. Uses a quadratic rather than an iterative solution.

= Controllers =

== Camera Controls ==

*[[CrossFade]] - Smoothly fade the view from one camera to another.
*[[CrossFadePro]] - Smoothly fade the view from one camera to another, with motion in both cameras.
*[[DreamWipe]] - Fade the view from one camera to another, with the wavy distortion seen with dream sequences or flashbacks
*[[FadeInOut]] - Fade a full-screen image in or out, good for fade in outs.
*[[Headbobber]] - Make an object bob up and down smoothly when you're pressing one or both of the horizontal/vertical axes.
*[[MouseLookPlus]] - A javascript mouselook with key control. based on the standard assets C# mouselook.
*[[RectangleWipe]] - Make an animated rectangular zooming screen wipe from one camera to another.
*[[ShapeWipe]] - Make an animated screen wipe, where an arbitrary shape containing the second view zooms in or out, and rotates.
*[[SmoothFollow2]] - This is designed to make a camera smoothly follow a ship in space.
*[[SquishWipe]] - Make an animated screen wipe from one camera to another, where the first image is squished out of view.

== Character Controller Scripts ==

*[[Force2D]] - Constrain a GameObject to move in two dimensions.
*[[PhysicsFPSWalker]] - Another physics based fps walker script.
*[[RigidbodyFPSWalker]] - An physics based FPS walker that works with rigidbodies and thus is affected by forces, joints or other rigidbodies
*[[ShipControls]] - Place this script on a [http://www.otee.dk/Documentation/ScriptReference/Rigidbody.html RigidBody] for 2D spaceship controls like [http://otee.dk/gallery/udwc/OverWhelmedArena.html OverWhelmed Arena].
*[[VariableSpeedFPSwalker]] - An FPS walker script having different speeds for walking forward, strafing, and back-pedalling.
*[[JCar]] - A car using wheel colliders.

== Animation Controllers ==

*[[AniMate]] - Script to quickly and easily create animations/tweens of almost any value and including eased, rigidbody and rotation animation.

= GUI =

== Graphical User Interface Scripts ==

*[[AutoType]] - Automaticly types a string of text typewriter style.
*[[Box_Script]] - Use this system to easily make simple GUI elements in nice looking boxes with buttons that actually do something useful. All generated at runtime from a MenuStyle.
*[[Button]] - Use this script on a guiTexture object for regular push buttons that send a message when clicked.
*[[Custom_2D_Pointer]] - Make a custom pointer that changes shape at the edges of the screen.
*[[DraggableGUIElement]] - Click and drag on GUITexture or GUIText to move it around the screen.
*[[DragSlider]] - Use this script with a pair of [http://otee.dk/Documentation/ScriptReference/GUITexture.html GUITexture]s to make a functioning slider.
*[[FadeIn]] - Allows you to show/hide a [http://www.otee.dk/Documentation/ScriptReference/GUIText.html GUIText] or [http://www.otee.dk/Documentation/ScriptReference/GUITexture.html GUITexture] when pressing a key/button.
*[[ForwardAllMouseEvents]] - Send mouse events to some sort of controller type GameObject.
*[[GetTimeString]] - A simple function that can be placed anywhere and used to display times. Useful for racing games.
*[[GUIBuilder]] - Generic classes for easing the pain of GUI creation. (BETA)
*[[GUIFly]] - Use this script on an object to make it respond to a "Fly" message so that it may move on and off the screen in a pleasing manner.
*[[GuiRatioFixer]] - Use on a [http://otee.dk/Documentation/ScriptReference/GUIText.html GUIText] /[http://otee.dk/Documentation/ScriptReference/GUITexture.html GUITexture] object to automatically adjust aspect ratio
*[[GuiRatioFixer2]] - Alternate script based on screen's aspect to use on a [http://otee.dk/Documentation/ScriptReference/GUIText.html GUIText] /[http://otee.dk/Documentation/ScriptReference/GUITexture.html GUITexture] object to automatically adjust aspect ratio
*[[ScreenShotMovie]] - Captures a screenshot sequence for use when making a movie
*[[TakeScreenshot]] - Captures sequentially numbered screenshots when a function key is pressed.
*[[ToggleButton]] - Extends the Button class to create a toggle button.

== Unity 2.0 GUI Scripts ==

*[[Blinking Text Entry Cursor]] - Make your cursor blink on input fields
*[[FileBrowser]] - Implement a crude file browser.
*[[CustomGetMouseButtonDown]] - custom wrapper functions for Input.GetMouseButton(Down) which can be modified to block clicks when over a window
*[[Position To Rect]] - Convert a GUITexture position to Rect (GUI coordinates)
*[[GUICam]] - Holds GUIRect a rectanle of camera pixelRect in GUI oriented co-oridinates (0,0) is top left
*[[GUIx]] - extended GUI functions
*[[PasswordField]] - Allows the user to type in a field masked by *'s (or any other character)
*[[PauseMenu]] - Standard pause menu used by Fugu Games for web players and widgets
*[[SelectList]] - A list of elements of which one can be selected.
*[[WithPrefs]] - Functions that change values and modifies preferences in one simple step

== Heads Up Display Scripts ==

*[[FramesPerSecond]] - Use this script on a [http://unity3d.com/Documentation/Components/class-GuiText.html GUIText] object to display FPS counter.
*[[MessageDisplayer]] - Use this script on a [http://unity3d.com/Documentation/Components/class-GuiText.html GUIText] object to have a self-disappearing list of status messages.
*[[Radar]] - Use this script on a GameObject to display a radar.

= Effects =

== General Purpose Effect Scripts ==

*[[Animating Tiled texture]] - A texture made of many tiles animated through setting the uv offsets
*[[Animating Tiled texture - Extended]] - Use one animation cell-sheet texture for many animations and skins.
*[[CameraFacingBillboard]] - Use this script on a billboard or similar object to make it align itself with the camera.
*[[CameraRenderSettings]] - Allows storing seperate render settings per camera - an extended version of the Fog Layer script above.
*[[Character Shadow]] - Cast shadows from an object! ''(requires Unity Pro)''
*[[Flocking]] - A flocking script with randomness and target following.
*[[Fog Layer]] - Lets you determine per camera if fog should be enabled or disabled
*[[LookAtCameraYonly]] - Use this script on a billboard or other object to have it face the camera but only rotate on the Y axis.
*[[MeshMorpher]] - A Mesh Morpher script with scripting API
*[[MetaBalls]] - 3D Metaballs
*[[OptimizedTrailRenderer]] - Started from Yoggy's trail renderer above, this one updates every frame and is built for one-time use.
*[[Perlin Noise]] - Noise functions for smoothly moving objects around or anything else
*[[ReverseNormals]] - Reverses normals & back face culling of a mesh
*[[Shadow Volumes in Alpha]] - Shadow volume based shadows ''(requires Unity Pro)''
*[[SoftBodies]] - Cloth, Springy Noodles, Jello Blocks, etc..
*[[StopEmittingAfterDelay]] - After a configurable delay, particles will fade naturally, then finally the object will get destroyed with autodestruct.
*[[Spline Controller]] - Interpolates any GameObject along a user-defined spline
*[[SVG]] - Render SVG Files.
*[[TubeRenderer]] - LineRenderer too flat? Make it a tube instead.
*[[TimeBasedTrailRenderer]] - The Built in trail renderer does not fade its segments based on the time they have been alive. This one does.
*[[Trail Arc Renderer]] - Designed for melee trail swings, this creates a trail using Catmull-Rom spline interpolation

== Image Postprocessing Effects ==

These scripts require Unity Pro.

*[[BloomEffect]] (OBSOLETE) - Sometimes referred to as "glow", use this effect to make bright parts in your scene bleed. This script is made obsolete by the GlowEffect shipped with Unity 1.5.
*[[BoostColors]] - A very simple and fast way to boost the contrast of saturation of the graphics in your game.
*[[InvertCamera]] - A simple script that will invert everything rendered by a camera.

= Physics / Simulation =

== Physics Scripts ==

*[[DontGoThroughThings]] - Script that uses raycasting to avoid fast-moving objects going through obstructions.
*[[ComplicatedRigidbodyControl]] - Attach a rigidbody to an arbitrary transform, or a method to make rigidbodies never overshoot.

== Simulation Scripts ==

*[[Compass]] - This script simulates a compass with North relative to the Z axis of a reference object
*[[GameTime]] - This script rotates a directional light to match the rotation of the sun based on the system time.
*[[GPS Global Positioning System]] - This script simulates a GPS device providing real world GPS locations based on a reference point
*[[Gravity]] - Simulates body-to-body gravity (i.e. planetary gravity)
*[[IMU Inertial Measurement Unit]] - This script simulates an IMU providing velocities and accelerations of the object it is attached to in the objects local frame.
*[[SICK Laser Scanner]] - This script simulates the SICK LMS type planar laser scanner
*[[Trajectory Simulation]] - Demonstrates simulating the trajectory of a launched object

= Networking =

== WWW Scripts ==

*[[CookieCutter]] - Access browser cookies from Unity web players.
*[[GetXMLHack]] - Get XML data into the web player using browser script instead of WWW() (which has been buggy for me!)
*[[MeshSerializer]] - Save Unity meshes to files for the Web, load them with WWW interface.
*[[PlayerPrefsx]] - ( '''Now obsolete in Unity 2.1''') An extension to CookieCutter which allows you to save data in both standalones and cookies for the web without having to think about it.
*[[Server Side Highscores]] - A complete tutorial for implementing a server side php script for storing high scores and how to post the scores to the server.
*[[UnityObject]] - A nice & clean way to embed .unityweb in your web browser. Plugin Detection, Communication, Clean HTML
*[[VersionCheck]] - A very basic version checker. This can be used to check if the version of the game the user is running is the latest, and if not, send them to a URL to download the latest.

== Unity 1.x Networking Scripts ==

*[[NetworkCursor]] - Serverless realtime networking. An example where one Unity instance controls another via a TCP/IP socket. Could be expanded to do many types of realtime networking.
*[[Sender]] - Uses a Server to send data from the parent object to whatever is on the other end of the connection.
*[[Server]] - TCP network host, based on NetworkCursor, but expanded to do more.
*[[Simple TCP/IP Client - Server]] - This contains source code for C# that you can use to create a server for Windows and a DLL in C# that you can use with Unity

= Sound =

*[[JukeboxController]] - A very basic jukebox class. This can be used to manage multiple audio clips across different levels.
*[[Loudness]] - A simple improvement for volume control.
*[[SmoothAudioLoop]] - Allows for audio files with extended "tails" to be looped.

= Development =

== Debugging Scripts ==

*[[DetectLeaks]] - a simple GUI script for displaying the amount of objects currently loaded by type
*[[DebugConsole]] - A script to allow scrolling feedback from your scripts.
*[[DebuggerX]] - A simple javascript singleton that allows you to send debug to the console or the GUI
*[[Reporter]] - a simple delayed action system info script that could be used for support purposes
*[[UUnit]] - a Simple xUnit framework that can be run inside Unity.

== Performance Scripts ==

*[[StaticPerformanceOptimization]] - A script that optimizes performance statically based on the users graphics card by dropping terrain resolution and quality settings

== Editor Scripts ==

*[[AddChild]] - Adds an empty GameObject as a child of each selected object.
*[[AddComponentRecursively]] - Adds a component to an object, and all the children of that object.
*[[CopyTransform]] - Copies the local transform of the selected game instance in the scene and then pastes it into another one you select.
*[[DeleteComponentsInChildren]] - Helps to delete a special type of components which are attached to the children of the selected Gameobject.
*[[FindObjects]] - Find objects by name or attached component type.
*[[GetSize]] - Get the size in game units of a selection.
*[[HeightmapFromTexture]] - Applies a selected texture as a heightmap to the active terrain.
*[[InsertParent]] - An alternative to the built-in Make Parent command, this script inserts a new GameObject which becomes the parent of all selected objects.
*[[Notes]] - Allows you to add notes to any GameObject.
*[[PixelLightMapper]] - A pixel based light mapper for Unity
*[[Skybox Generator]] - Generates the 6 images necessary to create a Skybox in Unity.
*[[SnapToGrid]] - Snaps objects to a grid in 3 dimensions.
*[[Take3DScreenshot]] - Take a "3d screenshot"; a series of screenshots captured while rotating around a given object. Useful for QTVR creation.
*[[ToggleActiveRecursively]] - Activates/deactivates entire hierarchies at once.

= External Links =

*[http://code.google.com/p/opensteerdotnet/ opensteer .NET]
*[http://ctrl-j.com.au/pages/jcarsrc.html Ctrl-J Sample Projects (wheel collider car and other stuff)]

FileBrowser

2008-10-02T21:01:55Z

AngryAnt: New page: By AngryAnt. == Description == Implements a crude file browser in unity 2.0 GUI. This code uses the SelectList script. == Component code == <csharp>public static bool FileBrowser( ...

By AngryAnt.

== Description ==

Implements a crude file browser in unity 2.0 GUI. This code uses the [[SelectList]] script.

== Component code ==

<csharp>public static bool FileBrowser( ref string location, ref Vector2 directoryScroll, ref Vector2 fileScroll )
{
bool complete;
DirectoryInfo directoryInfo;
DirectoryInfo directorySelection;
FileInfo fileSelection;
int contentWidth;

// Our return state - altered by the "Select" button
complete = false;

// Get the directory info of the current location
fileSelection = new FileInfo( location );
if( fileSelection.Attributes == FileAttributes.Directory )
{
directoryInfo = new DirectoryInfo( location );
}
else
{
directoryInfo = fileSelection.Directory;
}

if( location != "/" && GUI.Button( new Rect( 10, 20, 410, 20 ), "Up one level" ) )
{
directoryInfo = directoryInfo.Parent;
location = directoryInfo.FullName;
}

// Handle the directories list
GUILayout.BeginArea( new Rect( 10, 40, 200, 300 ) );
GUILayout.Label( "Directories:" );
directoryScroll = GUILayout.BeginScrollView( directoryScroll );
directorySelection = BehaveLibrary.Resources.SelectList( directoryInfo.GetDirectories(), null ) as DirectoryInfo;
GUILayout.EndScrollView();
GUILayout.EndArea();

if( directorySelection != null )
// If a directory was selected, jump there
{
location = directorySelection.FullName;
}

// Handle the files list
GUILayout.BeginArea( new Rect( 220, 40, 200, 300 ) );
GUILayout.Label( "Files:" );
fileScroll = GUILayout.BeginScrollView( fileScroll );
fileSelection = BehaveLibrary.Resources.SelectList( directoryInfo.GetFiles(), null ) as FileInfo;
GUILayout.EndScrollView();
GUILayout.EndArea();

if( fileSelection != null )
// If a file was selected, update our location to it
{
location = fileSelection.FullName;
}

// The manual location box and the select button
GUILayout.BeginArea( new Rect( 10, 350, 410, 20 ) );
GUILayout.BeginHorizontal();
location = GUILayout.TextArea( location );

contentWidth = ( int )GUI.skin.GetStyle( "Button" ).CalcSize( new GUIContent( "Select" ) ).x;
if( GUILayout.Button( "Select", GUILayout.Width( contentWidth ) ) )
{
complete = true;
}
GUILayout.EndHorizontal();
GUILayout.EndArea();

return complete;
}
</csharp>

== Usage ==

<csharp> public void FileBrowserWindow( int idx )
{
if( FileBrowser( ref location, ref directoryScroll, ref fileScroll ) )
{
fileBrowser = false;
}
}

public void OnGUI()
{
if( fileBrowser )
{
GUI.Window( 0, new Rect( ( Screen.width - 430 ) / 2, ( Screen.height - 380 ) / 2, 430, 380 ), FileBrowserWindow, "Browse" );
return;
}
}
</csharp>

Extensions

2008-10-02T10:19:49Z

AngryAnt: /* .NET Plugins */

{| align="right"
| __TOC__
|}

These extensions, or ''plugins'', allow you to add special features to your unity projects without the hassle of writing them yourself from the ground up.

== .NET Plugins ==

.NET plugins are simply DLLs which have been built from Mono/.NET source code. When your project is built, they are merged with the compiled Mono code from your project's scripts. This means that you can use them with a Unity Indie licence as well as with Pro and in web players.

==== Cross-Platform Plugins ====

*[http://angryant.com/path.html Path] - Add pathfinding to your unity projects. Path implements the A* algorithm on NavMeshes, using multi-threading and several optimisation tricks to reduce calculation time.

*[http://angryant.com/behave.html Behave] - Via an editor extension and a runtime library, this project implements behaviour trees in unity for AI decision making. It features an easy to use drag-and-drop design interface and compiles designed behaviour trees are compiled to .NET plugins with a simple, but versatile runtime interface.

==== Mac OS X Only Plugins ====

No entries yet.

== Native Code Plugins ==

Native code plugins can be written in many languages, including C and C++. A Unity Pro licence is required to use these plugins. This kind of plugin can only be used in the editor and in standalone builds. The web player is prevented from using them for security reasons.

The Unity documentation outlines how native code plugins are made [http://unity3d.com/support/documentation/Manual/Plugins.html here].

==== Cross-Platform Plugins ====

*[[QTPlayback]] - Play any QuickTime movie to a texture with synchronized sound.

==== Mac OS X Only Plugins ====

*[[AudioInput]] - Use AudioInput.Volume to provide microphone or other audio input to your Unity projects.

*[[HtmlTexturePlugin]] - Display an HTML page as a texture, for use on a mesh or in a GUI.

*[[UniWii]] - Use Wiimotes as input devices.

[[Category:.NET Plugins]]
[[Category:Native Code Plugins]]

User:AngryAnt

2008-10-01T18:01:46Z

AngryAnt: New page: [http://angryant.com AngryAnt.com]

[http://angryant.com AngryAnt.com]

Main Page

2008-10-01T17:32:54Z

AngryAnt: /* Main Sections */

[[Image:Splash.jpg]]

== Support UnifyWiki ==
[http://www.dreamhost.com/donate.cgi?id=9231 Donate towards hosting of this wiki!]
== Welcome to the UnifyWiki ==

The UnifyWiki is part of the [http://unifycommunity.com Unify Community] experience and is a place to find and share [http://otee.dk/unity Unity] knowledge. Special thanks to [[User:Aarku|Aarku]], [[User:Dho|Dho]], [[User:NCarter|NCarter]], [[User:KeliHlodversson|Freyr]], [[User:Outcast|Outcast]] and others.

We're currently working on [[Special:Statistics|{{NUMBEROFARTICLES}}]] [[Special:Allpages|articles]] about Unity and related subjects.

Please see the [[:Talk:Main Page|discussion page]] of the main page for current goals and status. '''Please read these [[:Help:Contents|general guidelines]] before you begin editing.'''

To create a new page, add a link to an existing page, then follow the link and edit the new page. It's a good idea to copy the layout from an existing page initially, to ensure that your contribution matches the conventions used in our existing articles. If you just want to experiment, you can do so in the [[:Unify Community Wiki:Sandbox|sandbox]].

== News ==

* Added cutting edge Captcha (now with angled lines!) to the Sign Up process. This should (hopefully) cut down on all those wonderful Wow Gold Mining opportunity posts we've been deleting.

* The wiki has changed homes again. The new server should be faster, it is much larger, and UT is providing backup off the server, Thanks! But as always moves are not simple things. When you find broken things feel free to contact Jeff (guategeek) Neil (Ncarter) Jon (Aarku) or David Helgason so we can try get them fixed ASAP. Thanks again for all the great stuff you guys are posing here.

* It is now possible to upload '''zip''' archives to the Unify wiki. We encourage you to provide a zipped copy of your script or shader when adding a new article, as this will help to avoid the bug in Safari which inserts garbage characters into text which is copied and pasted from these pages.

* The maximum file size for any uploaded file is now '''256KB''', and this includes images as well as zip files. Unfortunately, '''unityPackage''' files are not directly supported at present, as we have been unable to make MediaWiki recognise the unusually long filename extension. If you wish to add a unityPackage to the wiki, please zip it first.

''Known problem: the page which appears when you upload a file is mangled, but the image upload will still work successfully. We will try to fix this as soon as possible.''

== Call for Article Requests ==
Please see the [[:Talk:Main Page|discussion page]] of the main page to add your requests for scripts, shaders, tips, or wizards.

== Main Sections ==

* [[Script Archive|Script Archive]] - Scripts for everything from general purpose effects to debugging.

* [[Shader Archive|Shader Archive]] - Specialised shaders to make your materials more refined.

* [[Tips|Tips and Tricks]] - Tips and tricks for Unity and related applications.

* [[Wizard Archive|Wizard Archive]] - Wizard scripts to extend the Unity editor.

* [[Tutorials|Tutorials Archive]] - Tutorials for all things Unity. These are usually of larger scope than [[Tips|Tips and Tricks]].

* [[Extensions|Extensions Archive]] - Extensions for extending the functionality of unity - allowing you to add special features to your projects with relatively little code. This archive includes both .NET plugins (for both indie and pro licensees and webplayer projects) and regular plugins (pro-only feature, not available for webplayer projects).

* [[Unify Community Wiki:Community Portal|Community Portal]] - Your portal to the Unity community.

* [[Unity Projects|Unity Projects]] - Community development efforts to extend Unity.

* [[User Contests|User Contests]] - User contests for fun & fame!

----

Please see [http://meta.wikipedia.org/wiki/MediaWiki_i18n documentation on customizing the interface]
and the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide MediaWiki User's Guide] for usage and configuration help.

Plugins

2008-10-01T17:29:08Z

AngryAnt:

This content is deprecated. Original content moved to [[Extensions]].

Plugins require Unity Pro.

== Cross-Platform Plugins ==

*[[QTPlayback]] - Play any QuickTime movie, including synchronized sound, for which you have a codec installed, back to a texture.

== Mac OS X Only Plugins ==

*[[AudioInput]] - This plugin lets you simply use AudioInput.Volume to provide micrphone or other audio input to your Unity projects.

*[[HtmlTexturePlugin]] - This plugin lets you display an HTML page as a texture, for use on a mesh or in a GUI.

* [[UniWii]] - This plugin lets you use Wiimotes as input devices.

Extensions

2008-10-01T17:28:15Z

AngryAnt:

Extensions or Plugins allow you to extend the functionality of unity - adding special features to your unity projects without the hazzle of writing them yourself from the ground up.

== .NET plugins ==

.NET plugins differ from regular plugins in that they're essentially just .NET assemblies in plugin form. They are, when your project is built, merged with the compiled .NET code from your project scripts. This means that you can use them on a unity indie license as well as pro and in webplayers.

==== Cross-Platform Plugins ====

*[http://angryant.com/path.html Path] - Add pathfinding to your unity projects. Path implements the A* algorithm on NavMeshes, using multi-threading and several optimisation tricks to reduce calculation time.

*[http://angryant.com/behave.html Behave] - Via an editor extension and a runtime library, this project implements behaviour trees in unity for AI decision making. It features an easy to use drag-drop design interface and compiles designed behaviour trees are compiled to .NET plugins with a simple, but versatile runtime interface.

==== Mac OS X Only Plugins ====

No entries yet.

== Plugins ==

Regular plugins can be written in many languages - for instance C or C++. A unity pro license is required to use these plugins. Also they will not function in webplayers.

==== Cross-Platform Plugins ====

*[[QTPlayback]] - Play any QuickTime movie, including synchronized sound, for which you have a codec installed, back to a texture.

==== Mac OS X Only Plugins ====

*[[AudioInput]] - This plugin lets you simply use AudioInput.Volume to provide micrphone or other audio input to your Unity projects.

*[[HtmlTexturePlugin]] - This plugin lets you display an HTML page as a texture, for use on a mesh or in a GUI.

* [[UniWii]] - This plugin lets you use Wiimotes as input devices.

Extensions

2008-10-01T17:27:34Z

AngryAnt:

Extensions or Plugins allow you to extend the functionality of unity - adding special features to your unity projects without the hazzle of writing them yourself from the ground up.

== .NET plugins ==

.NET plugins differ from regular plugins in that they're essentially just .NET assemblies in plugin form. They are, when your project is built, merged with the compiled .NET code from your project scripts. This means that you can use them on a unity indie license as well as pro and in webplayers.

*[http://angryant.com/path.html Path] - Add pathfinding to your unity projects. Path implements the A* algorithm on NavMeshes, using multi-threading and several optimisation tricks to reduce calculation time.

*[http://angryant.com/behave.html Behave] - Via an editor extension and a runtime library, this project implements behaviour trees in unity for AI decision making. It features an easy to use drag-drop design interface and compiles designed behaviour trees are compiled to .NET plugins with a simple, but versatile runtime interface.

== Plugins ==

Regular plugins can be written in many languages - for instance C or C++. A unity pro license is required to use these plugins. Also they will not function in webplayers.

==== Cross-Platform Plugins ====

*[[QTPlayback]] - Play any QuickTime movie, including synchronized sound, for which you have a codec installed, back to a texture.

==== Mac OS X Only Plugins ====

*[[AudioInput]] - This plugin lets you simply use AudioInput.Volume to provide micrphone or other audio input to your Unity projects.

*[[HtmlTexturePlugin]] - This plugin lets you display an HTML page as a texture, for use on a mesh or in a GUI.

* [[UniWii]] - This plugin lets you use Wiimotes as input devices.

Extensions

2008-10-01T17:27:17Z

AngryAnt:

Extensions or Plugins allow you to extend the functionality of unity - adding special features to your unity projects without the hazzle of writing them yourself from the ground up.

== .NET plugins ==

.NET plugins differ from regular plugins in that they're essentially just .NET assemblies in plugin form. They are, when your project is built, merged with the compiled .NET code from your project scripts. This means that you can use them on a unity indie license as well as pro and in webplayers.

*[http://angryant.com/path.html Path] - Add pathfinding to your unity projects. Path implements the A* algorithm on NavMeshes, using multi-threading and several optimisation tricks to reduce calculation time.

*[http://angryant.com/behave.html Behave] - Via an editor extension and a runtime library, this project implements behaviour trees in unity for AI decision making. It features an easy to use drag-drop design interface and compiles designed behaviour trees are compiled to .NET plugins with a simple, but versatile runtime interface.

== Plugins ==

Regular plugins can be written in many languages - for instance C or C++. A unity pro license is required to use these plugins. Also they will not function in webplayers.

==== Cross-Platform Plugins ====

*[[QTPlayback]] - Play any QuickTime movie, including synchronized sound, for which you have a codec installed, back to a texture.

==== Mac OS X Only Plugins ====

*[[AudioInput]] - This plugin lets you simply use AudioInput.Volume to provide micrphone or other audio input to your Unity projects.

*[[HtmlTexturePlugin]] - This plugin lets you display an HTML page as a texture, for use on a mesh or in a GUI.

* [[UniWii]] - This plugin lets you use Wiimotes as input devices.

Extensions

2008-10-01T17:26:49Z

AngryAnt:

Extensions or Plugins allow you to extend the functionality of unity - adding special features to your unity projects without the hazzle of writing them yourself from the ground up.

== .NET plugins ==

.NET plugins differ from regular plugins in that they're essentially just .NET assemblies in plugin form. They are, when your project is built, merged with the compiled .NET code from your project scripts. This means that you can use them on a unity indie license as well as pro and in webplayers.

*[http://angryant.com/path.html Path] - Add pathfinding to your unity projects. Path implements the A* algorithm on NavMeshes, using multi-threading and several optimisation tricks to reduce calculation time.

*[http://angryant.com/behave.html Behave] - Via an editor extension and a runtime library, this project implements behaviour trees in unity for AI decision making. It features an easy to use drag-drop design interface and compiles designed behaviour trees are compiled to .NET plugins with a simple, but versatile runtime interface.

== Plugins ==

Regular plugins can be written in many languages - for instance C or C++. A unity pro license is required to use these plugins. Also they will not function in webplayers.

==== Cross-Platform Plugins ====

*[[QTPlayback]] - Play any QuickTime movie, including synchronized sound, for which you have a codec installed, back to a texture.

==== Mac OS X Only Plugins ====

*[[AudioInput]] - This plugin lets you simply use AudioInput.Volume to provide micrphone or other audio input to your Unity projects.

*[[HtmlTexturePlugin]] - This plugin lets you display an HTML page as a texture, for use on a mesh or in a GUI.

* [[UniWii]] - This plugin lets you use Wiimotes as input devices.