6thSense.eu/EG

by 6thSense.eu

A view on Multiplayer Scripting, by Sickboy

Player Object(s)

• Player is a null object on server
  
• Player is a null object in SinglePlayer intro's and outro's
• You can not verify if an object is a null object by testing: object == objNull because objNull doesn't equal anything, not even itself, you must use: isNull object
  
• To test if a certain object is a player, use: isPlayer object
  
• player is a variable, just like any other variable. A variable can contain different values. In this case the variable "player" contains an Object.
  The value of the variable "player" is:
  Server: a null object
  Clients: the object (vehicle) that represents the player on this computer
  If there are 3 player slots in game,
  player1 I name: p1
  player2 I name: p2
  player3 I name: p3
  
  then on p3's computer:
  player == p3
  you can access the other players through the variables: p1 and p2
  
  on p2's computer:
  player == p2
  and you can access the other players through the variables: p1 and p3
  etc. etc.
  
  
• To get a count of all connected players, you can use the playersNumber function
• To get a list of all (alive)player-objects in the mission, which gets updated every 5 seconds:
  

T_players = []; T_trig = createTrigger ["EmptyDetector",getArray(configFile >> "CfgWorlds" >> worldName >> "centerPosition")]; T_trig setTriggerType "NONE"; T_trig setTriggerActivation ["ANY", "PRESENT", true]; T_trig setTriggerArea [30000, 30000, 0, false ]; T_trig setTriggerStatements ["this", "", ""]; private ["_ar"]; while {true} do { _ar = []; { if (isPlayer _x) then { _ar = _ar + [_x] } } forEach (list T_trig); T_players = [] + _ar; sleep 5; }; T_Players (array) will contain the current player objects. The list is automaticly cleared of dead players or players who left.
If you execute this on every machine: { _x globalChat ("Really, My name is: " + name _x) } forEach T_Players; Then on every machine it will apear as if all players wrote "Really, My name is: (name)" in globalChat.

Join in Progress

The Basics:

