Module Functional.Scoring
Functional - Administer the scoring of player achievements, file and log the scoring events for use at websites.
Features:
- Set the scoring scales based on threat level.
- Positive scores and negative scores.
- A contribution model to score achievements.
- Score goals.
- Score specific achievements.
- Score the hits and destroys of units.
- Score the hits and destroys of statics.
- Score the hits and destroys of scenery.
- (optional) Log scores into a CSV file.
- Connect to a remote server using JSON and IP.
Missions:
Administers the scoring of player achievements, and creates a CSV file logging the scoring events and results for use at team or squadron websites.
SCORING automatically calculates the threat level of the objects hit and destroyed by players, which can be Wrapper.Unit, Wrapper.Static objects.
Positive score points are granted when enemy or neutral targets are destroyed. Negative score points or penalties are given when a friendly target is hit or destroyed. This brings a lot of dynamism in the scoring, where players need to take care to inflict damage on the right target. By default, penalties weight heavier in the scoring, to ensure that players don't commit fratricide. The total score of the player is calculated by adding the scores minus the penalties.
The score value is calculated based on the threat level of the player and the threat level of the target. A calculated score takes the threat level of the target divided by a balanced threat level of the player unit. As such, if the threat level of the target is high, and the player threat level is low, a higher score will be given than if the threat level of the player would be high too.
When multiple players hit the same target, and finally succeed in destroying the target, then each player who contributed to the target destruction, will receive a score. This is important for targets that require significant damage before it can be destroyed, like ships or heavy planes.
Optionally, the score values can be scaled by a scale. Specific scales can be set for positive cores or negative penalties. The default range of the scores granted is a value between 0 and 10. The default range of penalties given is a value between 0 and 30.
Additional scores can be granted to specific objects, when the player(s) destroy these objects.
Various Core.Zones can be defined for which scores are also granted when objects in that Core.Zone are destroyed. This is specifically useful to designate scenery targets on the map that will generate points when destroyed.
With a small change in MissionScripting.lua, the scoring results can also be logged in a CSV file. These CSV files can be used to:
- Upload scoring to a database or a BI tool to publish the scoring results to the player community.
- Upload scoring in an (online) Excel like tool, using pivot tables and pivot charts to show mission results.
- Share scoring among players after the mission to discuss mission results.
Scores can be reported. Menu options are automatically added to each player group when a player joins a client slot or a CA unit. Use the radio menu F10 to consult the scores while running the mission. Scores can be reported for your user, or an overall score can be reported of all players currently active in the mission.
Authors: FlightControl
Contributions:
- Applevangelist: Additional functionality, fixes.
- Wingthor (TAW): Testing & Advice.
- Dutch-Baron (TAW): Testing & Advice.
- Whisper: Testing and Advice.
Global(s)
Global SCORING |
SCORING class Constructor:Set the destroy score or penalty scale:Score scales can be set for scores granted when enemies or friendlies are destroyed. |
SCORING class
Constructor:
local Scoring = SCORING:New( "Scoring File" )
Set the destroy score or penalty scale:
Score scales can be set for scores granted when enemies or friendlies are destroyed.
Use the method SCORING.SetScaleDestroyScore() to set the scale of enemy destroys (positive destroys). Use the method SCORING.SetScaleDestroyPenalty() to set the scale of friendly destroys (negative destroys).
local Scoring = SCORING:New( "Scoring File" )
Scoring:SetScaleDestroyScore( 10 )
Scoring:SetScaleDestroyPenalty( 40 )
The above sets the scale for valid scores to 10. So scores will be given in a scale from 0 to 10. The penalties will be given in a scale from 0 to 40.
Define special targets that will give extra scores:
Special targets can be set that will give extra scores to the players when these are destroyed. Use the methods SCORING.AddUnitScore() and SCORING.RemoveUnitScore() to specify a special additional score for a specific Wrapper.Units. Use the methods SCORING.AddStaticScore() and SCORING.RemoveStaticScore() to specify a special additional score for a specific Wrapper.Statics. Use the method SCORING.AddScoreSetGroup() to specify a special additional score for a specific Wrapper.Groups gathered in a Core.Set#SET_GROUP.
local Scoring = SCORING:New( "Scoring File" )
Scoring:AddUnitScore( UNIT:FindByName( "Unit #001" ), 200 )
Scoring:AddStaticScore( STATIC:FindByName( "Static #1" ), 100 )
local GroupSet = SET_GROUP:New():FilterPrefixes("RAT"):FilterStart()
Scoring:AddScoreSetGroup( GroupSet, 100)
The above grants an additional score of 200 points for Unit #001 and an additional 100 points of Static #1 if these are destroyed. Note that later in the mission, one can remove these scores set, for example, when the a goal achievement time limit is over. For example, this can be done as follows:
Scoring:RemoveUnitScore( UNIT:FindByName( "Unit #001" ) )
Define destruction zones that will give extra scores:
Define zones of destruction. Any object destroyed within the zone of the given category will give extra points. Use the method SCORING.AddZoneScore() to add a Core.Zone for additional scoring. Use the method SCORING.RemoveZoneScore() to remove a Core.Zone for additional scoring. There are interesting variations that can be achieved with this functionality. For example, if the Core.Zone is a Core.Zone#ZONE_UNIT, then the zone is a moving zone, and anything destroyed within that Core.Zone will generate points. The other implementation could be to designate a scenery target (a building) in the mission editor surrounded by a Core.Zone, just large enough around that building.
Add extra Goal scores upon an event or a condition:
A mission has goals and achievements. The scoring system provides an API to set additional scores when a goal or achievement event happens. Use the method SCORING.AddGoalScore() to add a score for a Player at any time in your mission.
(Decommissioned) Configure fratricide level.
This functionality is decommissioned until the DCS bug concerning Unit:destroy() not being functional in multi player for player units has been fixed by ED.
When a player commits too much damage to friendlies, his penalty score will reach a certain level. Use the method SCORING.SetFratricide() to define the level when a player gets kicked. By default, the fratricide level is the default penalty multiplier * 2 for the penalty score.
Penalty score when a player changes the coalition.
When a player changes the coalition, he can receive a penalty score. Use the method SCORING.SetCoalitionChangePenalty() to define the penalty when a player changes coalition. By default, the penalty for changing coalition is the default penalty scale.
Define output CSV files.
The CSV file is given the name of the string given in the SCORING.New{} constructor, followed by the .csv extension.
The file is incrementally saved in the **
local ScoringFirstMission = SCORING:New( "FirstMission" )
local ScoringSecondMission = SCORING:New( "SecondMission" )
The above documents that 2 Scoring objects are created, ScoringFirstMission and ScoringSecondMission.
*IMPORTANT!!!
In order to allow DCS world to write CSV files, you need to adapt a configuration file in your DCS world installation on the server. For this, browse to the missionscripting.lua file in your DCS world installation folder. For me, this installation folder is in D:\Program Files\Eagle Dynamics\DCS World\Scripts.
Edit a few code lines in the MissionScripting.lua file. Comment out the lines os, io and lfs:
do
--sanitizeModule('os')
--sanitizeModule('io')
--sanitizeModule('lfs')
require = nil
loadlib = nil
end
When these lines are not sanitized, functions become available to check the time, and to write files to your system at the above specified location. Note that the MissionScripting.lua file provides a warning. So please beware of this warning as outlined by Eagle Dynamics!
--Sanitize Mission Scripting environment
--This makes unavailable some unsecure functions.
--Mission downloaded from server to client may contain potentially harmful lua code that may use these functions.
--You can remove the code below and make available these functions at your own risk.
The MOOSE designer cannot take any responsibility of any damage inflicted as a result of the de-sanitization. That being said, I hope that the SCORING class provides you with a great add-on to score your squad mates achievements.
Configure messages.
When players hit or destroy targets, messages are sent. Various methods exist to configure:
- Which messages are sent upon the event.
- Which audience receives the message.
Configure the messages sent upon the event.
Use the following methods to configure when to send messages. By default, all messages are sent.
- SCORING.SetMessagesHit(): Configure to send messages after a target has been hit.
- SCORING.SetMessagesDestroy(): Configure to send messages after a target has been destroyed.
- SCORING.SetMessagesAddon(): Configure to send messages for additional score, after a target has been destroyed.
- SCORING.SetMessagesZone(): Configure to send messages for additional score, after a target has been destroyed within a given zone.
Configure the audience of the messages.
Use the following methods to configure the audience of the messages. By default, the messages are sent to all players in the mission.
- SCORING.SetMessagesToAll(): Configure to send messages to all players.
- SCORING.SetMessagesToCoalition(): Configure to send messages to only those players within the same coalition as the player.
Type(s)
| Fields and Methods inherited from SCORING | Description |
|---|---|
|
Add a goal score for a player. |
|
SCORING:AddGoalScorePlayer(PlayerName, GoalTag, Text, Score) |
Add a goal score for a player. |
|
Specify a special additional score for a Wrapper.Group. |
|
|
Specify a special additional score for a Core.Set#SET_GROUP. |
|
|
Add a Wrapper.Static for additional scoring when the Wrapper.Static is destroyed. |
|
|
Add a Wrapper.Unit for additional scoring when the Wrapper.Unit is destroyed. |
|
|
Add a Core.Zone to define additional scoring when any object is destroyed in that zone. |
|
|
Close CSV file |
|
|
If to send messages after a target has been destroyed. |
|
|
If to send messages after a target has been hit. |
|
|
If to send messages after a target has been destroyed and receives additional scores. |
|
|
If to send messages to all players. |
|
|
If to send messages to only those players within the same coalition as the player. |
|
|
If to send messages after a target has been hit in a zone, and additional score is received. |
|
|
Creates a new SCORING object to administer the scoring achieved by players. |
|
|
Handles the OnBirth event for the scoring. |
|
|
Handles the OnPlayerLeaveUnit event for the scoring. |
|
|
Handles the event when one player kill another player |
|
|
Handles the event when one player kill another player |
|
|
Opens a score CSV file to log the scores. |
|
|
A collection of the current players that have joined the game. |
|
|
Removes a Wrapper.Static for additional scoring when the Wrapper.Static is destroyed. |
|
|
Removes a Wrapper.Unit for additional scoring when the Wrapper.Unit is destroyed. |
|
|
Remove a Core.Zone for additional scoring. |
|
|
Produce detailed report of player penalty scores because of changing the coalition. |
|
|
Produce detailed report of player destroy scores. |
|
|
Produce detailed report of player goal scores. |
|
|
Produce detailed report of player hit scores. |
|
|
Produce detailed report of player penalty scores because of changing the coalition. |
|
|
Report all players score |
|
|
Report Group Score Detailed |
|
|
Report Group Score Summary |
|
|
Registers a score for a player. |
|
|
When a player changes the coalition, he can receive a penalty score. |
|
|
Set a prefix string that will be displayed at each scoring message sent. |
|
|
When a player commits too much damage to friendlies, his penalty score will reach a certain level. |
|
|
Configure to send messages after a target has been destroyed. |
|
|
Configure to send messages after a target has been hit. |
|
|
Configure to send messages after a target has been destroyed and receives additional scores. |
|
|
Configure to send messages to all players. |
|
|
Configure to send messages to only those players within the same coalition as the player. |
|
|
Configure to send messages after a target has been hit in a zone, and additional score is received. |
|
|
Set the scale for scoring penalty destroys (friendly destroys). |
|
|
Set the scale for scoring valid destroys (enemy destroys). |
|
|
Configure to increment score after a target has been hit. |
|
|
Sets the scoring menu. |
|
|
Registers a score for a player. |
|
|
Decide if fratricide is leading to penalties (true) or not (false) |
|
|
Decide if a change of coalition is leading to penalties (true) or not (false) |
|
SCORING:_AddMissionGoalScore(Mission, PlayerName, Text, Score) |
Registers Scores the players completing a Mission Task. |
|
Registers Mission Scores for possible multiple players that contributed in the Mission. |
|
SCORING:_AddMissionTaskScore(Mission, PlayerUnit, Text, Score) |
Registers Scores the players completing a Mission Task. |
|
Add a new player entering a Unit. |
|
|
Track DEAD or CRASH events for the scoring. |
|
|
Handles the OnHit event for the scoring. |
|
| Fields and Methods inherited from BASE | Description |
|---|---|
|
The ID number of the class. |
|
|
The name of the class. |
|
|
The name of the class concatenated with the ID number of the class. |
|
|
Clear the state of an object. |
|
SCORING:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) |
Creation of a Birth Event. |
SCORING:CreateEventCrash(EventTime, Initiator, IniObjectCategory) |
Creation of a Crash Event. |
SCORING:CreateEventDead(EventTime, Initiator, IniObjectCategory) |
Creation of a Dead Event. |
|
Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event. |
|
|
Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event. |
|
|
Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event. |
|
|
Creation of a S_EVENT_NEW_DYNAMIC_CARGO event. |
|
|
Creation of a |
|
|
Creation of a Remove Unit Event. |
|
|
Creation of a Takeoff Event. |
|
|
Creation of a Crash Event. |
|
|
Log an exception which will be traced always. |
|
|
Returns the event dispatcher |
|
|
Remove all subscribed events |
|
|
Trace a function call. |
|
|
Trace a function call level 2. |
|
|
Trace a function call level 3. |
|
|
Get the ClassID of the class instance. |
|
|
Get the ClassName of the class instance. |
|
|
Get the ClassName + ClassID of the class instance. |
|
|
Get the Class Core.Event processing Priority. |
|
|
This is the worker method to retrieve the Parent class. |
|
|
Get a Value given a Key from the Object. |
|
|
Subscribe to a DCS Event. |
|
|
Log an information which will be traced always. |
|
|
This is the worker method to inherit from a parent class. |
|
|
This is the worker method to check if an object is an (sub)instance of a class. |
|
|
Enquires if tracing is on (for the class). |
|
|
BASE constructor. |
|
|
Occurs when an Event for an object is triggered. |
|
|
BDA. |
|
|
Occurs when a ground unit captures either an airbase or a farp. |
|
|
Occurs when any object is spawned into the mission. |
|
|
Occurs when any aircraft crashes into the ground and is completely destroyed. |
|
|
Occurs when an object is dead. |
|
|
Unknown precisely what creates this event, likely tied into newer damage model. |
|
|
Discard chair after ejection. |
|
|
Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo. |
|
|
Occurs when a dynamic cargo crate is removed. |
|
|
Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo. |
|
|
Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs when any aircraft shuts down its engines. |
|
|
Occurs when any aircraft starts its engines. |
|
|
Occurs whenever an object is hit by a weapon. |
|
|
Occurs when any system fails on a human controlled aircraft. |
|
|
Occurs on the death of a unit. |
|
|
Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up. |
|
|
Landing quality mark. |
|
|
Occurs when a new mark was added. |
|
|
Occurs when a mark text was changed. |
|
|
Occurs when a mark was removed. |
|
|
Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs when a player creates a dynamic cargo object from the F8 ground crew menu. |
|
|
Weapon add. |
|
|
Occurs when the pilot of an aircraft is killed. |
|
|
Occurs when a player enters a slot and takes control of an aircraft. |
|
|
Occurs when any player assumes direct control of a unit. |
|
|
Occurs when any player relieves control of a unit to the AI. |
|
|
Occurs when an aircraft connects with a tanker and begins taking on fuel. |
|
|
Occurs when an aircraft is finished taking fuel. |
|
|
Occurs when any modification to the "Score" as seen on the debrief menu would occur. |
|
|
Occurs when any unit stops firing its weapon. |
|
|
Occurs when any unit begins firing a weapon that has a high rate of fire. |
|
|
Occurs whenever any unit in a mission fires a weapon. |
|
|
Occurs when an aircraft takes off from an airbase, farp, or ship. |
|
|
Trigger zone. |
|
|
Occurs when the game thinks an object is destroyed. |
|
|
Schedule a new time event. |
|
SCORING:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...) |
Schedule a new time event. |
|
Stops the Schedule. |
|
|
Set the Class Core.Event processing Priority. |
|
|
Set a state or property of the Object given a Key and a Value. |
|
|
Trace a function logic level 1. |
|
|
Trace a function logic level 2. |
|
|
Trace a function logic level 3. |
|
|
Trace all methods in MOOSE |
|
|
Set tracing for a class |
|
|
Set tracing for a specific method of class |
|
|
Set trace level |
|
|
Set trace off. |
|
|
Set trace on. |
|
|
Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default. |
|
|
UnSubscribe to a DCS event. |
|
SCORING:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function call. |
|
(Internal) Serialize arguments |
|
SCORING:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function logic. |
|
The main event handling function... |
Field(s)
Create the CSV file.
Additional Object scores
During mission startup, especially for single player, iterate the database for the player that has joined, and add him to the scoring, and set the menu. But this can only be started one second after the mission has started, so i need to schedule this ...
Additional Zone scores.
Function(s)
Add a goal score for a player.
The method takes the PlayerUnit for which the Goal score needs to be set. The GoalTag is a string or identifier that is taken into the CSV file scoring log to identify the goal. A free text can be given that is shown to the players. The Score can be both positive and negative.
Defined in:
SCORING
Parameters:
Wrapper.Unit#UNIT PlayerUnit
The Wrapper.Unit of the Player. Other Properties for the scoring are taken from this PlayerUnit, like coalition, type etc.
#string GoalTag
The string or identifier that is used in the CSV file to identify the goal (sort or group later in Excel).
#string Text
A free text that is shown to the players.
#number Score
The score can be both positive or negative ( Penalty ).
Add a goal score for a player.
The method takes the Player name for which the Goal score needs to be set. The GoalTag is a string or identifier that is taken into the CSV file scoring log to identify the goal. A free text can be given that is shown to the players. The Score can be both positive and negative.
Defined in:
SCORING
Parameters:
#string PlayerName
The name of the Player.
#string GoalTag
The string or identifier that is used in the CSV file to identify the goal (sort or group later in Excel).
#string Text
A free text that is shown to the players.
#number Score
The score can be both positive or negative ( Penalty ).
Specify a special additional score for a Wrapper.Group.
Defined in:
SCORING
Parameters:
Wrapper.Group#GROUP ScoreGroup
The Wrapper.Group for which each Wrapper.Unit a Score is given.
#number Score
The Score value.
Return value:
Specify a special additional score for a Core.Set#SET_GROUP.
Defined in:
SCORING
Parameters:
The Core.Set#SET_GROUP for which each Wrapper.Unit in each Group a Score is given.
#number Score
The Score value.
Return value:
Add a Wrapper.Static for additional scoring when the Wrapper.Static is destroyed.
Note that if there was already a Wrapper.Static declared within the scoring with the same name, then the old Wrapper.Static will be replaced with the new Wrapper.Static.
Defined in:
SCORING
Parameters:
Wrapper.Static#UNIT ScoreStatic
The Wrapper.Static for which the Score needs to be given.
#number Score
The Score value.
Return value:
Add a Wrapper.Unit for additional scoring when the Wrapper.Unit is destroyed.
Note that if there was already a Wrapper.Unit declared within the scoring with the same name, then the old Wrapper.Unit will be replaced with the new Wrapper.Unit.
Defined in:
SCORING
Parameters:
Wrapper.Unit#UNIT ScoreUnit
The Wrapper.Unit for which the Score needs to be given.
#number Score
The Score value.
Return value:
Add a Core.Zone to define additional scoring when any object is destroyed in that zone.
Note that if a Core.Zone with the same name is already within the scoring added, the Core.Zone (type) and Score will be replaced! This allows for a dynamic destruction zone evolution within your mission.
Defined in:
SCORING
Parameters:
Core.Zone#ZONE_BASE ScoreZone
The Core.Zone which defines the destruction score perimeters. Note that a zone can be a polygon or a moving zone.
#number Score
The Score value.
Return value:
If to send messages after a target has been destroyed.
Defined in:
SCORING
Return value:
#boolean:
If to send messages after a target has been hit.
Defined in:
SCORING
Return value:
#boolean:
If to send messages after a target has been destroyed and receives additional scores.
Defined in:
SCORING
Return value:
#boolean:
If to send messages to all players.
Defined in:
SCORING
Return value:
#boolean:
If to send messages to only those players within the same coalition as the player.
Defined in:
SCORING
Return value:
#boolean:
If to send messages after a target has been hit in a zone, and additional score is received.
Defined in:
SCORING
Return value:
#boolean:
Creates a new SCORING object to administer the scoring achieved by players.
Defined in:
SCORING
Parameters:
#string GameName
The name of the game. This name is also logged in the CSV score file.
#string SavePath
(Optional) Path where to save the CSV file, defaults to your **
#boolean AutoSave
(Optional) If passed as false, then swith autosave off.
Return value:
self
Usage:
-- Define a new scoring object for the mission Gori Valley.
ScoringObject = SCORING:New( "Gori Valley" )
Handles the OnBirth event for the scoring.
Handles the OnPlayerLeaveUnit event for the scoring.
Handles the event when one player kill another player
Defined in:
SCORING
Parameters:
#string PlayerName
The attacking player
#string TargetUnitName
the name of the killed unit
#boolean IsTeamKill
true if this kill was a team kill
#number TargetThreatLevel
Threat level of the target
#number PlayerThreatLevel
Threat level of the player
#number Score
The score based on both threat levels
Handles the event when one player kill another player
Defined in:
SCORING
Parameters:
#string PlayerName
The attacking player
#string TargetPlayerName
The name of the killed player
#boolean IsTeamKill
true if this kill was a team kill
#number TargetThreatLevel
Threat level of the target
#number PlayerThreatLevel
Threat level of the player
#number Score
The score based on both threat levels
Opens a score CSV file to log the scores.
Defined in:
SCORING
Parameter:
#string ScoringCSV
Return value:
self
Usage:
-- Open a new CSV file to log the scores of the game Gori Valley. Let the name of the CSV file begin with "Player Scores".
ScoringObject = SCORING:New( "Gori Valley" )
ScoringObject:OpenCSV( "Player Scores" )Removes a Wrapper.Static for additional scoring when the Wrapper.Static is destroyed.
Defined in:
SCORING
Parameter:
Wrapper.Static#UNIT ScoreStatic
The Wrapper.Static for which the Score needs to be given.
Return value:
Removes a Wrapper.Unit for additional scoring when the Wrapper.Unit is destroyed.
Defined in:
SCORING
Parameter:
Wrapper.Unit#UNIT ScoreUnit
The Wrapper.Unit for which the Score needs to be given.
Return value:
Remove a Core.Zone for additional scoring.
The scoring will search if any Core.Zone is added with the given name, and will remove that zone from the scoring. This allows for a dynamic destruction zone evolution within your mission.
Defined in:
SCORING
Parameter:
Core.Zone#ZONE_BASE ScoreZone
The Core.Zone which defines the destruction score perimeters. Note that a zone can be a polygon or a moving zone.
Return value:
Produce detailed report of player penalty scores because of changing the coalition.
Defined in:
SCORING
Parameter:
#string PlayerName
The name of the player.
Return value:
#string:
The report.
Produce detailed report of player destroy scores.
Defined in:
SCORING
Parameter:
#string PlayerName
The name of the player.
Return value:
#string:
The report.
Produce detailed report of player goal scores.
Defined in:
SCORING
Parameter:
#string PlayerName
The name of the player.
Return value:
#string:
The report.
Produce detailed report of player hit scores.
Defined in:
SCORING
Parameter:
#string PlayerName
The name of the player.
Return value:
#string:
The report.
Produce detailed report of player penalty scores because of changing the coalition.
Defined in:
SCORING
Parameter:
#string PlayerName
The name of the player.
Return value:
#string:
The report.
Report all players score
Report Group Score Detailed
Report Group Score Summary
Registers a score for a player.
Defined in:
SCORING
Parameters:
#string PlayerName
The name of the player.
#string TargetPlayerName
The name of the target player.
#string ScoreType
The type of the score.
#string ScoreTimes
The amount of scores achieved.
#string ScoreAmount
The score given.
#string PlayerUnitName
The unit name of the player.
#string PlayerUnitCoalition
The coalition of the player unit.
#string PlayerUnitCategory
The category of the player unit.
#string PlayerUnitType
The type of the player unit.
#string TargetUnitName
The name of the target unit.
#string TargetUnitCoalition
The coalition of the target unit.
#string TargetUnitCategory
The category of the target unit.
#string TargetUnitType
The type of the target unit.
Return value:
self
Defined in:
SCORING
Parameter:
sSeconds
When a player changes the coalition, he can receive a penalty score.
Use the method SCORING.SetCoalitionChangePenalty() to define the penalty when a player changes coalition. By default, the penalty for changing coalition is the default penalty scale.
Defined in:
SCORING
Parameter:
#number CoalitionChangePenalty
The amount of penalty that is given.
Return value:
Set a prefix string that will be displayed at each scoring message sent.
Defined in:
SCORING
Parameter:
#string DisplayMessagePrefix
(Default="Scoring: ") The scoring prefix string.
Return value:
When a player commits too much damage to friendlies, his penalty score will reach a certain level.
Use this method to define the level when a player gets kicked. By default, the fratricide level is the default penalty multiplier * 2 for the penalty score.
Defined in:
SCORING
Parameter:
#number Fratricide
The amount of maximum penalty that may be inflicted by a friendly player before he gets kicked.
Return value:
Configure to send messages after a target has been destroyed.
Defined in:
SCORING
Parameter:
#boolean OnOff
If true is given, the messages are sent.
Return value:
Configure to send messages after a target has been hit.
Defined in:
SCORING
Parameter:
#boolean OnOff
If true is given, the messages are sent.
Return value:
Configure to send messages after a target has been destroyed and receives additional scores.
Defined in:
SCORING
Parameter:
#boolean OnOff
If true is given, the messages are sent.
Return value:
Configure to send messages to all players.
Configure to send messages to only those players within the same coalition as the player.
Configure to send messages after a target has been hit in a zone, and additional score is received.
Defined in:
SCORING
Parameter:
#boolean OnOff
If true is given, the messages are sent.
Return value:
Set the scale for scoring penalty destroys (friendly destroys).
A default calculated penalty is a value between 1 and 10. The scale magnifies the scores given to the players.
Set the scale for scoring valid destroys (enemy destroys).
A default calculated score is a value between 1 and 10. The scale magnifies the scores given to the players.
Defined in:
SCORING
Parameter:
#number Scale
The scale of the score given.
Configure to increment score after a target has been hit.
Defined in:
SCORING
Parameter:
#number score
amount of point to inclement score on each hit
Return value:
Sets the scoring menu.
Registers a score for a player.
Defined in:
SCORING
Parameter:
#boolean OnOff
Switch saving to CSV on = true or off = false
Return value:
self
Decide if fratricide is leading to penalties (true) or not (false)
Decide if a change of coalition is leading to penalties (true) or not (false)
Registers Scores the players completing a Mission Task.
Defined in:
SCORING
Parameters:
Tasking.Mission#MISSION Mission
#string PlayerName
#string Text
#number Score
Registers Mission Scores for possible multiple players that contributed in the Mission.
Defined in:
SCORING
Parameters:
Tasking.Mission#MISSION Mission
Wrapper.Unit#UNIT PlayerUnit
#string Text
#number Score
Registers Scores the players completing a Mission Task.
Defined in:
SCORING
Parameters:
Tasking.Mission#MISSION Mission
Wrapper.Unit#UNIT PlayerUnit
#string Text
#number Score
Add a new player entering a Unit.
Track DEAD or CRASH events for the scoring.
Handles the OnHit event for the scoring.
Field(s)
Create the CSV file.
Additional Object scores
During mission startup, especially for single player, iterate the database for the player that has joined, and add him to the scoring, and set the menu. But this can only be started one second after the mission has started, so i need to schedule this ...
Additional Zone scores.
Function(s)
Clear the state of an object.
Defined in:
Parameters:
Object
The object that holds the Value set by the Key.
StateName
The key that is should be cleared.
Creation of a Birth Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
#string IniUnitName
The initiating unit name.
place
subplace
Creation of a Crash Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
IniObjectCategory
Creation of a Dead Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
IniObjectCategory
Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.
Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.
Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.
Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.
Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.
Creation of a Remove Unit Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Creation of a Takeoff Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Creation of a Crash Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Log an exception which will be traced always.
Can be anywhere within the function logic.
Returns the event dispatcher
Remove all subscribed events
Trace a function call.
Must be at the beginning of the function logic.
Trace a function call level 2.
Must be at the beginning of the function logic.
Trace a function call level 3.
Must be at the beginning of the function logic.
Get the ClassID of the class instance.
Get the ClassName of the class instance.
Get the ClassName + ClassID of the class instance.
The ClassName + ClassID is formatted as '%s#%09d'.
Get the Class Core.Event processing Priority.
The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.
This is the worker method to retrieve the Parent class.
Note that the Parent class must be passed to call the parent class method.
self:GetParent(self):ParentMethod()
Get a Value given a Key from the Object.
Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.
Defined in:
Parameters:
Object
The object that holds the Value set by the Key.
Key
The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!
Return value:
The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.
Subscribe to a DCS Event.
Defined in:
Parameters:
Core.Event#EVENTS EventID
Event ID.
#function EventFunction
(optional) The function to be called when the event occurs for the unit.
Return value:
Log an information which will be traced always.
Can be anywhere within the function logic.
This is the worker method to inherit from a parent class.
Defined in:
Parameters:
Child
is the Child class that inherits.
#BASE Parent
is the Parent class that the Child inherits from.
Return value:
Child
This is the worker method to check if an object is an (sub)instance of a class.
Examples:
ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false
Defined in:
Parameter:
ClassName
is the name of the class or the class itself to run the check against
Return value:
#boolean:
Enquires if tracing is on (for the class).
BASE constructor.
This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.
function EVENT:New()
local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
return self
end
Occurs when an Event for an object is triggered.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that triggered the event.
Occurs when a ground unit captures either an airbase or a farp.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.
Occurs when any object is spawned into the mission.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was spawned
Occurs when any aircraft crashes into the ground and is completely destroyed.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that has crashed
Occurs when an object is dead.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is dead.
Unknown precisely what creates this event, likely tied into newer damage model.
Will update this page when new information become available.
- initiator: The unit that had the failure.
Discard chair after ejection.
Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Occurs when a dynamic cargo crate is removed.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.
initiator : The unit that has ejected
Occurs when any aircraft shuts down its engines.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is stopping its engines.
Occurs when any aircraft starts its engines.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is starting its engines.
Occurs whenever an object is hit by a weapon.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.
Occurs when any system fails on a human controlled aircraft.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that had the failure
Occurs on the death of a unit.
Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs. Have a look at the class Core.Event#EVENT as these are just the prototypes.
- initiator: The unit that killed the target
- target: Target Object
- weapon: Weapon Object
Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes.
initiator : The unit that has landed place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships
Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.
Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker. Have a look at the class Core.Event#EVENT as these are just the prototypes.
- initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
- place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
- subplace: is always 0 for unknown reasons.
Occurs when a new mark was added.
Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.
Occurs when a mark text was changed.
Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.
Occurs when a mark was removed.
Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.
Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Weapon add.
Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when the pilot of an aircraft is killed.
Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the pilot has died in.
Occurs when a player enters a slot and takes control of an aircraft.
Have a look at the class Core.Event#EVENT as these are just the prototypes. NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. initiator : The unit that is being taken control of.
Occurs when any player assumes direct control of a unit.
Note - not Mulitplayer safe. Use PlayerEnterAircraft. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is being taken control of.
Occurs when any player relieves control of a unit to the AI.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the player left.
Occurs when an aircraft connects with a tanker and begins taking on fuel.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is receiving fuel.
Occurs when an aircraft is finished taking fuel.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was receiving fuel.
Occurs when any modification to the "Score" as seen on the debrief menu would occur.
There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard. Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when any unit stops firing its weapon.
Event will always correspond with a shooting start event. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was doing the shooting.
Occurs when any unit begins firing a weapon that has a high rate of fire.
Most common with aircraft cannons (GAU-8), autocannons, and machine guns. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is doing the shooting. target: The unit that is being targeted.
Occurs whenever any unit in a mission fires a weapon.
But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when an aircraft takes off from an airbase, farp, or ship.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships
Occurs when the game thinks an object is destroyed.
Have a look at the class Core.Event#EVENT as these are just the prototypes.
- initiator: The unit that is was destroyed.
Schedule a new time event.
Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.
Defined in:
Parameters:
#number Start
Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
#function SchedulerFunction
The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
#table ...
Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
Return value:
#string:
The Schedule ID of the planned schedule.
Schedule a new time event.
Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.
Defined in:
Parameters:
#number Start
Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
#number Repeat
Specifies the interval in seconds when the scheduler will call the event function.
#number RandomizeFactor
Specifies a randomization factor between 0 and 1 to randomize the Repeat.
#number Stop
Specifies the amount of seconds when the scheduler will be stopped.
#function SchedulerFunction
The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
#table ...
Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
Return value:
#string:
The Schedule ID of the planned schedule.
Stops the Schedule.
Defined in:
Parameter:
#string SchedulerID
(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.
Set the Class Core.Event processing Priority.
The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.
Set a state or property of the Object given a Key and a Value.
Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.
Defined in:
Parameters:
Object
The object that will hold the Value set by the Key.
Key
The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!
Value
The value to is stored in the object.
Return value:
The Value set.
Trace a function logic level 1.
Can be anywhere within the function logic.
Trace a function logic level 2.
Can be anywhere within the function logic.
Trace a function logic level 3.
Can be anywhere within the function logic.
Trace all methods in MOOSE
Set tracing for a class
Set tracing for a specific method of class
Set trace off.
Set trace on.
Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.
So tracing must be switched on manually in your mission if you are using Moose statically. When moose is loading dynamically (for moose class development), tracing is switched on by default.
Defined in:
Parameter:
#boolean TraceOnOff
Switch the tracing on or off.
Usage:
-- Switch the tracing On
BASE:TraceOnOff( true )
-- Switch the tracing Off
BASE:TraceOnOff( false )
UnSubscribe to a DCS event.
Trace a function call.
This function is private.
Defined in:
Parameters:
Arguments
A #table or any field.
DebugInfoCurrentParam
DebugInfoFromParam
(Internal) Serialize arguments
Trace a function logic.
Defined in:
Parameters:
Arguments
A #table or any field.
DebugInfoCurrentParam
DebugInfoFromParam
The main event handling function...
This function captures all events generated for the class.