Sloodle Object Type Identifier

From SLIS Second Life Wiki

Jump to: navigation, search

Sloodle Versions: 0.3 (?)

Contents

[edit] Purpose

The purpose of object type identifiers is to help the system configure objects correctly, and to help us maintain different versions of the tools. For example, if we develop a new version of the Sloodle WebIntercom tool, then its version identifier may change to "chat-1.1". However, we will still keep the "chat-1.0" code in the module, so that anybody using older objects is not left behind.


[edit] Format

There are two parts in an object type identifier:

  • Name
    • Short (<10 characters)
    • Lowercase letters only
  • Version
    • Positive number (can be decimal)

The two parts are separate by a dash (-), so it is very important that there is no other dash in the name.

[edit] Examples

(The actual object type identifiers do not include the quotation marks ("").


[edit] Usage

The object identifiers are used in various places:

Required:

  • LSL scripts - the main LSL script in any object should be named "sloodle_mod_TYPE", where TYPE is the object type identifier, such as "sloodle_mod_chat-1.0"
  • Object folders - each object type/version has its own folder in the Sloodle module, such as "sloodle/mod/chat-1.0" and "sloodle/mod/glossary-1.0"

Optional:

  • Module classes - some objects require Sloodle to 'wrap' Moodle functionality with module classes. These have short type names so that the programmer may identity then when calling the SloodleSession::load_module(..) function
  • LSL localization scripts - each object (or group of similar objects) has its own 'batch' of localization strings; the name of the batch is usually similar to the object type identifier, but normally without a version number


This page is part of the Sloodle documentation
SloodleDocs Home | User Documentation | Administrator Documentation | Developer Documentation | Sloodle Wiki Home
Personal tools