• A JIP Player is a player that joins while the mission is already in progress (Join In Progress)
• What is synchronized at JIP
  • weather
  • time passed since mission start
  • all variables (+values) which were publicVariable'd before (done by publicVariable)
  • vehicleInits (set by setVehicleInit
  • the current gamestate (alive/death, position, status etc)
• What is not synchronized at JIP
  • Markers (The markers themselves and their updated properties, e.g positions (if any))
    • you can use the onPlayerConnected function to setMarkerPos the markers you wish to have updated to JIP players, this way when the player joins, the markers and their properties are transferred to the player
  • time or weather that was artificially changed; by skipTime, setDate, setOvercast and setFog
  • if the value was changed of a variable which was publicVariabled earlier on, the earlier value is synchronized, not the current
• To only run something on dedicated server or serverClient: isServer
  
• To only run something on clients, and never on dedicated server or serverClient: !isServer
  
• To only run something on clients or server Clients: !(isNull player)
  
  JIP Script example to figure out what the machine exactly is, in init.sqf or sorts:

T_INIT = false; T_Server = false; T_Client = false; T_JIP = false; if (playersNumber east+playersNumber west+playersNumber resistance+playersNumber civilian > 0) then{ T_MP = true }else{ T_MP = false }; if (isServer) then { T_Server = true; if (!(isNull player)) then { T_Client = true }; T_INIT = true; } else { T_Client = true; if (isNull player) then { T_JIP = true; [] spawn { waitUntil { !(isNull player) }; T_INIT = true }; } else { T_INIT = true; }; }; Any script that has to work with the player object will have to wait until T_INIT == true:
waitUntil { T_INIT };

Conditions to use:

• SinglePlayer: !T_MP
• MultiPlayer: T_MP
• Dedicated Server: T_Server && !T_Client
  
• Dedicated Server or ServerClient: T_Server
  
• ClientOnly: T_Client && !T_Server
  
• Client or ServerClient: T_Client
  
• Client or ServerClient, NOT JIP: T_Client && !T_JIP
  
• JIP Client: T_JIP
  
  
  

Locallity

• Players are local to their own machine
  
• AI Are local to the server, unless they are part of a team lead by a player, in that case, that AI is local to the player teamleader machine.
  
• Empty Vehicles are local to the server
  
• Controlled Vehicles are local to the machine of the driver (incase of AI, this is by default the server, incase of player, this is the player's machine. Again, if the AI is part of a group lead by a player, the vehicle will be local to the player teamleader machine)
  
• The locallity of functions is documented in the biki
  
• Functions like: Say, sideChat, globalChat, groupChat etc. etc. are executed locally. So if you want to execute them on every computer, you will have to make sure that the script runs on every computer
  
• setFuel, setDammage, setSpeed, etc. etc. effects are global, so basicly you can run the script that uses these functions on every machine, but only execute the function there where the vehicle is local, e.g: if (local _veh) then { _veh setDammage 0.5 };
  
• Triggers created in editor are global; they exist on all machines, and they run on all machines (conditions checked, onActivation/onDeActivation executed when condition is true etc)
  
• Triggers created in scripts are local and only exist/run on the machine where they got created.
  
• Most eventHandlers are local. This means that the eventHandler only executes on the machine where the unit who triggered the eventHandler, is local. Some events are global, like getIn, getOut, Fired and Init. A complete list you can find here: http://community.bistudio.com/wiki/Armed_Assault:_EventHandlers_List
  
  
  General
  
• IMHO best practice would be to keep as much as possible server sided, because this should result in the least complex scripting and least amount of data sending/receiving. Only interface elements should reside on Clients, or functionality that only interacts with the player himself or his machine.
  
• Every variable that you 'publicVariabled' will be sent to JIP players. The value of these variables do not equal the current value of the variable, but instead, the value as it was at the moment it was 'publicVariabled'.
  
• Every vehicleInit that has been set (object setVehicleInit "blablalba"; processInitCommands), is synchronized to JIP Players
  
• There is no general rule of thumb available for Join in Progress compatible scripting etc, at least not to my knowledge. Basicly it all depends on what you are making, what the functionality is, and how this relates to Multiplayer. Basicly you have to keep all the above in mind while developing for Join in Progress compatible projects.
  

Scripting Need to knows

• sleep and waitUntil
  • You can not use sleep or waitUntil directly (or in a call) inside
    • EventHandlers
    • Initfields of objects in missions
    • onActivation and onDeactivation fields of triggers
  • If you exec, execVM or spawn a script (instance) in any of the above mentioned, it is no problem to use sleep or waitUntil
  • If you use sleep or waitUntil in any script that runs at mission initialization (init.sqf, initfields etc), the script will halt at the sleep or waitUntil until after the mission is started (after briefing has passed). Only then will it continue
    • One exception: if the condition of waitUntil is true at the moment of mission initialization, the script will not halt but continue to run
• Init.sqf
  • To my knowledge, there is no way to halt the game at the briefing until all init scripts have run and are finished
    • You could however use a titleCut to blackIn and blackOut while your scripts are finishing initialization

SQF vs SQS

• sqf allows for precompiling by using compile and f.i preprocessFile (or loadFile). This means that the code is only compiled once, and saved into memory, only to call or spawn later on
• sqf can be used to create functions, functions are like [scripts] but can be used for f.i: repeating code, make calculations and return the value, etc.
  • This can save load and end in better performance, especially in situations where the same scripts and functions are ran over and over and over
• sqf allows for a nicer looking code that gives a better overview, as opposed to sqs's one lined syntax
• sqf sqf seems to generally perform better than sqs
• sqf seems more sensitive for intense operations; You must manually control the load on the system by using sleep

Interesting functions for Multiplayer

• publicVariable
• addPublicVariableEventHandler
• setVehicleInit
• processInitCommands
• clearVehicleInit
• isPlayer
• local
• onPlayerConnected
  • This can only be used once. If the command is executed twice, the latter will be 'active'
• onPlayerDisconnected
  • This can only be used once. If the command is executed twice, the latter will be 'active'

Interesting Links

• Syntax
• Scripting
• Scripting Languages: sqf sqs

You can find some more info in my answers here:

• http://www.flashpoint1985.com/cgi-bin....t=71130
  
• http://www.flashpoint1985.com/cgi-bin....6;st=15
  
• http://www.flashpoint1985.com/cgi-bin....98&st=0