Template:Sdk event page: Difference between revisions

From Virtual Paradise Wiki
Jump to navigation Jump to search
(page template for SDK events)
 
(made category optional)
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{{2}}}
<div style="float: right; width: 400px; {{box-sizing}} {{bg linearfade|color={{{color|204,100%,90%}}}}}; padding: 32px 16px 16px 16px; border-radius: 0px 0px 16px 16px;">'''Event set and handler snippet'''
== Attributes ==
<code style="display: block; padding: 8px; margin: 8px 0px; border: 1px dashed hsl(204,100%,70%);">vp_event_set(instance, VP_EVENT_{{uc:{{{1|unknown}}}}}, event_{{lc:{{{1|unknown}}}}});
{{#if: {{{attributes|}}} |{{{attributes}}}|:''No attributes are used for this SDK event''}}
{{#if: {{{behavior|}}} |== Behavior ==
{{{behavior}}}|}}
== Examples ==
{{#ifexist: {{FULLPAGENAME}}/Examples | {{{{FULLPAGENAME}}/Examples}} |:''This SDK event has no usage examples; please add at least one to [[{{FULLPAGENAME}}/Examples|this page]].''}}
{{#if: {{{seealso|}}} |== See also ==
{{{seealso}}}|}}


{{DEFAULTSORT:{{{1}}}}}
void event_{{lc:{{{1|unknown}}}}}(VPInstance instance) { }</code></div>
{{DISPLAYTITLE:VP_EVENT_{{uc:{{{1}}}}}}}
{{{2}}}__NOTOC__
<includeonly>[[Category:SDK events]]</includeonly><noinclude>
== Attributes ==__NOEDITSECTION__
{{#if: {{{attributes|}}} | {{sdk attribute table|{{{attributes}}}}} |:''No attributes are used for this event''}}
== Behavior ==__NOEDITSECTION__
{{#if: {{{behavior|}}} | {{{behavior}}} |:''There is no special behavior for this event''}}
{{#if: {{{caveats|}}} |== Caveats ==__NOEDITSECTION__
{{{caveats}}} |}}
== Examples ==__NOEDITSECTION__
{{#if: {{{examples|}}} | {{{examples}}} |:''This event has no usage examples; please add at least one to [{{canonicalurl:{{FULLPAGENAMEE}}|action=edit}} this page]''}}
{{#if: {{{seealso|}}} |== See also ==__NOEDITSECTION__
{{{seealso}}}
|}}{{{extra|}}}
<includeonly>{{DEFAULTSORT:{{{1}}}}} {{DISPLAYTITLE:VP_EVENT_{{uc:{{{1}}}}}}} {{{category|[[Category:SDK events]]}}}</includeonly><noinclude>


== Usage ==
== Usage ==
<pre>{{SDK event page|Event name|Event description
<pre>{{sdk event page|Event name|Event description
|attributes=
|attributes={{sdk attribute row|type|name|description}}
|behavior=
|behavior=
|caveats=
|examples=
|seealso=
|seealso=
}}</pre>
}}</pre>

Latest revision as of 21:57, 27 September 2013

Event set and handler snippet

vp_event_set(instance, VP_EVENT_UNKNOWN, event_unknown);

void event_unknown(VPInstance instance) { }

{{{2}}}

Attributes

No attributes are used for this event

Behavior

There is no special behavior for this event

Examples

This event has no usage examples; please add at least one to this page


Usage

{{sdk event page|Event name|Event description
|attributes={{sdk attribute row|type|name|description}}
|behavior=
|caveats=
|examples=
|seealso=
}}