Knuckle Cracker Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
<-[[cw3:creeper_world_3|CW3 Home]] <-[[crpl:start|CRPL Home]] <-[[crpl:crpltutorial:interactive|Interacive tutorials]]\\
====== Creating a custom emitter ======

Here I'll show you how to create your custom emitter. What will it have:
    * Custom image (optional)
    * Show popup text
    * Leave something other than a PZ
    * Progressive output with limit
    * Support digitalis

I will also cover how to turn it into a slip emitter or flip emitter.\\
It won't (as that's not what an emitter should do, also remember the game should be fair to the player):
    * Create runners
    * Send spore
    * Create new emitters on death

==== Custom image ====

Let's start simple with a custom image. You can easily skip this step as the game has a special emitter image built-in. Go [[cw3:units:enemy|HERE]] or [[cw3:units:concepts|HERE]], download the emitter, open the map, go to edit -> units -> custom images, go to 64x64 and select the downloaded emitter.\\
To attach the image to a crpl core, simply double-click it and select the correct image in the image dropdown menu.

==== Basic script framework ====

We want the script to be very portable, so instead of coding the values into the script, we'll use input variables. These will be Amt, Delay, AmtIncrease, AmtMax, DeathMode and DeathAmt.
<hidden><code prpl>$Amt:10
$Delay:15
$AmtIncrease:0.1
$AmtMax:20
$DeathMode:1
$DeathAmt:"50"</code>Note that "DeathAmt" holds a string instead of a number, the game will convert these into integers at runtime when possible</hidden>\\
And as it is an emitter, simple code to make it emit Creeper.
<code prpl># Emit the saved amount of Creeper at the specified coordinates,
# but only emit so much so that the creeper level is at least as much as 'Amt', but no more
CurrentCoords <-Amt SetCreeperNoLower
# Wait the specified amount of ticks before doing anything
<-Delay Delay</code>

==== Popup text ====

You probably need a good popup text to make sure people think it's a normal emitter. Simply add these 2 lines and you're done.
<code prpl>"Amt: " <-Amt concat "
" concat "Interval: " <-Delay 30.00 div 2 Round concat concat SetPopuptext</code>

==== Leaving stuff behind ====

The hardest part probably, but the most important for huge maps, is to prevent power zone (PZ) spam.\\
This should be something the map maker should take care of himself and not be a problem you have to worry about.
Though doing things on the destruction of our custom emitter isn't that hard.

== Set PZ creation on death ==
If you would like to force a PZ to appear or perhaps not to appear, that is done easily with the following snippet:\\
<code prpl>Self CONST_CREATEPZ FALSE SetUnitAttribute</code>
Explaining in-depth what it does:\\
__//self//__: Get the current unit (the emitter we're creating);\\
__//CONST_CREATEPZ//__: A constant each CRPL core has, defines whether or not to create a PZ on death;\\
__//FALSE//__: Set the above constant to false, meaning this emitter won't drop a PZ on death (obviously can also be TRUE);\\
__//SetUnitAttribute//__: Set the defined constant of the defined unit to the defined value.
<note>It's best not to force this constant in your code and leave the decision of whether or not to leave a PZ to the map maker. A map maker can choose whether or not to leave a PZ in the options of a CRPL code.</note>

== Leaving something else behind ==
In case you're not satisfied with just a simple PZ, you can do whatever you'd like on the unit's death by defining a function called ''[[crpl:docs:func_destroyed|destroyed]]''.\\
This function is automatically called the moment the unit is destroyed.\\
Since we declared a variable called DeathAmt, lets release that much creeper upon death!
<code prpl>:destroyed 
	CurrentCoords <-DeathAmt AddCreeper</code>
<note>Functions should always be at the end of your code. Read more about functions at [[crpl:crpltutorial#defining_your_own_functions|the CRPL tutorial]].</note>
==== Progressive output ====

== Negative increment ==

FIXME
<hidden> What exactly is supposed to be put here? Progressive how? And why explain what a negative increment value would do?
> I would assume increasing the creeper emission amount e.g.<code>
if(<-Amt <-AmtMax neq)
	<-AmtIncrease 30.00 <-Delay div div <-Amt add ->Amt
endif </code> 
</hidden>

==== Digitalis support ====
Simply add this code to the file to add Digitalis support
<code>
if(CurrentCoords GetDigitalis eq0 CurrentCoords GetDigitalisGrowth 1 eq eq)
	CurrentCoords 1 SetDigitalis
endif
</code>
If there is any DigitalisGrowth //(The white Digitalis-like stuff that shows where it will grow)// under the core, Digitalis will grow.

==== Phantom/slip emitter ====

==== Flip emitter ====
Knuckle Cracker Wiki

User Tools

Site Tools

Page Tools
