Help:EventListExample

What's this?

If the Event Editor Template doesn't suit your needs to demonstrate code, the alternate is to list your events as they would appear in the Event List. 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	• Start of Frame
	Set score of Player 1 to 0.
	Set lives of Player 1 to 3.
2	• Timer equals 01"-00
	Create at (20,30)
3	• New Condition

Normal MediaWiki syntax is used for the "Text" parameters. If you are using an icon within the actions (for example lives = 0) then 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]]

If the events are simple, you may wish to consider the Event Editor Template instead.

Getting Started

Below is a brief overview of the code required and how it will fit onto a page.

1. Start of Event List

Use this syntax to start off the Event List, it's essential to make it display properly. You'll be using additional templates with parameters to build up the rest of the list.

 {{ListStart}} 

2. Adding the condition

This adds a new "line" that contains a new condition.

 {{ListCondition | Number = 1 | Actions = 1 | Text = Start of Frame }} 

If the condition features an image, you can copy and paste this as a base:

 [[File:Icon PlayerObject.png|24px|Player Object|link=Player Object]]

As with the design, it's important to specify how many actions you will be using as a parameter. If you leave this blank, the Wiki will assume you're only lising one event for that particular condition.

3. Adding actions

Type the action as would appear in the event list., including the file name of the object associated.

 {{ListAction | Icon = Icon SoundObject.png | Object = Sound Object | Text = Stop any sample playing }}

In many cases, there will be more than one action. Repeat this for each one, and remember to specify in the ListCondition code how many actions there is.

The order of events are important. Take a moment to double check they are in a logical sequence, to avoid confusing the reader later.

5. End of Event List

Use this syntax to indicate the end of the Event List. If this is not present, the rest of the page will display improperly. This code replicates the look in the actual software, by displaying a "New condition" button. Please follow a linear pattern and specify the line number in the context the user was to add a new condition.

 {{ListEnd | Number = 2 }}

Further Explanation

You can find more details about to use each template by clicking the corresponding pages:

• {{ListStart}} -- Start of Event List
• {{ListCondition}} -- to specify a new line / condition.
• {{ListAction}} -- to specify the actions for that condition.
• {{ListEnd}} -- End of Event List