Module necro.game.data.item.weapon.CustomWeapons
Classes
| Material | |
| ModifierArgs | |
| Shape |
Functions
| registerMaterial (material) | |
| registerShape (shape) |
Classes
- Material
-
- name string Unique identifier of the weapon material
- friendlyName string Display name of the weapon material
- hint string Hint text for weapons with this material (overriding the shape-specific hint)
- components table Component table to add to weapons with this material
- modifier fun(ev:CustomWeapons.ModifierArgs) Called for each weapon type using this material
- palette MaterialColorFilter.Palette Palette (or list of palettes) to apply to weapons with this material
- excludeShapes string[] Don't generate weapons for this list of shapes with the current material
- includeShapes string[] Only generate weapons for this list of shapes, excluding any others
- ModifierArgs
-
- entity table Primary entity for this weapon type. If set to nil, skips generation of this weapon type
- entities table List of all entities to generate for this weapon type
- material CustomWeapons.Material Material data of this weapon type
- shape CustomWeapons.Shape Shape data of this weapon type
- Shape
-
- name string Unique identifier of the weapon shape
- friendlyName string Display name of the weapon shape
- hint string Hint text for the weapon shape (if encountered without a material)
- components table Component table to add to weapons with this shape
- modifier fun(ev:CustomWeapons.ModifierArgs) Called for each weapon type using this shape
- texture string Spritesheet texture for generating images for each weapon type (requires 5 vertical frames)
- framesX integer If specified, subdivides the texture into a number of frames along the X-axis
- paletteOverrides table Special palette to apply for this weapon with specific materials
- excludeMaterials string[] Don't generate weapons for this list of materials with the current shape
- includeMaterials string[] Only generate weapons for this list of materials, excluding any others