User Tools

Site Tools


scripting:basics

This is an old revision of the document!


Scripting Basics

The examples below need a soldier with the name 'scripted_soldier' and a vehicle with the name 'BTR1'. Make sure these two exists in your composition.

Get an Entity

The examples below need a soldier with the name 'scripted_soldier' and a vehicle with the name 'BTR1'. Make sure these two exists in your composition.

One of the most used commands is probably 'FindEntityByName'. Whevever you want to script something in the game, you should find its entity. This is simply done by the below line.

Notice the variable name 'btr' and the entityname 'BTR1' - You have to change these variables to reflect your entity ingame.

Example 1

Get the entity of a vehicle with the name 'BTR1'

GenericEntity btr = GenericEntity.Cast(GetWorld().FindEntityByName("BTR1"));

Lets break down this line.

This is where we declare our variablename and type, where the name is 'btr' and the type is 'GenericEntity'

GenericEntity btr = 

So, the variable 'btr' wil contain the results of a combination of 2 commands.

When we break it down you'll notice these 2 commands.

GetWorld().FindEntityByName("BTR1")

GenericEntity.Cast()

Lets not get too technical, but what you need to know is that we search for the entity 'BTR1' - The result of this command is passed to the CAST function of the GenericEntity object.

GenericEntity.Cast(GetWorld().FindEntityByName("BTR1"));  

What does that mean? - it means that the result of your FindEntityByName is 'casted' (*converted) to a GenericEntity Object. And with a genericEntity object we can do things…

So, the result of the above is that we have a variable with the name 'btr' which 'type' is 'GenericEntity'

Get a CharacterEntity, and control it

scripting/basics.1660222331.txt.gz · Last modified: 2022/08/11 13:52 by jerryhopper

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki