ryzom/common/data_common/r2/r2_features_ambush.lua

   1
   2 r2.Features.Ambush = {}
   3
   4 local feature = r2.Features.Ambush
   5
   6 feature.Name="Ambush"
   7
   8
   9 feature.Description=""
  10
  11 feature.Components = {}
  12
  13 local classAmbushVersion = 1
  14
  15 feature.Components.Ambush =
  16         {
  17                 --PropertySheetHeader = r2.getDisplayButtonHeader("r2.events:openEditor()", "uiR2EdEditEventsButton"),
  18                 BaseClass="LogicEntity",
  19                 Name="Ambush",
  20                 InEventUI = true,
  21                 Menu="ui:interface:r2ed_feature_menu",
  22                 Version=classAmbushVersion ,
  23
  24                 DisplayerProperties = "R2::CDisplayerLua",
  25                 DisplayerPropertiesParams = "ambushDisplayer",
  26
  27                 DisplayerUI = "R2::CDisplayerLua",
  28                 DisplayerUIParams = "defaultUIDisplayer",
  29                 DisplayerVisual = "R2::CDisplayerVisualEntity",
  30                 -----------------------------------------------------------------------------------------------
  31                 Parameters = {},
  32                 ApplicableActions = {"activate", "deactivate", "trigger"},
  33                 Events = {"activation", "deactivation", "trigger"},
  34                 Conditions = {"is active", "is inactive"},
  35                 TextContexts =          {},
  36                 TextParameters =        {},
  37                 LiveParameters =        {},
  38                 -----------------------------------------------------------------------------------------------
  39                 Prop =
  40                 {
  41                         {Name="InstanceId", Type="String", WidgetStyle="StaticText", Visible = false},
  42                         {Name="Name", Type="String", MaxNumChar="32"},
  43                         {Name="Active", Type="Number", WidgetStyle="Boolean", DefaultValue="1"},
  44                         {Name="MobNumber", Type="Number", Category="uiR2EDRollout_Mobs", WidgetStyle="EnumDropDown", Enum={"1", "2", "3", "4", "5"},
  45                         },
  46                         {Name="Mob1Id", Type="RefId", Category="uiR2EDRollout_Mobs",PickFunction="r2:canPickNpcOrGroup", SetRefIdFunction="r2:setNpcOrGroupRefIdTarget",
  47                         Visible= function(this) return this:displayRefId(1) end},
  48                         {Name="Mob2Id", Type="RefId", Category="uiR2EDRollout_Mobs",PickFunction="r2:canPickNpcOrGroup", SetRefIdFunction="r2:setNpcOrGroupRefIdTarget",
  49                          Visible= function(this) return this:displayRefId(2) end},
  50                         {Name="Mob3Id", Type="RefId", Category="uiR2EDRollout_Mobs",PickFunction="r2:canPickNpcOrGroup", SetRefIdFunction="r2:setNpcOrGroupRefIdTarget",
  51                         Visible= function(this) return this:displayRefId(3) end},
  52                         {Name="Mob4Id", Type="RefId", Category="uiR2EDRollout_Mobs",PickFunction="r2:canPickNpcOrGroup", SetRefIdFunction="r2:setNpcOrGroupRefIdTarget",
  53                          Visible= function(this) return this:displayRefId(4) end},
  54                         {Name="Mob5Id", Type="RefId", Category="uiR2EDRollout_Mobs",PickFunction="r2:canPickNpcOrGroup", SetRefIdFunction="r2:setNpcOrGroupRefIdTarget",
  55                          Visible= function(this) return this:displayRefId(5) end},
  56                         {Name="TriggerOn", Type="Number", WidgetStyle="EnumDropDown",
  57                         Enum={"Leaves the zone", "Enters the zone"},
  58                         },
  59                         {Name="Components", Type="Table"},
  60
  61                 },
  62                 -----------------------------------------------------------------------------------------------
  63                 -- from base class
  64                 getParentTreeNode = function(this)
  65                         return this:getFeatureParentTreeNode()
  66                 end,
  67                 ---------------------------------------------------------------------------------------------------------
  68                 -- from base class
  69                 appendInstancesByType = function(this, destTable, kind)
  70                         assert(type(kind) == "string")
  71                         --this:delegate():appendInstancesByType(destTable, kind)
  72                         r2.Classes.LogicEntity.appendInstancesByType(this, destTable, kind)
  73                         for k, component in specPairs(this.Components) do
  74                                 component:appendInstancesByType(destTable, kind)
  75                         end
  76                 end,
  77                 ---------------------------------------------------------------------------------------------------------
  78                 -- from base class
  79                 getSelectBarSons = function(this)
  80                         return Components
  81                 end,
  82                 ---------------------------------------------------------------------------------------------------------
  83                 -- from base class
  84                 canHaveSelectBarSons = function(this)
  85                         return false;
  86                 end,
  87
  88                 onPostCreate = function(this)
  89                         --this:createGhostComponents()
  90                         if this.User.DisplayProp and this.User.DisplayProp == 1 then
  91                                 r2:setSelectedInstanceId(this.InstanceId)
  92                                 r2:showProperties(this)
  93                                 this.User.DisplayProp = nil
  94                         end
  95                 end,
  96
  97
  98                 pretranslate = function(this, context)
  99                         r2.Translator.createAiGroup(this, context)
 100                 end,
 101
 102                 translate = function(this, context)
 103                         r2.Translator.translateAiGroup(this, context)
 104                         r2.Translator.translateFeatureActivation(this, context)
 105                 end,
 106
 107                 updateVersion = function(this, scenarioValue, currentValue )
 108
 109                 end,
 110
 111
 112         }
 113
 114 local component = feature.Components.Ambush
 115
 116 function component:displayRefId(index)
 117         local nbMobs = self.MobNumber + 1
 118         if index <= nbMobs then
 119                 return true
 120         end
 121         return false
 122 end
 123 ------------------------------------------------------------------------------------------------------------------
 124 local ambushDisplayerTable = clone(r2:propertySheetDisplayer())
 125
 126 --
 127 -- If the message is received by a client that didn't request the modification, we must make sure this client
 128 -- doesn't modify the data because it has already been performed by the initial client.
 129 --
 130 local function checkPickedEntity(this, instanceId, attributeName)
 131         if instanceId == "" then
 132                 return false
 133         end
 134         local tmpInstance = r2:getInstanceFromId(instanceId)
 135         assert(tmpInstance)
 136         local i = 1
 137         while i < 6 do
 138                 local attrName = "Mob" ..i.. "Id"
 139                 if attrName ~= attributeName and this[attrName] == tmpInstance.InstanceId then
 140                         return false
 141                 end
 142                 i = i + 1
 143         end
 144         return true
 145 end
 146
 147
 148
 149 function ambushDisplayerTable:onAttrModified(instance, attributeName)
 150
 151         if attributeName == "MobNumber" then
 152                 local propertySheet = r2:getPropertySheet(instance)
 153                 local nbMobs = instance.MobNumber + 1
 154                 local i = 1
 155                 while i <= 5 do
 156                         if i > nbMobs then
 157                                 local name = "Mob"..tostring(i).."Id"
 158                                 local refId = propertySheet:find(name)
 159                                 local refIdName = refId:find("name")
 160                                 refIdName.hardtext = "NONE"
 161                                 r2.requestSetNode(instance.InstanceId, name, "")
 162                         end
 163                         i = i + 1
 164                 end
 165                 propertySheet.Env.updatePropVisibility()
 166                 return
 167         end
 168         if string.find(attributeName, "Id") == nil or attributeName == "InstanceId" then return end
 169
 170         local propertySheet = r2:getPropertySheet(instance)
 171         local refId = propertySheet:find(attributeName)
 172         if refId == nil then return end
 173         local refIdName = refId:find("name")
 174
 175         local instanceId = instance[attributeName]
 176         if instanceId == "" then
 177                 refIdName.hardtext = "NONE"
 178                 return
 179         end
 180
 181         local inserted = checkPickedEntity(instance, instanceId, attributeName)
 182         if  inserted == true then
 183                 local tmpInstance = r2:getInstanceFromId(instanceId)
 184                 refIdName.hardtext = tmpInstance.Name
 185         else
 186                 r2.requestSetNode(instance.InstanceId, attributeName, "")
 187         end
 188         instance.User.onHrcMove = false
 189 end
 190
 191 function ambushDisplayerTable:onSelect(instance, isSelected)
 192         r2:logicEntityPropertySheetDisplayer():onSelect(instance, isSelected)
 193 end
 194
 195 function component:onTargetInstancePreHrcMove(targetAttr, targetIndexInArray)
 196
 197         local targetId = self[targetAttr]
 198         local tmpInstance = r2:getInstanceFromId(targetId)
 199         tmpInstance.User.SelfModified = true
 200
 201 end
 202
 203
 204 local function reattributeIdOnHrcMove(ambush, group, targetAttr)
 205         local propertySheet = r2:getPropertySheet(ambush)
 206         local refId = propertySheet:find(targetAttr)
 207         local refIdName = refId:find("name")
 208
 209         r2.requestSetNode(ambush.InstanceId, targetAttr, group.InstanceId)
 210         refIdName.hardtext = group.Name
 211         ambush.User.onHrcMove = true
 212
 213 end
 214
 215
 216 function component:onTargetInstancePostHrcMove(targetAttr, targetIndexInArray)
 217
 218         local targetId = self[targetAttr]
 219
 220         local tmpInstance = r2:getInstanceFromId(targetId)
 221
 222         assert(tmpInstance)
 223         if tmpInstance.User.SelfModified and tmpInstance.User.SelfModified == true then
 224                 local group = tmpInstance.ParentInstance
 225                 if group:isKindOf("NpcGrpFeature") then
 226                         reattributeIdOnHrcMove(self, group, targetAttr)
 227                 end
 228                 tmpInstance.User.SelfModified = false
 229         end
 230
 231 end
 232
 233
 234 function r2:ambushDisplayer()
 235         return ambushDisplayerTable  -- returned shared displayer to avoid wasting memory
 236 end
 237 --------------------------------------------------------------------------------------------------------------------
 238
 239
 240
 241 component.getLogicAction = function(entity, context, action)
 242         assert( action.Class == "ActionStep")
 243         local component = r2:getInstanceFromId(action.Entity)
 244         assert(component)
 245         local rtNpcGrp = r2.Translator.getRtGroup(context, component.InstanceId)
 246         assert(rtNpcGrp)
 247
 248         if (action.Action.Type == "trigger") then
 249                 local i = 1
 250                 local spawnActions = {}
 251                 while i <= 5 do
 252                         local attrName = "Mob"..i.."Id"
 253                         if component[attrName] ~= "" then
 254                                 local rtMobGrp = r2.Translator.getRtGroup(context, component[attrName])
 255                                 local actionSpawn = r2.Translator.createAction("spawn", rtMobGrp.Id)
 256                                 table.insert(spawnActions, actionSpawn)
 257                         end
 258                         i = i + 1
 259                 end
 260
 261                 if table.getn(spawnActions) ~= 0 then
 262                         local actionTrigger = r2.Translator.createAction("user_event_trigger", rtNpcGrp.Id, 6)
 263                         table.insert(spawnActions, actionTrigger)
 264                         local retAction = r2.Translator.createAction("condition_if", r2:getNamespace()..rtNpcGrp.Id..".Active == 1",
 265                                 r2.Translator.createAction("multi_actions", spawnActions)
 266                         )
 267                         return retAction, retAction
 268                 end
 269                 return nil, nil
 270         end
 271         return r2.Translator.getFeatureActivationLogicAction(rtNpcGrp, action)
 272 end
 273
 274 component.getLogicCondition = function(this, context, condition)
 275         assert( condition.Class == "ConditionStep")
 276         local component = r2:getInstanceFromId(condition.Entity)
 277         assert(component)
 278         local rtNpcGrp = r2.Translator.getRtGroup(context, component.InstanceId)
 279         assert(rtNpcGrp)
 280
 281         return r2.Translator.getFeatureActivationCondition(condition, rtNpcGrp)
 282 end
 283
 284 component.getLogicEvent = function(this, context, event)
 285         assert( event.Class == "LogicEntityAction")
 286
 287         local component = this -- r2:getInstanceFromId(event.Entity)
 288         assert(component)
 289         local rtNpcGrp = r2.Translator.getRtGroup(context, component.InstanceId)
 290         assert(rtNpcGrp)
 291
 292         if tostring(event.Event.Type) == "trigger" then
 293                 return r2.Translator.getComponentUserEvent(rtNpcGrp, 6)
 294         end
 295
 296         return r2.Translator.getFeatureActivationLogicEvent(rtNpcGrp, event)
 297 end
 298
 299 component.createGhostComponents= function(this, act)
 300
 301         local comp = this
 302         local nbMob = 0
 303
 304         for id = 1, 5 do
 305                 local propertyName = "Mob"..id.."Id"
 306                 if comp[propertyName] ~= nil and comp[propertyName] ~= "" then
 307                         local mob = r2:getInstanceFromId(comp[propertyName])
 308                         if mob then
 309                                 nbMob = nbMob + 1
 310                                 if mob:isKindOf("NpcGrpFeature") then
 311                                         local instanceId = mob.Components[0].InstanceId
 312                                         r2.requestSetGhostNode(instanceId, "AutoSpawn", 0)
 313                                 else
 314                                         r2.requestSetGhostNode(mob.InstanceId, "AutoSpawn", 0)
 315                                 end
 316                         end
 317                 end
 318         end
 319
 320         if nbMob == 0 then
 321                 return
 322         end
 323         local zoneTrigger = r2:getInstanceFromId(comp._ZoneId)
 324         assert(zoneTrigger)
 325
 326         do
 327                 local type = "On Player Left"
 328                 if comp.TriggerOn == 1 then
 329                         type = "On Player Arrived"
 330                 end
 331
 332                 local eventHandler = r2.newComponent("LogicEntityAction")
 333                 eventHandler.Event.Type = type
 334                 eventHandler.Event.Value = ""
 335                 eventHandler.Name = type
 336
 337                 local action = r2.newComponent("ActionStep")
 338
 339                 action.Entity =  r2.RefId(comp.InstanceId)
 340                 action.Action.Type = "trigger"
 341                 action.Action.Value = ""
 342
 343                 table.insert(eventHandler.Actions, action)
 344
 345                 local behaviorId = zoneTrigger.Behavior.InstanceId
 346                 assert(behaviorId)
 347                 r2.requestInsertGhostNode(behaviorId, "Actions", -1, "", eventHandler)
 348
 349         end
 350
 351         do
 352                 local eventHandler = r2.newComponent("LogicEntityAction")
 353                 eventHandler.Event.Type = "activation"
 354                 eventHandler.Event.Value = ""
 355                 eventHandler.Name = "activation"
 356
 357                 local action = r2.newComponent("ActionStep")
 358
 359                 action.Entity =  r2.RefId(zoneTrigger.InstanceId)
 360                 action.Action.Type = "activate"
 361                 action.Action.Value = ""
 362
 363                 table.insert(eventHandler.Actions, action)
 364
 365                 local behaviorId = this.Behavior.InstanceId
 366                 assert(behaviorId)
 367                 r2.requestInsertGhostNode(behaviorId, "Actions", -1, "", eventHandler)
 368         end
 369         do
 370                 local eventHandler = r2.newComponent("LogicEntityAction")
 371                 eventHandler.Event.Type = "deactivation"
 372                 eventHandler.Event.Value = ""
 373                 eventHandler.Name = "deactivation"
 374
 375                 local action = r2.newComponent("ActionStep")
 376
 377                 action.Entity =  r2.RefId(zoneTrigger.InstanceId)
 378                 action.Action.Type = "deactivate"
 379                 action.Action.Value = ""
 380
 381                 table.insert(eventHandler.Actions, action)
 382
 383                 local behaviorId = this.Behavior.InstanceId
 384                 assert(behaviorId)
 385                 r2.requestInsertGhostNode(behaviorId, "Actions", -1, "", eventHandler)
 386         end
 387
 388
 389
 390 end
 391
 392
 393 component.createComponent = function(x, y)
 394
 395         local comp = r2.newComponent("Ambush")
 396         assert(comp)
 397         assert(comp.Position)
 398
 399         comp.Base = r2.Translator.getDebugBase("palette.entities.botobjects.user_event")
 400         comp.Name = r2:genInstanceName(i18n.get("uiR2EdAmbush")):toUtf8()
 401         comp.Position.x = x
 402         comp.Position.y = y
 403         comp.Position.z = r2:snapZToGround(x, y)
 404
 405         local zoneTrigger = r2.Features["ZoneTrigger"].Components.ZoneTrigger.createComponent(x + 3, y + 3)
 406         zoneTrigger.Name = comp.Name.." "..i18n.get("uiR2EDZoneTrigger"):toUtf8()--r2:genInstanceName(i18n.get("uiR2EdZoneTrigger")):toUtf8()
 407         zoneTrigger.InheritPos = 0
 408         zoneTrigger.Deletable = false
 409         table.insert(comp.Components, zoneTrigger)
 410         comp._ZoneId = zoneTrigger.InstanceId
 411
 412         return comp
 413 end
 414
 415 component.create = function()
 416         if not r2:checkAiQuota() then return end
 417
 418         local function posOk(x, y, z)
 419                 debugInfo("Validate creation of an Ambush.")
 420                 if r2.mustDisplayInfo("Ambush") == 1 then
 421                         r2.displayFeatureHelp("Ambush")
 422                 end
 423                 r2.requestNewAction(i18n.get("uiR2EDNewAmbushFeatureAction"))
 424                 local component = feature.Components.Ambush.createComponent( x, y)
 425                 r2:setCookie(component.InstanceId, "DisplayProp", 1)
 426                 r2.requestInsertNode(r2:getCurrentAct().InstanceId, "Features", -1, "", component)
 427         end
 428
 429         local function posCancel()      end
 430
 431         local creature = r2.Translator.getDebugCreature("object_component_user_event.creature")
 432         r2:choosePos(creature, posOk, posCancel, "createFeatureAmbush")
 433 end
 434
 435 -----------------------------------------
 436 --- register the curent Feature to menu
 437
 438 function component:getLogicTranslations()
 439         -- register trad
 440         local logicTranslations = {
 441                 ["ApplicableActions"] = {
 442                         ["activate"]            = { menu=i18n.get( "uiR2AA0Activate"            ):toUtf8(),
 443                                                                         text=i18n.get( "uiR2AA1Activate"                ):toUtf8()},
 444                         ["deactivate"]          = { menu=i18n.get( "uiR2AA0Deactivate"          ):toUtf8(),
 445                                                                         text=i18n.get( "uiR2AA1Deactivate"              ):toUtf8()},
 446                         ["trigger"]                     = { menu=i18n.get( "uiR2AA0Trigger"                     ):toUtf8(),
 447                                                                         text=i18n.get( "uiR2AA1Trigger"                 ):toUtf8()},
 448                 },
 449                 ["Events"] = {
 450                         ["trigger"]                     = { menu=i18n.get( "uiR2Event0Trigger"          ):toUtf8(),
 451                                                                         text=i18n.get( "uiR2Event1Trigger"              ):toUtf8()},
 452                         ["activation"]          = { menu=i18n.get( "uiR2Event0Activation"       ):toUtf8(),
 453                                                                         text=i18n.get( "uiR2Event1Activation"   ):toUtf8()},
 454                         ["deactivation"]        = { menu=i18n.get( "uiR2Event0Deactivation"     ):toUtf8(),
 455                                                                         text=i18n.get( "uiR2Event1Deactivation" ):toUtf8()},
 456                 },
 457                 ["Conditions"] = {
 458                         ["is active"]           = { menu=i18n.get( "uiR2Test0Active"            ):toUtf8(),
 459                                                                         text=i18n.get( "uiR2Test1Active"                ):toUtf8()},
 460                         ["is inactive"]         = { menu=i18n.get( "uiR2Test0Inactive"          ):toUtf8(),
 461                                                                         text=i18n.get( "uiR2Test1Inactive"              ):toUtf8()}
 462                 }
 463         }
 464
 465         return logicTranslations
 466 end
 467
 468 r2.Features["Ambush"] =  feature
 469
 470