ryzom/common/data_common/r2/r2_features_empty.lua

   1
   2 -- In Translation file
   3 -- Category : uiR2EdEmptyFeature --
   4 -- CreationFrom : uiR2EdEmptyParameters
   5
   6
   7 r2.Features.EmptyFeature = {}
   8
   9 local feature = r2.Features.EmptyFeature
  10
  11 feature.Name="EmptyFeature"
  12
  13 feature.Description="An empty feature"
  14
  15 feature.Components = {}
  16
  17
  18 --  #########################
  19 --  #   FEATURE FUNCTIONS   #
  20 --  #########################
  21
  22 --
  23 -- Registers the feature creation form used as a creation menu in the editor
  24 --
  25 function feature.registerForms()
  26         r2.Forms.EmptyFeatureForm =
  27         {
  28                 Caption = "uiR2EdEmptyParameters",
  29                 Prop =
  30                 {
  31                         -- The creation form's fields are defined here
  32                         {Name="Property1", Type="String", Category="UI Subsection"}
  33                 }
  34         }
  35
  36 end
  37
  38
  39
  40 feature.Components.EmptyFeature =
  41         {
  42                 BaseClass="LogicEntity",
  43                 Name="EmptyFeature",
  44                 Menu="ui:interface:r2ed_feature_menu",
  45
  46                 DisplayerUI = "R2::CDisplayerLua",
  47                 DisplayerUIParams = "defaultUIDisplayer",
  48                 DisplayerVisual = "R2::CDisplayerVisualEntity",
  49
  50                 Parameters = {},
  51
  52                 --
  53                 -- The different actions that can be performed by the feature ("activate", "wander", "spawn" etc.)
  54                 --
  55                 ApplicableActions = {},
  56
  57                 --
  58                 -- Events are the feature's states that may trigger actions on the feature. (ex: "on activation",
  59                 -- "on arrive at camp" etc.)
  60                 --
  61                 Events = {},
  62
  63                 --
  64                 -- Conditions can be tested on the feature, giving information about its state (ex: "is wandering", "is active" etc.)
  65                 --
  66                 Conditions = {},
  67
  68                 --
  69                 -- TextContexts is what the feature might say upon events (2 different kinds: spontaneous & interrogation texts)
  70                 --
  71                 TextContexts =          {},
  72
  73                 --
  74                 -- Not quite clear..
  75                 --
  76                 TextParameters =        {},
  77
  78                 --
  79                 -- Feature's parameters which can be modified by the GM at runtime.
  80                 --
  81                 LiveParameters =        {},
  82
  83                 --
  84                 -- Properties define the attributes of the feature.
  85                 -- They're all displayed in the properties window of the feature.
  86                 --
  87                 -- -Name: define the name of the property
  88                 --
  89                 -- -Type: define the type of the property and can be "String", "Number", "Table", "RefId" etc.
  90                 --
  91                 -- -Category: Define a subsection of the property window displayed within the editor, so that different properties
  92                 -- refering to the same feature's aspect can be grouped, and not added randomly in the window
  93                 --
  94                 -- WidgetStyle: define the type of UI widget that will be used to display the property. If not specified,
  95                 -- the property is displayed in a textBox.
  96                 --
  97                 Prop =
  98                 {
  99                         {Name="InstanceId", Type="String", Category="uiR2EDRollout_UISubsection", WidgetStyle="StaticText"}
 100                 },
 101
 102                 --
 103                 -- from base class
 104                 --
 105                 getParentTreeNode = function(this)
 106                         return this:getFeatureParentTreeNode()
 107                 end,
 108
 109                 --
 110                 -- from base class
 111                 --
 112                 appendInstancesByType = function(this, destTable, kind)
 113                         assert(type(kind) == "string")
 114                         --this:delegate():appendInstancesByType(destTable, kind)
 115                         r2.Classes.LogicEntity.appendInstancesByType(this, destTable, kind)
 116                         for k, component in specPairs(this.Components) do
 117                                 component:appendInstancesByType(destTable, kind)
 118                         end
 119                 end,
 120
 121                 --
 122                 -- from base class
 123                 --
 124                 getSelectBarSons = function(this)
 125                         return Components
 126                 end,
 127
 128                 --
 129                 -- from base class
 130                 --
 131                 canHaveSelectBarSons = function(this)
 132                         return false;
 133                 end,
 134
 135                 --
 136                 -- Called when running EditMode to create the feature locally without sending anything into the act (speed purpose).
 137                 --
 138                 onPostCreate = function(this)
 139                 end,
 140
 141                 pretranslate = function(this, context)
 142                         r2.Translator.createAiGroup(this, context)
 143                 end,
 144
 145                 translate = function(this, context)
 146                         r2.Translator.translateAiGroup(this, context)
 147                 end,
 148
 149                 getAvailableCommands = function(this, dest)
 150                         r2.Classes.LogicEntity.getAvailableCommands(this, dest) -- fill by ancestor
 151                         this:getAvailableDisplayModeCommands(dest)
 152                 end,
 153         }
 154
 155 --  ###########################
 156 --  #   COMPONENT FUNCTIONS   #
 157 --  ###########################
 158
 159 local component = feature.Components.EmptyFeature
 160
 161 --
 162 -- Called when running test mode to create the feature and insert it into the current act.
 163 --
 164 component.createGhostComponents = function(act, comp)
 165 end
 166
 167 --
 168 -- Creates an instance of the feature with attributes retrieved from the creation form
 169 component.createComponent = function(x, y)
 170
 171         local comp = r2.newComponent("EmptyFeature")
 172         assert(comp)
 173
 174         comp.Base = "palette.entities.botobjects.milestone"
 175         comp.Name = r2:genInstanceName(i18n.get("uiR2EdEmptyFeature")):toUtf8()
 176
 177         comp.Position.x = x
 178         comp.Position.y = y
 179         comp.Position.z = r2:snapZToGround(x, y)
 180
 181
 182         return comp
 183 end
 184
 185 --
 186 -- Displays the creation form of the feature and calls CreateComponent with the user input values
 187 --
 188 component.create = function()
 189
 190         if not r2:checkAiQuota() then return end
 191
 192         local function paramsOk(resultTable)
 193                 r2.requestNewAction(i18n.get("uiR2EDNewEmptyFeatureAction"))
 194                 local x = tonumber(  resultTable["X"] )
 195                 local y = tonumber( resultTable["Y"] )
 196
 197                 if not x or not y
 198                 then
 199                         debugInfo("Can't create Component")
 200                         return
 201                 end
 202                 local component = feature.Components.EmptyFeature.createComponent( x, y)
 203                 r2.requestInsertNode(r2:getCurrentAct().InstanceId, "Features", -1, "", component)
 204         end
 205
 206         local function paramsCancel()
 207                 debugInfo("Cancel form for 'EmptyFeature' creation")
 208         end
 209         local function posOk(x, y, z)
 210                 debugInfo(string.format("Validate creation of 'EmptyFeature' at pos (%d, %d, %d)", x, y, z))
 211                 r2:doForm("EmptyFeatureForm", {X=x, Y=y}, paramsOk, paramsCancel)
 212         end
 213         local function posCancel()
 214                 debugInfo("Cancel choice 'EmptyFeature' position")
 215         end
 216         r2:choosePos("object_milestone.creature", posOk, posCancel, "createFeatureBanditCamp")
 217 end
 218
 219
 220 --
 221 function feature.registerForms()
 222         r2.Forms.EmptyFeatureForm =
 223         {
 224                 Caption = "uiR2EdEmptyParameters",
 225                 Prop =
 226                 {
 227                         -- The creation form's fields are defined here
 228                         {Name="Property1", Type="String", Category="uiR2EDRollout_UISubsection"}
 229                 }
 230         }
 231 end
 232
 233 --
 234 -- The following functions are specific to the Feature
 235 --
 236 local component = feature.Components.EmptyFeature
 237
 238 component.getLogicAction = function(entity, context, action)
 239         local firstAction, lastAction = nil,nil
 240         return firstAction, lastAction
 241 end
 242
 243 component.getLogicCondition = function(this, context, condition)
 244         return nil,nil
 245 end
 246
 247 component.getLogicEvent = function(this, context, event)
 248         local eventHandler, firsCondition, lastCondition = nil, nil, nil
 249         return eventHandler, firsCondition, lastCondition
 250
 251 end
 252
 253 function component:registerMenu(logicEntityMenu)
 254         local name = i18n.get("uiR2EdEmptyFeature")
 255         logicEntityMenu:addLine(ucstring(name), "lua", "", "EmptyFeature")
 256 end
 257
 258 function component:getLogicTranslations()
 259
 260         local logicTranslations = {
 261                 ["ApplicableActions"] = {},
 262                 ["Events"] = {},
 263                 }
 264         return logicTranslations
 265 end
 266
 267 r2.Features["EmptyFeature"] =  feature
 268