Code Snippets

From a previous post, here's one way to do away teams:

<start>
<set_variable name="awayteam" value="0"/>
</start>

<!-- Send over the Away team -->

<event>
<if_variable name="awayteam" comparator="<" value="1"/>
<if_distance name1="Artemis" name2="targetShip" comparator="<" value="5000"/>
<if_object_property name="targetShip" property="shieldStateFront" comparator="<" value="20"/>
<incoming_comms_text from="Commander Ryan">
This is Commander Ryan to Artemis.^
My team is aboard the target vessel now, and^
our mission is underway. We expect it will^
only take about a minute for us to override^
the ship's central computer. Stay within^
5000 km to maintain a lock on the away team^
and be ready to beam us back in 60 seconds.^
Also, if you could not blow up the ship with^
us still aboard it, I'd appreciate it.^
Ryan out.^ ^ ^
</incoming_comms_text>
<log text="Away team deployed."/>
<set_timer name="awaytimer" seconds="60"/>
<warning_popup_message message="Away team deployed. Do not destroy targetShip" consoles="W"/>
<warning_popup_message message="Away team deployed. Stay withing 5000 km of targetShip" consoles="H"/>
<set_variable name="awayteam" value="1"/>
</event>


<!-- The target ship was blown up with the Away team aboard! -->

<event>
<if_variable name="awayteam" comparator="=" value="1"/>
<if_object_property name="targetShip" property="hullDamageFront" comparator="<" value="1"/>
<incoming_comms_text from="Commander Ryan">
She's breaking up! She's brea--**SIGNAL LOST**^ ^ ^
</incoming_comms_text>
<warning_popup_message message="Contact Lost with Away team" consoles="C"/>
<log text="Away team lost."/>
<set_variable name="awayteam" value="3"/>
<end_mission>
</event>


<!-- Too far away from Away Team to maintain contact -->

<event>
<if_variable name="awayteam" comparator="=" value="1"/>
<if distance name1="Artemis" name2="targetShip" comparator=">" value="5000"/>
<incoming_comms_text from="Commander Ryan">
... say again... temi... nder Rya...^
ost... signa... eavy fire... reques...^
...diat extractio-- **SIGNAL LOST**^ ^ ^
</incoming_comms_text>
<warning_popup_message message="Contact Lost with Away team" consoles="C"/>
<log text="Away team lost."/>
<set_variable name="awayteam" value="3"/>
<end_mission>
</event>


<!-- They've been recovered! -->

<event>
<if_variable name="awayteam" comparator="=" value="1"/>
<if_timer_finished name="awaytimer"/>

<incoming_comms_text from="Commander Ryan">
This is Commander Ryan to Artemis.^
Our mission was successful, and we're ready^
to come home, Artemis.^ ^ ^
</incoming_comms_text>
<warning_popup_message message="Away team recovered" consoles="C"/>
<set_object_property name="targetShip" property="hasSurrendered" value="1"/>
<set_object_property name="targetShip" property="willAcceptCommsOrders"/>
<set_variable name="awayteam" value="2"/>
<log text="Away team recovered."/>
</event>

Here's a way to do SFB-style plasma torpedoes:

<!-- put this in either the start block or the enemyShip1 creation event -->
<set_timer name="torpedoCharged" seconds="60"/>
<!-- That should do it. Note that you could probably set a limited amount of torpedoes here, too -->


<!-- Torpedoes charged and in firing distance -->
<event>
<if_variable name="torpedoCharged" comparator="=" value="1"/>
<if_distance name1="enemyShip1" name2="Artemis" comparator="<" value="5000"/>
<!-- Not sure if this next one will ever be valid, but ideally it will allow the enemy to fire if torpedoes are less than 50% damaged -->
<if_object_property name="enemyShip1" property="systemDamageTorpedo" comparator="<" value=".5"/>
<if_timer_finished name="torpedoLoaded"/>
<create type="genericMesh" x="0" y="-5" z="0" name="plasmaTorpedo1" hullType="plasmaTorpedo1" meshFileName="plasmaTorp.dxs" textureFileName="plasmaTorp.png"/>
<copy_object_property name1="enemyShip1" name2="plasmaTorpedo1" property ="angle"/>
<copy_object_property name1="enemyShip1" name2="plasmaTorpedo1" property ="x"/>
<copy_object_property name1="enemyShip1" name2="plasmaTorpedo1" property ="z"/>
<set_object_property name="plasmaTorpedo1" property="turnRate" value="0.001"/>
<direct name="plasmaTorpedo1" targetName="Artemis" scriptThrottle=".85"/>
<set_timer name="torpedoCharged" seconds="60"/>
<set_timer name="torpedoLifespan" seconds="10"/>
</event>


