Template:ScriptCommandPage: Difference between revisions

From Arx Libertatis Wiki
Jump to navigation Jump to search
m (Undo revision 6223 by Dscharrer (talk))
Tag: Undo
No edit summary
Line 103: Line 103:


   -->{{#if:{{#var:command_param_name}}|<!--
   -->{{#if:{{#var:command_param_name}}|<!--
      -->{{#ifeq:{{#sub:{{#var:command_param_name}}|0|1}}|<|<!--
        -->{{#vardefine:command_param_name|{{#sub:{{#var:command_param_name}}|1}}}}<!--
      -->|<!-- else
        -->&nbsp;<!--
      -->}}<!--
   


       Extract parameter type
       Extract parameter type
Line 118: Line 125:
       Print parameter definition
       Print parameter definition
       -->{{#if:{{#var:command_param_flag}}|<!--
       -->{{#if:{{#var:command_param_flag}}|<!--
         -->&nbsp;[{{#var:command_param_flag}}?{{Highlight|{{#var:command_param_type}}|{{#var:command_param_name}}}}{{#var:command_param_var}}]<!--
         -->[{{#var:command_param_flag}}?{{Highlight|{{#var:command_param_type}}|{{#var:command_param_name}}}}{{#var:command_param_var}}]<!--
       -->|<!-- else
       -->|<!-- else
         -->&nbsp;{{#if:{{#var:command_param_type}}|<!--
         -->{{#if:{{#var:command_param_type}}|<!--
             --><{{Highlight|{{#var:command_param_type}}|{{#var:command_param_name}}}}{{#var:command_param_var}}><!--
             -->&lt;{{Highlight|{{#var:command_param_type}}|{{#var:command_param_name}}}}{{#var:command_param_var}}&gt;<!--
         -->|<!-- else
         -->|<!-- else
             -->{{#var:command_param_name}}<!--
             -->{{#var:command_param_name}}<!--

Revision as of 06:49, 24 July 2022

The ScriptCommandPage script command is used to.

Usage

ScriptCommandPage

Context: Ignored


Usage

Template for script event pages

Parameters:

  • description (required) - short description of what the command is used for
  • context (optional) - type of entity that is required for this command - any, item, npc, camera, prop, self or none
  • special (optional) - special invocations in the format -f[lags] parameters... or keyword parameters..., one per line
  • default (optional) - set to false to disable the default invocation
  • flags (optional) - flags accepted by this command in the format f Description, one per line.
    The space after the flag character can be replaced with ? to exclude the flag from the default invocation or with ! to indicate that one of the marked flags is required for the default invocation. The first flag of each special invocation is always excluded from the default invocation.
  • parameters (optional) - parameters accepted by this command in the format name type Description
    name can be prefixed with f? to make the parameter dependent on flag -f.
    type can be suffixed with * to indicate that the parameter will automatically be dereferenced if it looks like a variable and with any additional non-space text starting with a non-alpha character to provide additional type info.
  • obsolete (optional) - set to true to mark the command as obsolete and unimplemented. No description or context should be provided in this case
  • intro (optional) - additional text to insert before the usage section