{% extends '_base.html' %} {% block title -%} {{ current_class.name }}:{{ current_method.name }} - Eluna {%- endblock %} {% block description -%} API documentation for the {{ current_class.name }}:{{ current_method.name }} method in the Eluna engine. {%- endblock %} {% block document_title -%} Method {{- current_class.name -}} : {{- current_method.name -}} {%- endblock %} {% block sidebar %}

{{ current_class.name }} Methods

{%- for method in current_class.methods %} {{ method.name }} {%- endfor %} {% endblock %} {% block content %}
{%- if current_method.documented %} {{ current_method.description|parse_links }} {%- else %}

This method is undocumented. Use at your own risk.

For temporary documentation, please check the LuaFunctions source file.

{%- endif %}

Synopsis

{%- for prototype in current_method.prototypes %}

{{ prototype }}

{%- endfor %}

Arguments

{%- if current_method.parameters|length > 0 %} {%- for param in current_method.parameters %}

{{ param.data_type|escape|parse_data_type }} {{ param.name if param.data_type != '...' }} {{- ' (' + param.default_value + ')' if param.default_value }}
{{ param.description|parse_links if param.description else 'See method description.' }}
{%- endfor %} {%- elif not current_method.documented %} Unknown. {%- else %} None. {%- endif %}

Returns

{%- if current_method.returned|length > 0 %} {%- for returned in current_method.returned %}

{{ returned.data_type|escape|parse_data_type }} {{ returned.name }}
{{ returned.description|parse_links if returned.description else 'See method description.' }}
{%- endfor %} {%- elif not current_method.documented %} Unknown. {%- else %} Nothing. {%- endif %}

{% endblock %}