<!-- The torpedo hits! -->
<event>
<if_distance name1="plasmaTorpedo1" name2="Artemis" comparator="LESS" value ="100"/>
<!-- Damage everything and destroy shields -->
<destroy name="plasmaTorpedo1"/>
<play_sound_now filename="plasmaTorpHits.wav">
<set_object_property name="Artemis" property="shieldStateFront" value="0"/>
<set_object_property name="Artemis" property="shieldStateBack" value="0"/>
<set_player_grid_damage systemType="systemBeam" value="0.3" index="3"/>
<set_player_grid_damage systemType="systemTorpedo" value="0.3" index="3"/>
<set_player_grid_damage systemType="systemTactical" value="0.3" index="3"/>
<set_player_grid_damage systemType="systemTurning" value="0.3" index="3"/>
<set_player_grid_damage systemType="systemImpulse" value="0.3" index="3"/>
<set_player_grid_damage systemType="systemWarp" value="0.3" index="3"/>
<set_player_grid_damage systemType="systemFrontShield" value="0.3" index="3"/>
<set_player_grid_damage systemType="systemBackShield" value="0.3" index="3"/>
</event>


<!-- Torpedo expires/dies out -->
<event>
<if_timer_finished name="torpedoLifespan"/>
<!-- If you were really ambitious, you could create a mine here, too -->
<destroy name="plasmaTorpedo1"/>
</event>

y-Position Stabilization


Here's a tiny little thing I made for use in a giant asteroid field that I created to have a 3D aspect by making some of the asteroids have positive or negative Y values:

<event>
<if_variable name="yReset" comparator="!=" value="1"/>
<set_object_property name="player" property="positionY" value="0"/>
<set_timer name="yTimer" seconds="0.2"/>
<set_variable name="yReset" value="1"/>
</event>

<event>
<if_timer_finished name="yTimer"/>
<set_variable name="yReset" value="0"/>
</event>

That will keep the player ship from sliding "up" and "down" when they bump into asteroids. It's nothing nearly as grandiose as your code, but it makes asteroid fields easier (and better looking) to traverse.

It's nothing nearly as grandiose as your code, but it makes asteroid fields easier (and better looking) to traverse.

I promise you, Vorus, you will never ever hear me complain about someone's code being too elegant or efficient. Trust me on this. In the words of Martin Golding:

Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live.

LOL!

Good advice, actually.

Tractor Beam


Here's a piece of code that will allow you to "tractor" another object around. This was first used by Mike, as far as I know, so I didn't invent the idea. Anyway, you'd need something to trigger the "tractorRdy" variable, and a trigger to turn it off, like when you get to a destination, but this will do the basic job.

<event>
<if_variable name="tractorRdy" comparator="=" value="1"/>
<if_variable name="tractoring" comparator="!=" value="1"/>
<if_distance name1="OBJECT" name2="player" comparator="<=" value="220"/>
<warning_popup_message message="Tractor beam locked on" consoles="W"/>
<set_variable name="tractoring" value="1"/>
</event>

<event>
<if_variable name="tractoring" comparator="=" value="1"/>
<!-- This makes it so that the tractor only turns on when you are facing away from your target -->
<if_distance name1="OBJECT" name2="player" comparator=">" value="220"/>
<set_relative_position name1="player" name2="OBJECT" angle="180" distance="220"/>
</event>

Creating a random variable


Here is something that I made for a mission I,m working on. This sets up a random variable, so that you can do checks against it later, and do any number of things, based on how that random "dice roll" turned out. I used it to place an object, so that the player wouldn't know exactly where it was.

<event>
<if_variable name="dummyValueDone" comparator="!=" value="1"/>
<set_variable name="dummyValue" randomIntHigh="100" randomIntLow="1"/>
<set_variable name="finalValue" value="0"/>
<set_variable name="dummyValueDone" value="1"/>
</event>

<!-- set a Location variable based on the random variable. We can now test against that variable. -->
<event>
<if_variable name="dummyValueDone" comparator="=" value="1"/>
<if_variable name="dummyValueChecked" comparator="!=" value="1"/>
<if_variable name="dummyValue" comparator=">=" value="1"/>
<if_variable name="dummyValue" comparator="<" value="26"/>
<set_variable name="finalValue" value="1"/>
<set_variable name="dummyValueChecked" value="1"/>
</event>

<event>
<if_variable name="dummyValueDone" comparator="=" value="1"/>
<if_variable name="dummyValueChecked" comparator="!=" value="1"/>
<if_variable name="dummyValue" comparator=">=" value="26"/>
<if_variable name="dummyValue" comparator="<" value="51"/>
<set_variable name="finalValue" value="2"/>
<set_variable name="dummyValueChecked" value="1"/>
</event>

<event>
<if_variable name="dummyValueDone" comparator="=" value="1"/>
<if_variable name="dummyValueChecked" comparator="!=" value="1"/>
<if_variable name="dummyValue" comparator=">=" value="51"/>
<if_variable name="dummyValue" comparator="<" value="76"/>
<set_variable name="finalValue" value="3"/>
<set_variable name="dummyValueChecked" value="1"/>
</event>

