Entity Page Rules

From Serious Sam Wiki
Jump to: navigation, search

Introduction

This page lists the rules for creation and editing of entity pages. Please stick to these rules so that the entity pages will have unified appearances making it easier for the user to find the desired information.

Rules

Entity & Page Name

When referring to an entity on its page use the exact name as it appears in the EntityList panel of the editor. In general that means that only the first letter is a capital letter. The page name should be the same with the exception of each first letter being a capital letter.
For instance, the entity page of CSimpleModelEntity should be called 'Simple Model' while in the page only 'Simple model' should be used.
Do not use class names, e.g. 'CSimpleModelEntity' or 'SimpleModel', with the exception of the script functions section.

General Layout

The following base code must be used to standardize layout:
[[FILE:[Picture_File]|thumb|right|[Caption]]]

==General information==
'''Class''': [Class_Name]

[Description]

==Properties==

==Script Functions==

===Methods===
{{[Class_Name_Short] Functions}}
{{Base Functions|[Class_Name]}}
[...]

===Events===
{{[Event_Name1]|[Entity_Name]}}
{{[Event_Name2]|[Entity_Name]}}
[...]

==Other Information==

==Relevant Pages and Links==

[[Category:Entities]]

Picture

[[FILE:[Picture_File]|thumb|right|[Caption]]]
[Picture_File]
Replace with filename of uploaded editor screenshot of editor model.
[Caption]
Replace with brief meaningful description, ie 'Editor model of [Class_Name].'

General Information

For standardized provision of general information use the following code:
===General Information===
'''Class''': [Class_Name]

[Description]
[Class_Name]
Replace with the exact class name of the entity as it appears in the EntityList panel of the editor.
[Description]
Replace with a description of the purpose of the entity. Make this as brief as possible and as meaningful as necessary.
Info 16x16.png Note: Keep in mind that the entity page serves as a reference document only, not as a tutorial on how to use the entity. Such information should be added on a different wiki page (potentially covering other entities as well) that is linked in the links section.

Properties

Properties information should only be added with templates:

Script Functions

Methods

Information about script functions should only be added through the use of templates.
===Methods===
{{[Class_Name_Short] Functions}}
{{Base Functions|[Class_Name]}}
[...]
[Class_Name_Short]
Replace with class name without 'C'-prefix and without 'Entity'-suffix.
[Class_Name]
Replace with exact class name of the entity as it appears in the EntityList panel of the editor.
  • {{[Class_Name_Short] Functions}} transcludes a template that has to be created separately.
Info 16x16.png Note: See Creating Script Method Tables for information on how to create such template.
  • {{Base Functions|[Class_Name]}} transcludes Template:Base Methods which holds methods inherited by all entites.
Info 16x16.png Note: For further inherited functions transclude also other templates like Template:BaseItem Methods if appropriate.

Events

Information about script events should only be added through the use of templates.
===Events===
{{[Event_Name1]|[Entity_Name]}}
{{[Event_Name2]|[Entity_Name]}}
[...]
[Event_Name#]
Replace with event name as it appears in the editor dropdown menu.
[Entity_Name]
Replace with name of the entity as it appears in the EntityList panel of the editor.
If a template does not exist yet it has to be created. See Creating Script Event Templates for information on how to create such template.

Other Information

This is an optional section in case there is other relevant information that serves as reference for the entity

Relevant Pages and Links

Use this section for relevant pages and links.

Category

Mandatory category:
  • Entities