Rod 3D Scripting Introduction

Script Functions

If you understand the basics and scripting follow this link to the complete list of Rod 3D scripting functions.

Scripting Explained

Rod 3D uses a C style scripting language based on the AngelScript library.

A large number of functions have been developed for the game allowing for a vast amount of posibilites and truely dynamic missions.

How The Script Works

There are up to 2 scripts active at any time, the game script always runs whereas the map script is optional.

Game Script

The game script (base\game\game.c) controls the actual game including all weapons, damage, object death behaviour and more.  The game script is generally event driven meaning that the game automatically runs known functions in the script (for example: "OnFireWeapon" is run whenever a weapon is fired or "OnProjectileHit" for when a projectile hits something).

It is essentially possible to create a whole new game by customising this script.

Map Script

Each game map can have its own map script that contains map specific functions.  Interestingly a game script function can be recreated (with the same function name)  in a map script as Rod will look in the map script first.

An example of a  typical map script event is "OnWaypointReached_10" for when an object reaches a waypoint 10 on the map.

Map Script Example:

• Create a map called whatever.map, add a waypoint and a few sheep and then bind the sheep to waypoint (right click on the sheep in the map editor to bind).
• Create a text file called whatever.c in the same folder as the map.
• Enter the following code into the script:...

void OnWaypointReached_1( int ObjectId) { SC_SetObejctHits( ObjectId, 0); }

When you run the map the sheep will walk to the waypoint and then die because SC_SetObjectHits sets the sheep's hit points to 0.

How it Works

Given the line of code below...

void OnWaypointReached_1( int ObjectId)

• 1 represents the waypoint ID that was reached by the object that fired the event.  For example to use waypoint 23 use OnWaypointReached_23( int Objectid).
• ObjectId is a variable that is automatically populated with the ID of the object that fired the event.

TIP: There are plenty of examples, take a look at the existing game scripts (the .c files in the base\maps folder).
TIP: There are loads of free C editors around with syntax highlighting, PSPad, Visual C++ Express Edition and Code::Blocks to name but a few.
TIP: Press the "Toggle IDs" button on the Map Editor toolbar to display all waypoint and object IDs on the screen at once.

Coordinates

Many of the script functions use coordinates so lets understand how these work.

The coodinates in Rod 3D are as follows:

X = Grows to the East
Y = Grows with height
Z = Grows to the South

Coordinates are in pixels and not tiles.

Examples (on a map 1024 by 1024 pixels):

• An object at 0, 0, 0 is at the top left of the map at ground level.
• An object at 0, 100, 0 is at the top left of the map 100 units up in the air.
• An object at 1023, 0, 0 is at top right of the map
• An object at 1023, 0, 1023 is at the bottom right.

Hope that makes sense.

Rod 3D Documentation Index