AIRFLY/Assets/ScifiEffects

{\rtf1\ansi\ansicpg1252\deff0{\fonttbl{\f0\fnil\fcharset0 Arial;}{\f1\fnil\fcharset238{\*\fname Arial;}Arial CE;}}
{\*\generator Msftedit 5.41.21.2510;}\viewkind4\uc1\pard\lang1033\fs22 Thank you for purchasing Sci-fi Spaceship Effect\lang1038\f1 Pack\lang1033\f0 !\lang1038\f1 If you want to contact me, my mail is kalamona01@gmail.com. Feedback is appreciated!\lang1033\f0\par
\par
\par
\pard\qc\lang1038\b\f1 General\lang1033\b0\f0\par
\pard\par
The effects themselves are prefabs, you simply have to create them (I use the Instantiate command, but you might want to do it differently if you use some kind of an object pool manager). \par
\par
The effects play themselves (for example an explosion or a scanner sweep), and then they destroy themselves (mostly by using the SFE_destroyThisTimed script).\par
\par
There are some effects that generate other effects. It might be hard to understand why is this, but mostly because of modularity. Let me give you an example: there is an effect of a simple bullet. There is another effect that creates a volley of the simple bullet. So if you change the simple bullet, the volley of bullets gets changed automatically. This is mostly done either using SFE_continuousPrefabGenerator, SFE_prefabGenerator, or SFE_prefabCloner - these are variuous generator scripts that generate prefabs in different ways.\par
\par
\lang1038\f1 As you probably noticed, scripts have the "SFE_" prefix, this is to avoid collision with other scripts. For example it is highly possible there is another script called "detach" or anything.\lang1033\f0\par
\par
\pard\qc\lang1038\b\f1 Effect Categories\lang1033\b0\f0\par
\pard\par
\b Bullets\b0 - uses rigidbody with collision, and scripts that add a force, to propel itself and to collide with stuff. There is a bullet script\lang1038\f1 (SFE_BulletController)\lang1033\f0 that is responsible for creating the muzzle fire and set\lang1038\f1 s\lang1033\f0 the impact effect\lang1038\f1 , damage, speed, etc.\lang1033\f0\par
\par
\b Lasers\b0 - these use a script to do a quick raycast towards where the effect is pointed, and they draw a line\lang1038\f1 or multiple lines\lang1033\f0 to that point. \lang1038\f1 L\lang1033\f0 ine\lang1038\f1 s\lang1033\f0 might have some effects on it, for example it enlargens over time, or plays an UVanimation.\par
\par
\b Explosions \b0 - These get played when something is destroyed, most likely a bullet or an object. They sometimes create additional objects, like wrecks that fly around. These wrecks don't have collision.\par
\par
\b Multi-Effects\b0 - these effects' only job to create other effects. For example a volley of bullets or a missile swarm.\par
\par
\b MuzzleFire\b0 - They play when a bullet or laser is launched. They don't effect anything else.\par
\par
\b Misc \b0 - everything else that was not covered here\lang1038\f1 , but are full effects\lang1033\f0 . They get generated, play their stuff, and they disappear. Scanners, tractor beam, coin pickup effect, etc.\par
\par
\b Technical effects \b0 - These effects only exist to be generated by other effects, or they are obsolete and not used. For example the "scan ping", that is generated by the largeScan effect. \par
\par
\pard\qc\lang1038\b\f1 Example Scene\b0\par
\pard\par
While the example scene is just there to showcase the effects, and as written in the description, is not really a part of the product, some people find it confusing or are curious how it works. So a quick overview. I warn you, that I am not a programmer, so my solutions might be unneccessarily bloated or downright hacky.\par
\par
The soul of the scene is the \b SFE_effectCaster\b0 , that is on the scene main camera, that is under the MainCameraDummy. Trivial, huh? :)\par
\par
This script is responsible for the following stuff: \par
\par
- it moves the "cursor" object, to be always there where the mouse points. If you are fast, you can see it too, it is a very small white sphere, called MOUSE. I could've turned off its render, but didn'tdo it for some reason I already forgot.\par
\par
- There is a "shoot point" defined, the effects get generated there, the orientation of the shoot point matters.\par
\par
- There is a gui text defined, the currently played effect will be written there.\par
\par
- up and down keys change the effect currently played. There is an "inner cooldown" for changing effects and playing them. Clicking plays the effect (on the previously defined "shoot point". The effects are in a list, list length can be configured.\par
\par
- there are also 2 points defined, as 2 camera points. Space key swaps between them.\par
\par
- there is a script on the spaceship, called SFE_spaceshipScript, that follows the MOUSE object on the horizontal dimension. As mentioned, the MOUSE object follows the mouse, and is controlled by the SFE_effectCaster.\par
\par
So, that is the Effect Caster Script. Other stuff are a bit less complicated. There are objects that generate asteroids, space turrets and cocoons. These "enemy objects" all have a controller (SFE_AsteroidController or SFE_shieldedController) that set those objects' HP and handle their collision with bullets and lasers. \par
\par
Well, I hope everything is covered. Let me know if you have any questions!\par
\par
Gergely Zsolnay\par
Hydra Graphics Ltd.\par
kalamona01@gmail.com\par
\lang1033\f0\par
}