<event>
<if_variable name="dummyValueDone" comparator="=" value="1"/>
<if_variable name="dummyValueChecked" comparator="!=" value="1"/>
<if_variable name="dummyValue" comparator=">=" value="76"/>
<if_variable name="dummyValue" comparator="<" value="101"/>
<set_variable name="finalValue" value="4"/>
<set_variable name="dummyValueChecked" value="1"/>
</event>

What that gives you is a variable named finalValue that can have the value of 1, 2, 3 or 4. You can then check to see what the value of it is with a simple "<if_variable name="finalValue" comparator="=" value="NUMBER"/> line, and do whatever you want based on which number it is.

This isn't anything fancy, but having it here will at least might save someone time having to write it themselves.

Tracking Score


Probably a lot of scripters have their own way of keeping track of players' scores through the mission, but here's how I do it. Create an enemy Elite in one corner of the map, I used the upper-right in this example. Make this enemy invisible to LRS, the main screen, and SCI. That way he can only be seen if the player is RIGHT on top of him. This is step one, as seen here:

<create type ="enemy" x="0" y="0" z="0" name="Score" hulltype="30" fleetnumber="99" angle="90" elite="1"/>
<set_object_property name="Score" property="elite" value="1"/>
<set_object_property name="Score" property="eliteAIType" value="0"/>
<set_object_property name="Score" property="eliteAbilityBits" value="7"/>

Next, make sure he can't move, turn or be killed:

<event>
<if_exists name="Score"/>
<set_object_property name="Score" property="topSpeed" value="0.00001"/>
<set_object_property name="Score" property="turnRate" value="0.00001"/>
<set_object_property name="Score" property="shieldStateFront" value="100"/>
<set_object_property name="Score" property="shieldStateBack" value="100"/>
</event>

If you are really concerned about the fourth wall, you could even create a zone around him that the player can't enter, like this maybe:

<if_inside_sphere name="Artemis" centerX="0" centerY="0" centerZ="0" radius="2000"/>
<set_object_property name="Artemis" property="positionX" value="2500"/>
<set_object_property name="Artemis" property="positionZ" value="2500"/>

But for scoring purposes, you just put in a line like this when the player accomplishes something good:

<addto_object_property name="Score" property="positionY" value="100"/>

Use a value of 100 because even though you set the ship to never move, it will wiggle a bit, so real fine values like single digits won't work. (You might be able to get away with 10s, but I went with 100s to be safe.) Since you are using the Y axis, the ship should not move much on the map.

You could also have things that detract from the score by just adding a -100.

At the end of the game, you can find out the score, and let the player know how they did like so:

<event>
<if_variable name="endMission" comparator="=" value="1"/>
<if_variable name="gameOver" comparator="!=" value="1"/>
<if_object_property name="Score" property="positionY" comparator="<" value="50"/>
<big_message title="Mission Complete" subtitle1="Score 0/10" subtitle2="You didn't accomplish anything"/>
<set_timer name="endMissionTimer" seconds="20"/>
<set_variable name="gameOver" value="1"/>
<set_variable name="gameScore" value="0"/>
</event>

For each 100 that you move the ship, they get 1 point. You check the value of "positionX" from the 50s instead of even 100s to account for the wiggling I mentioned earlier. So a score of 1 would have the lines:

<if_object_property name="Score" property="positionY" comparator=">" value="50"/>
<if_object_property name="Score" property="positionY" comparator="<=" value="150"/>

and so on. That's pretty much all you need, just create a separate event to check for each point value, up to your max, and display the appropriate info to the player.


<EDIT> Edited to use the more logical Y axis.

Nice work, Vorus! You know, come to think of it, you could probably track two other variables by manipulating the Y and Z values, too-- maybe like enemy scores, for example.

Ooooh, good point!

Actually, it might even be better to use the Y axis as the main score anyway, because then you aren't moving the ship on the map. And then use the other two axes for other scores. But either way, an enemy score counter is a very cool idea.

about the score item.
could one use the "roation" of the object to keep score? this would keep the generic mesh in one location?

pitch/roll/yaw would cover three variables....

Yeah that should work. I haven't ever used those properties, but I assume they work. Good idea! You'd probably still have to adjust and test them by more than single digits, though, so there might not be as much 'room', since you'd max out at a value of 360. But if you could adjust and test the values by 10s reliably, it would work.

since you'd max out at a value of 360

wonder if you could check this.
it may well just be a blind counter, 720 is a valid angle ...

This is a very cool topic. I may very well use some of these. And some very clever stuff. I especially like the Heroic DamCon team deaths. :D

wonder if you could check this.
it may well just be a blind counter, 720 is a valid angle ...

You're right, that works too, I just tried it. Sweet.