This is an archive. | |
See the new ClickWiki at https://clickwiki.github.io. This version is just an archive for the purposes of migrating content to the new structure. |
Help:EventEditorExample
Contents
What's this?
One great way to demonstrate how to perform something in Fusion is to visually map out what it looks like in the Event Editor. This page will give a brief outline of how to use this template.
What does it look like?
Here's an example showing some general events.
|
|||||||
1 | • Timer equals 01"-00 | ||||||
2 | • No sample is playing
• Only one action when event loops |
||||||
3 | • Score of = 1 | ||||||
4 | • New condition |
If you have a lot of events, you may wish to consider using the Event List Template instead.
Normal MediaWiki syntax is used for displaying an icon in the condition. Please specify a size of 24 pixels for consistency, as well as a caption and link to the extension's page. This syntax is recommended:
[[File:Icon PlayerObject.png|24px|Player Object|link=Player Object]]
Getting Started
The above example is very unlikely for most situations, since the event editor example is intended to make it simpler to see specific conditions, actions and objects and how they are mapped out in the editor.
Below will briefly go over the code required that you can add to any page.
1. Start of Event Editor
Use this syntax to start off the Event Editor, it's essential to make it display properly. You'll be using additional templates with parameters to build up the events.
{{EventStart}}
2. Adding the columns
This adds the objects along the top of event editor.
{{EventColumn | ObjectIcon = Icon_SystemObject.png | ObjectName = System Object }}
You will need to specify the icon (which you can find out by finding it on Extensions page) as well as the object's name. Note that this is linked to the actual extensions page, so please beware of the spelling.
3. Adding a condition
Like as seen in the editor, type the wording of the condition as accurately as you can. Here's an example.
{{EventLine | Number = 2 | Negate = 1 | Conditions = No sample is playing}}
If you have more than one condition, you can type it on a new line (be sure to leave one blank due to how MediaWiki handles syntax.)
4. Adding a check and its action
Finally, for the preceding event line, you can add a tick to the corresponding object that the action applies to. As with MediaWiki table syntax, use the "pipe" character on a new line of its own to add a blank column. Again, here's an example for the sound object which shows the action when the mouse is over.
{{EventCheck | Actions = Play sample "music.ogg" }}
To add empty cells (both before and after a tick), use the pipe character ( " | " ) on a new line. In relation to the example preview above, line 2 looks like this:
{{EventLine | Number = 2 | Negate = 1 | Conditions = No sample is playing | {{EventCheck | Actions = Play sample "music.ogg" }} | | | |
This places the check mark in the second row (where the sound object is) as well as leaving 4 blank cells afterwards. It's important to remember this, otherwise the presentation of the Event Editor will look inconsistent with the design.
5. End of Event Editor
Use this syntax to indicate the end of the Event Editor. Like previously, this is an essential step to make it display properly, otherwise the rest of your page will become a formatted mess. As this tries to replicate the look in the actual software, specify the event number that would appear for the "New condition" button.
{{EventEnd | Number = 4 }}
Further Explaination
You can find more details about to use each template by clicking the corresponding pages:
- {{EventStart}} -- Start of Event Editor
- {{EventColumn}} -- for the top object columns.
- {{EventLine}} -- for new event lines.
- {{EventCheck}} -- for a checkbox in the corresponding column.
- {{EventEnd}} -- End of Event Editor