Hello everyone,
I’m currently working on a project using SCAR and have come across the Obj_Create function used as shown below:
_mod.objective = Obj_Create(localPlayer.id, _mod.objective_title, Loc_Empty(), _mod.icons.objective, "ConquestObjectiveTemplate", localPlayer.raceName, OT_Primary, 0, "conquestObj")
The available documentation isn’t clear on what values are acceptable for each parameter. I’m particularly puzzled about:
- localPlayer.id: Is there a specific range or format for this identifier?
- _mod.objective_title: What types of titles are accepted or expected here?
- Loc_Empty(): What should this function return exactly? Is there a defined structure for an empty location?
- _mod.icons.objective: Where can I find a complete list of valid icons for this parameter?
- “ConquestObjectiveTemplate”: Is this the only available template, or are there others?
- localPlayer.raceName: What values are valid for representing the player’s race?
- OT_Primary: Are there other objective types apart from
OT_Primary?
- 0: What does this numerical value represent? Is it an index, priority level, or something else?
- “conquestObj”: Should this identifier adhere to a specific naming convention?
In addition to clarifying these specific parameters, I would also like to know how I can independently verify these values or find the definitions of these functions within the SCAR documentation. Is there a particular section, tool, or method within the SCAR ecosystem that can help me discover these details myself?
Any guidance, pointers to relevant documentation, or examples from experienced users would be greatly appreciated. Thank you in advance for your assistance!
Hey there 
also having huge troubles finding a good documentation! I get it from
a) file:///C:/program%20files%20(x86)/steam/steamapps/common/age%20of%20empires%20iv/scardocs/html/frameset.htm
b) The example of the crafted map “3 villages” (or something like that)
c) the example of the game mode “5 houses” (or something like that)
d) the Mod workshop
So, for your case, in what I can help you:
Just type the function “Obj_Create(..” in your scar script and then it will tell you which type of variables to enter.
(or hover your mouse over an existing function “Obj_Create()”
-
the first value is a “Player ID”. You can get this with either
player1 = World_GetPlayerAt(1)
player2 = World_GetPlayerAt(2) etc. (player1 and player2 are the names i chose for these variables)
or, if you want to call the “local” player, the one on whos computer this script is currently running:
player1 = Game_GetLocalPlayer()
-
the second one is a “string”. I found this complicated. in some cases you can just write “text” (in brackets, it will be grey!)
I found it better though to use “Localized strings”. This will look somewhat like this : “”$2980c2d480a34c0d92d1a5e332173098:2"
I found out about these here: https://support.ageofempires.com/hc/en-us/articles/6566693329812-Localizing-Mods
-
Icons: I only found out about this today. My way to find the icons is the following:
- create a new mod
- open the “rdo” file
- click on the 3 dots at the end of this line
- a folder-view will open, one of the folders is called “icons”. There are severeal sub-folders, but in all of these you can find the icons (at least the names of the icons)
-
cant help you with the next one, dont even know what this template is supposed to do
-
for the valid player “races”, its kind of the same as with the icons.
- create an empty crafted map
- open the .scenario tab
- select a player from the list
- on the right hand side, there will be player properties. Click again on the 3 dots in the line “race”. all possible races will be shown
- you will find all valid Objective Types in this document, search for it on the left hand side.
file:///C:/program%20files%20(x86)/steam/steamapps/common/age%20of%20empires%20iv/scardocs/html/frameset.htm
Unfortunately, there is no further explanation given
cant help you about the last 2 again. Yes, its a nightmare. Hope, I could help a bit
