Module: NWN::Gff::Helpers

Defined in:
lib/nwn/helpers.rb

Class Method Summary collapse

Class Method Details

._ip_cache_setup ⇒ Object

This sets up the IPRP cache. Used internally; no need to call this yourself.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/nwn/helpers.rb', line 38

def self._ip_cache_setup #:nodoc:
  return if defined? @costtables
  @costtables = {}
  @paramtables = {}
  @costtable_index = NWN::TwoDA::Cache.get('iprp_costtable')
  @paramtable_index = NWN::TwoDA::Cache.get('iprp_paramtable')
  @costtable_index.by_col('Name').each_with_index {|p,idx|
    next if @costtables[p.downcase]
    @costtables[p.downcase] = @costtables[idx] = NWN::TwoDA::Cache.get(p.downcase)
  }
  @paramtable_index.by_col('TableResRef').each_with_index {|p,idx|
    next if @paramtables[p.downcase]
    @paramtables[p.downcase] = @paramtables[idx] = NWN::TwoDA::Cache.get(p.downcase)
  }
  @properties = NWN::TwoDA::Cache.get('itemprops')
  @propdef = NWN::TwoDA::Cache.get('itempropdef')
  @subtypes = []
  @propdef.by_col('SubTypeResRef').each_with_index {|st, idx|
    @subtypes[idx] = NWN::TwoDA::Cache.get(st.downcase) if st != "****"
  }
  @prop_id_to_costtable = []
  @propdef.by_col('CostTableResRef').each_with_index {|st, idx|
    @prop_id_to_costtable[idx] = st.to_i if st != "****"
  }
  @prop_id_to_param1 = []
  @propdef.by_col('Param1ResRef').each_with_index {|st, idx|
    @prop_id_to_param1[idx] = st.to_i if st != "****"
  }
end

.item_property(name, subtype = nil, value = nil, param1 = nil, chance_appear = 100) ⇒ Object

This creates a NWN::Gff::Struct describing the item property in question.

name

The iprp name to resolve, for example Damage_Bonus_vs_Racial_Group

subtype

The iprp subtype, for example Elf

value

The iprp value, for example 2d12

param

The iprp param1, for example Acid

chance

The iprp appearance chance (whats this?)

Depends on the 2da cache set up correctly.

Note that the given arguments can be resolved with partial matches as well, as long as they are unique. (Fir -> Fire)

Arguments are case-insensitive.

Raises:

  • (ArgumentError) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/nwn/helpers.rb', line 101

def self.item_property name, subtype = nil, value = nil, param1 = nil, chance_appear = 100
  self._ip_cache_setup

  struct = NWN::Gff::Struct.new

  name = resolve_or_match_partial name, @properties.by_col('Label')
  index = @properties.by_col('Label').index(name)
  raise ArgumentError, "Cannot find property #{name}" unless index

  raise ArgumentError, "Property #{name} needs subtype of type #{NWN::TwoDA::Cache.get('itempropdef').by_col('SubTypeResRef', index)}, but none given." if
    @subtypes[index] && !subtype
  raise ArgumentError, "Property #{name} does not need subtype, but subtype given." if
    !@subtypes[index] && subtype

  subindex = 255

  if subtype
    subtype = resolve_or_match_partial subtype, @subtypes[index].by_col('Label')

    subindex = @subtypes[index].by_col('Label').index(subtype)
    raise ArgumentError, "Cannot find subtype #{subtype} for property #{name}" unless
      subindex

    raise ArgumentError, "Property #{name} requires a cost value of type #{@costtable_index.by_row(@prop_id_to_costtable[index], 'Name')}, but none given" if
      !value && @prop_id_to_costtable[index]
    raise ArgumentError, "Property #{name} does not require a cost value, but value given" if
      value && !@prop_id_to_costtable[index]
  end

  _cost = 255
  _cost_value = 0

  if value
    ct = @prop_id_to_costtable[index]
    value = resolve_or_match_partial value, @costtables[ct.to_i].by_col('Label')

    costvalue = @costtables[ct.to_i].by_col('Label').index(value)
    raise ArgumentError, "Cannot find CostValue for #{value}" unless costvalue
    _cost = ct
    _cost_value = costvalue
  end
  struct.merge!({
    'CostTable' => Element.new('CostTable', :byte, _cost),
    'CostValue' => Element.new('CostValue', :word, _cost_value)
  })


  raise ArgumentError, "Property #{name} requires a param1 value of type #{@paramtable_index.by_row(@prop_id_to_param1[index], 'TableResRef')}, but none given" if
    !param1 && @prop_id_to_param1[index]
  raise ArgumentError, "Property #{name} does not require a param1 value, but value given" if
    param1 && !@prop_id_to_param1[index]

  _param1 = 255
  _param1_value = 0

  if param1
    pt = @prop_id_to_param1[index]
    param1 = resolve_or_match_partial param1, @paramtables[pt.to_i].by_col('Label')

    param1value = @paramtables[pt.to_i].by_col('Label').index(param1)
    raise ArgumentError, "Cannot find Param1 for #{param1}" unless param1value
    _param1 = pt
    _param1_value = param1value
  end
  struct.merge!({
    'Param1' => Element.new('Param1', :byte, _param1),
    'Param1Value' => Element.new('Param1Value', :byte, _param1_value)
  })

  struct.merge!({
    'PropertyName' => Element.new('PropertyName', :word, index),
    'Subtype' => Element.new('Subtype', :word, subindex),
    'ChanceAppear' => Element.new('ChanceAppear', :byte, chance_appear)
  })

  struct.struct_id = 0
  struct
end

.resolve_or_match_partial(name_spec, list) ⇒ Object

:nodoc:

Raises:

  • (ArgumentError) 


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/nwn/helpers.rb', line 68

def self.resolve_or_match_partial name_spec, list #:nodoc:
  name_spec = name_spec.downcase

  raise ArgumentError, "?-expand: #{list.inspect}" if name_spec == '?'

  list.each {|l|
    return l if l.downcase == name_spec
  }

  substrings = list.select {|l| l.downcase.index(name_spec) }
  if substrings.size == 1
    return substrings[0]
  elsif substrings.size > 1
    raise ArgumentError, "Cannot resolve #{name_spec}. Partial matches: #{substrings.inspect}."
  end

  raise ArgumentError, "Cannot resolve #{name_spec}."
end