marko10_000
/
openclonk
forked from Mirrors/openclonk
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add ExecutePXS script function 

Before commit 5a652f23e ("Fix missing C4PXSSystem::Clear
implementation"), ChristmasIce would keep all snow PXS between scenario
section changes. That looked pretty neat, so I'm introducing this script
function to allow properly implementing it.
install-platforms
Lukas Werling 2017-11-12 22:00:52 +01:00
parent 5a652f23ef
commit be9d3032e2
2 changed files with 63 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
docs/sdk/script/fn/ExecutePXS.xml 100644
View File

@ -0,0 +1,51 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE funcs
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<title>ExecutePXS</title>
<category>Landscape</category>
<version>8.0 OC</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>int</type>
<name>frames</name>
<desc>How many frames to execute</desc>
</param>
<param>
<type>proplist</type>
<name>callback</name>
<desc>For each executed frame, call <code>callback-&gt;Timer(i)</code>, 0 ≤ i &lt; <code>frames</code></desc>
<optional />
</param>
</params>
</syntax>
<desc>Advances PXS (flying material pixels) by the specified amount of frames. This is meant for rainy or snowy scenarios to start with a screen full of precipitation.</desc>
<remark>The <code>callback</code> parameter is chosen to allow passing simple effects.</remark>
<examples>
<example>
<code>local snowfx = new Effect
{
Timer = func()
{
<funclink>CastPXS</funclink>("Snow", 2, 0, <funclink>Random</funclink>(<funclink>LandscapeWidth</funclink>()), 0, <funclink>RandomX</funclink>(90, 270));
}
};
func Initialize()
{
var fx = <funclink>CreateEffect</funclink>(snowfx, 1, 1);
ExecutePXS(100, fx);
}</code>
<text>Creates a snowing effect and executes it for 100 frames so that the game starts with a snowy screen.</text>
</example>
</examples>
<related>
<funclink>CastPXS</funclink>
</related>
</func>
<author>Luchs</author><date>2017-11</date>
</funcs>

12
src/game/C4GameScript.cpp
View File

@ -380,6 +380,17 @@ static bool FnCanInsertMaterial(C4PropList * _this, long mat, long x, long y, C4
return true;
}
static bool FnExecutePXS(C4PropList * _this, long frames, C4PropList *callback)
{
for (long i = 0; i < frames; i++)
{
::PXS.Execute();
if (callback)
callback->Call(P_Timer, &C4AulParSet(i));
}
return true;
}
static long FnGetMaterialCount(C4PropList * _this, long iMaterial, bool fReal)
{
if (!MatValid(iMaterial)) return -1;
@ -2835,6 +2846,7 @@ void InitGameFunctionMap(C4AulScriptEngine *pEngine)
F(BlastFree);
F(InsertMaterial);
F(CanInsertMaterial);
F(ExecutePXS);
F(LandscapeWidth);
F(LandscapeHeight);
F(SetAmbientBrightness);