![]() ![]() |
|
|
|
|
|
|
|
|
|
![]() ![]() |
| Template Documentation |
|---|
| Note: portions of the template sample may not be visible without values provided. |
| View or edit this documentation. (About template documentation) |
| Editors can experiment in this template's sandbox and test case pages. |
Notes:
This template is used to generate animations on a sprite tile grid, for things such as Spells,Runes or Attacks.
Syntax:
{{Scene
|spell=
|effect=
|effect_2=
|background=
|caster=
|casting_effect=
|look_direction=
|caster_name =
|effect_on_caster=
|effect_under_caster=
|casting_effect=
|missile=
|missile_direction=
|missile_distance=
|target=
|effect_on_target=
|effect_under_target=
|damage_effect=
|rotate90 =
|sprite_1=
|sprite_2=
|sprite_3=
|sprite_4=
|sprite_5=
|edge_size=
}}
| Parameter | Required | Usage |
|---|---|---|
spell |
✗ | Spell name, common spell names are defined and contained within this page. For all existing spell patterns, see Module:SceneBuilder/data. This defines the spell shape and positions of the caster and target. |
background |
✗ | The background of the spell named after a class, currently available classes are:
canvas
lava_ground
grass
sand
black_marble
cobbled_pavement
dry_earth
jungle_grass
white_sand
stone_floor
dirt_floor
dirt_floor2
stone_tile
slate_floor
eldritch_floor
void
crystal_floor
|
effect |
✗ | Effect file name without file extension (see Effects). |
effect_2 |
✗ | Secondary effect (see Effects). |
caster |
✗ | Caster file name without file extension (ie. Demon, Monk, etc). Mage Outfit Male White[.gif] (default). Set the paramteter with an empty value to hide the target (e.g. {{...|caster=|effect=...}}, on creature pages unless a different value is added, it is automatically set to {{PAGENAME}}))
|
caster_name |
✗ | The name of the caster for creature pages (on creature pages unless a different value is added, it is automatically set to {{PAGENAME}}) |
look_direction |
✗ | south/east (the direction in which the caster is facing). |
effect_on_caster |
✗ | yes/no (whether the effect also appears on the caster like in Berserk spell). defaults to no |
effect_under_caster |
✗ | The name of effect appearing under the caster. |
casting_effect |
✗ | The effect name of the effect casting the spell makes on the caster. |
missile |
✗ | The Missile effect you want the caster to throw ('melee' cycles between melee weapon types). |
missile_direction |
✗ | Missile direction (north/south/east/west/north-west/north-east/south-west/south-east). |
missile_distance |
✗ | The distance you want the Missile to travel from the caster: horizontal/vertical. |
target |
✗ | The sprite file name without file extension. Defaults to Target Dummy (Object) {{...|target=|effect=...}})
|
effect_on_target |
✗ | The name of effect appearing on the target. |
effect_under_target |
✗ | The name of effect appearing under the target. |
damage_effect |
✗ | The name of damage effect appearing on the target. |
rotate90 |
✗ | rotates the scene 90 degrees, for waves. |
sprite_1 |
✗ | A sprite name without file extension (optional, can be added to the template if necessary). |
sprite_2 |
✗ | " |
sprite_3 |
✗ | " |
sprite_4 |
✗ | " |
sprite_5 |
✗ | " |
edge_size |
✗ | translates to pixels,configurable to accommodate large effect sprites that exit the edges of the table (defaults to 32,can be set to 0,32,64, or any 32x multiplier for tile symmetry). |
Example:
For a complete list of available scenes and their names see this page (data:Module:SceneBuilder/data).
a simple scene array creation tool can be found here.
Listed blow are some examples.
| Code | Result | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
template loaded without parameters {{Scene}}
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{{Scene
|spell=front_sweep
|background=cobbled_pavement
|effect=Explosion Effect
|caster=Black Knight
|casting_effect =Red Sparkles Effect
|caster_name=Knight
}}
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{{Scene|spell=3sqmstrike
|missile=Spear Missile
|missile_direction=south-east
|missile_distance=3/3
|background = jungle_grass
|caster=Orc Spearman
|caster_name=Orc Spearman
|target=Deer
|effect_on_target = Blood Effect
}}
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{{Scene|spell=great_explosion|effect=Fireball Effect}}
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{{Scene
|spell=5sqmwavewide
|background=dirt_floor
|effect=Fire Effect
|caster=Dragon
|caster_name=Dragon
|look_direction=east
|edge_size=32}}
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
removed target, switched wave 90deg, bigger edge_size
{{Scene
|spell=5sqmwavewide
|background=dirt_floor
|effect=Fire Effect
|caster=Dragon
|caster_name=Dragon
|look_direction=south
|rotate90=yes
|target=
|edge_size=64}}
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Balls on target:
{{Scene|spell=3sqmballtarget
|effect=Fireball Effect
|effect_on_target=Fireball Effect
|missile=Fire Missile
|missile_direction=south-east
|missile_distance=3/3
|caster=Warlock
|caster_name=Warlock
|target=Adventurer
|background=black_marble
}}
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{{Scene
|spell=2sqmballtarget
|caster=Dark Paladin
|caster_name=Royal Paladin
|effect=Divine Grenade Explosion
|effect_under_target=Divine Grenade Ticking
|damage_effect=Divine Grenade Explosion}}
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Rings:
{{Scene
|spell=4sqmring2
|effect=Poison Effect 1
|background=eldritch_floor
|caster=Decaying Totem
|effect_under_caster=Rooting Effect
|effect_on_caster=
|casting_effect=Steam Effect 2}}
|
|
array format explanation
In order for a spell to work in a scene it needs to be added to the array in data.
["your_spell_name"] = {{
0,0,0,
0,0,0,
0,0,0},
3},
the meaning of each number in the grid :
- 0= empty tile, where nothing happens
- 1= the main effect (template parameter 'effect')
- 2= the caster of the spell (template parameter 'caster')
- 3= the spell's target (template parameter 'target')
- 4= sprite_1: an extra sprite image for a spell or an object or anything (template parameter 'sprite_1')
- 5= sprite_2:""
- 6= sprite_3:""
- 7= sprite_4:""
- 8= sprite_5:""..it is possible to add more sprite parameters in the future
lastly, the number below the grid array signifies the column size, it is used to build the visual html table.


.gif)



















