require_once (SLOODLE_DIRROOT.'/lib/sl_iolib.php') (line 22)

Include the IO library.

sloodle_array_to_vector (line 420)

Converts an array vector to a string vector.

Array vector should be associative, containing elements 'x', 'y', and 'z'. Converts to a string vector of format "<x,y,z>".

• see: sloodle_round_vector()
• see: sloodle_vector_to_array()

• $arr

sloodle_finished_login_coordinates (line 535)

Generates teleport coordinates for a user who has already finished the LoginZone process.

• return: An associated array vector

sloodle_get_config (line 56)

Gets a Sloodle configuration value from Moodle's "config" table.

This function does not necessarily need to be used. All configuration data is available as named members of Moodle's $CFG global variable. NOTE: in Sloodle debug mode, this function will terminate the script with an error if the name is not prefixed with "sloodle_".

• return: A string containing the configuration value, or false if the query failed (e.g. if the named value didn't exist)
• see: sloodle_set_config()

• string $name: The name of the value to be stored (should be prefixed with "sloodle_")

sloodle_get_distribution_list (line 237)

Gets an array of the names of all objects in the Object Distributor.

NOTE: Stored in the Moodle configuration table as value "sloodle_distrib_objects". Must be set manually as a pipe-delimited list, e.g. "object1|object2|object3".

• return: A numeric array of strings (will be an empty array if no objects are available)
• see: sloodle_get_config()

sloodle_get_loginzone_region (line 212)

Gets the name of the region where the site-wide LoginZone object was most recently rezzed.

• return: A string containing the name of a region (e.g. "virtuALBA"), or FALSE if no LoginZone data has yet been stored
• see: sloodle_get_config()
• see: sloodle_set_loginzone_region()

sloodle_get_module_id (line 489)

Obtains the ID number of the specified module (type not instance).

• return: Integer containing module ID, or false if it is not installed

• string $name: The name of the module type to check, e.g. 'sloodle' or 'forum'

sloodle_is_automatic_registration_on (line 118)

Determines whether or not automatic registration is enabled.

• return: True if automatic registration is enabled, or false otherwise.
• see: sloodle_get_config()
• see: sloodle_set_auth_method()
• see: sloodle_get_auth_method()

sloodle_is_installed (line 336)

Determines whether or not Sloodle is installed.

Queries Moodle's modules table for a Sloodle entry. NOTE: does not check for the presence of the Sloodle files.

• return: True if Sloodle is installed, or false otherwise.

sloodle_position_is_in_login_zone (line 505)

Checks if the specified position is in the current (site-wide) loginzone.

• return: True if position is in LoginZone, or false if not
• see: sloodle_login_zone_coordinates()

• mixed $pos: A string vector or an associated array vector

sloodle_random_position_in_zone (line 561)

Generates a random position within the specified cubic zone.

• return: An associative vector array

• array $zonemax: Associative array vector specifying the maximum boundary of the cubic zone
• array $zonemin: Associative array vector specifying the minimum boundary of the cubic zone

sloodle_random_web_password (line 372)

Generates a random web password Uses mixed-case letters and numbers to generate a random 8-character string.

• see: sloodle_random_security_token()

sloodle_send_xmlrpc_message (line 253)

Sends an XMLRPC message into Second Life.

• return: True if successful, or false if an error occurs

• string $channel: A string containing a UUID identifying the XMLRPC channel in SL to be used
• int $intval: An integer value to be sent in the message
• string $strval: A string value to be sent in the message

sloodle_set_config (line 35)

Sets a Sloodle configuration value.

This data will be stored in Moodle's "config" table, so it will persist even after Sloodle is uninstalled. After being set, it will be available (read-only) as a named member of Moodle's $CFG variable. NOTE: in Sloodle debug mode, this function will terminate the script with an error if the name is not prefixed with "sloodle_".

• return: True on success, or false on failure (may fail if database query encountered an error)
• see: sloodle_get_config()

• string $name: The name of the value to be stored (should be prefixed with "sloodle_")
• string $value: The string representation of the value to be stored

sloodle_set_loginzone_region (line 223)

Sets the name of the region where the site-wide LoginZone object was most recently rezzed.

• see: sloodle_set_config()
• see: sloodle_get_loginzone_region()

• string $region: A string containing the name of a region (e.g. "virtuALBA")

sloodle_set_prim_password (line 91)

Sets the site-wide Sloodle prim password from the configuration table.

Note: this functio peforms no validation on the input value, except to determine that it is a string.

• return: True if the database query was successful, or false otherwise
• see: sloodle_set_config()
• see: sloodle_get_prim_password()

• string $password: A string containing the prim password