|
Database Teleporter BRIGADOON-0009
An Open Simulator Teleporter using a central database.
|
Go to the source code of this file.
Functions | |
| rdProcessFailureMessage (string FailureMessage) | |
| Convert error messages into something that is more readable. | |
| integer | rdSetAnonType (string ValueObject, integer InfoInteger) |
| Set of Reset the Anonymous Flag. | |
| integer | rdSetRemoteUpdate (string ValueObject, integer InfoInteger) |
| integer | rdSetExtendedLocal (string ValueObject, integer InfoInteger) |
| Set of Reset the Extended Local Telportation Flag. | |
| integer | rdGetVersionNumber (string VersionString) |
| Convert Version String into an Integer. | |
| integer | rdSetLocationType (string ValueString, integer LocationInfo) |
| Set the teleporter Location Type. | |
| string | rdAdjustPosition (string Line) |
| rdSaveNewTeleportNotecard (list teleport_list) | |
| Save the Teleportation Destinations into a Notecard. | |
| rdSendHeartbeatMessage () | |
Variables | |
| string | VERSION_STRING = "2.0.0" |
| float | MINIMUM_HEARTBEAT_PERIOD = 0.1 |
| The fastest allowable heartbeat. | |
| float | DEFAULT_LOCATION_OFFSET = 2.0 |
| The default offset from the landing teleport position when using a display panel;. | |
| string | CONFIG_NOTECARD_NAME = "brigadoon_teleporter.config" |
| string | CONFIG_DESTINATIONS_NAME = "teleport_destinations.config" |
| string | COMMENT_PREAMBLE = "//" |
| integer | COMMENT_PREAMBLE_LENGTH = 2 |
| string | DATABASE_INTERFACE = "DATABASE_INTERFACE" |
| string | LOCATION_NAME = "LOCATION_NAME" |
| string | LANDING_OFFSET = "LANDING_OFFSET" |
| The Configuration File Identifier for the Landing Offset Distance. | |
| string | HEARTBEAT_PERIOD = "HEARTBEAT_PERIOD" |
| The Configuration File Identifier for the Heartbeat Period. | |
| string | FRONT_OFFSET_ANGLE = "FRONT_OFFSET_ANGLE" |
| The Configuration File Identifier for the Look At Angle. | |
| string | LOCATION_TYPE = "LOCATION_TYPE" |
| The Configuration File Identifier for the Location Type. | |
| string | GROUP_LOCATION = "GROUP" |
| The Configuration File Identifier for all Goup Locations. | |
| string | ANONYMOUS_UNIT = "ANONYMOUS" |
| The configuration Identifier for Anonymous Operation. | |
| string | REMOTE_UPDATE = "REMOTE_UPDATE" |
| Flag to Enable Auto Updating. | |
| string | EXTENDED_LOCAL = "EXTENDED_LOCAL" |
| The Extended Local indentifier. | |
| string | REGION_LOCATION = "REGION" |
| The Configuration File Identifier for the Regional Location. | |
| string | WORLD_LOCATION = "WORLD" |
| The Configuration File Identifier for the World Location. | |
| string | METAVERSE_LOCATION = "METAVERSE" |
| The Configuration File Identifier for the Metaverse Location. | |
| integer | GROUP_FLAG = 1 |
| Numeric identifier of a Group Location. | |
| integer | REGION_FLAG = 2 |
| integer | WORLD_FLAG = 4 |
| integer | METAVERSE_FLAG = 8 |
| integer | ANONYMOUS_FLAG = 16 |
| integer | REMOTE_UPDATE_FLAG = 64 |
| integer | EXTENDED_LOCAL_FLAG = 32 |
| integer | LOCATION_MASK = ~(GROUP_FLAG + REGION_FLAG + WORLD_FLAG + METAVERSE_FLAG) |
| A mask to remove locaiton information. | |
| string | LOCALITY_GROUP = "LOCALITY_GROUP" |
| Configuration File Identifier for the Regional Location. | |
| float | TIMER_OFF = 0.0 |
| float | MINIMUM_HEARTBEAT_INTERVAL = 600 |
| float | MINIMUM_OFFSET = 0.5 |
| Minimum allowable offset. | |
| float | MAXIMUM_OFFSET = 10.0 |
| Maximum allowable offset. | |
| string | location_world |
| string | location_name |
| string | locality_group = "null" |
| string | location_region |
| float | landing_offset = DEFAULT_LOCATION_OFFSET |
| The distance offset between the landing and the Teleporter. | |
| key | heartbeat_key |
| The Heatbeat HTTP Requrest Key. | |
| list | destination_data |
| A list of the Teleport Destinations from the COnfiguration File. | |
| float | front_offset_angle = 0.0 |
| The LookAt angle after teleportation. | |
| string | database_interface |
| float | heartbeat_period |
| Interval in seconds between Heartbeat messages. | |
| list | teleport_list |
| The list of Teleport Destinations. | |
| integer | location_info = 0 |
| Information on the Teleporter Location. | |
| integer | version_number |
| Version number as integer. | |
| list | destination_preamble |
| string rdAdjustPosition | ( | string | Line | ) |
Definition at line 528 of file teleport_heartbeat.osl.
References location_region, and location_world.
| integer rdGetVersionNumber | ( | string | VersionString | ) |
Convert Version String into an Integer.
| Version | String to be converted |
Definition at line 482 of file teleport_heartbeat.osl.
| rdProcessFailureMessage | ( | string | FailureMessage | ) |
Convert error messages into something that is more readable.
| The | error message string to be decoded |
This routine takes the abbreviated error message and expands this to an error message that should be more readable by a user not familar with how the program operates.
Definition at line 387 of file teleport_heartbeat.osl.
| rdSaveNewTeleportNotecard | ( | list | teleport_list | ) |
Save the Teleportation Destinations into a Notecard.
| telport_list | List of telportation destinations |
This routine will remove the Teleportation Notecard and make a new Notecard.
Definition at line 600 of file teleport_heartbeat.osl.
References CONFIG_DESTINATIONS_NAME, destination_preamble, and teleport_list.
| rdSendHeartbeatMessage | ( | ) |
\break Send a heartbeat to the database via the webserver
This message sends a heartbeat command to the program controlling the database. The message contains the following information:
This message serves two purposes. First, it confirms that the teleporter still exists and is operational. Secondly, it confirms, and updates if necessary, the information about the Teleporter.
This information allows the database program to automatically delete destinations where the teleporter and by inference, the regions has disappeared.
Definition at line 634 of file teleport_heartbeat.osl.
References database_interface, front_offset_angle, heartbeat_key, landing_offset, locality_group, location_info, location_name, location_world, teleport_list, and version_number.
| integer rdSetAnonType | ( | string | ValueObject, |
| integer | InfoInteger ) |
Set of Reset the Anonymous Flag.
Definition at line 446 of file teleport_heartbeat.osl.
References ANONYMOUS_FLAG.
| integer rdSetExtendedLocal | ( | string | ValueObject, |
| integer | InfoInteger ) |
Set of Reset the Extended Local Telportation Flag.
Definition at line 469 of file teleport_heartbeat.osl.
References EXTENDED_LOCAL_FLAG.
| integer rdSetLocationType | ( | string | ValueString, |
| integer | LocationInfo ) |
Set the teleporter Location Type.
| ValueString | The String holding the Types |
| LocationInfo | Current Location Info value |
Definition at line 500 of file teleport_heartbeat.osl.
References GROUP_FLAG, GROUP_LOCATION, LOCATION_MASK, METAVERSE_FLAG, METAVERSE_LOCATION, REGION_FLAG, REGION_LOCATION, WORLD_FLAG, and WORLD_LOCATION.
| integer rdSetRemoteUpdate | ( | string | ValueObject, |
| integer | InfoInteger ) |
Definition at line 458 of file teleport_heartbeat.osl.
References REMOTE_UPDATE_FLAG.
| integer ANONYMOUS_FLAG = 16 |
Definition at line 199 of file teleport_heartbeat.osl.
| string ANONYMOUS_UNIT = "ANONYMOUS" |
The configuration Identifier for Anonymous Operation.
Definition at line 122 of file teleport_heartbeat.osl.
| string COMMENT_PREAMBLE = "//" |
Definition at line 64 of file teleport_heartbeat.osl.
| integer COMMENT_PREAMBLE_LENGTH = 2 |
Definition at line 71 of file teleport_heartbeat.osl.
| string CONFIG_DESTINATIONS_NAME = "teleport_destinations.config" |
Definition at line 56 of file teleport_heartbeat.osl.
| string CONFIG_NOTECARD_NAME = "brigadoon_teleporter.config" |
Definition at line 46 of file teleport_heartbeat.osl.
| string DATABASE_INTERFACE = "DATABASE_INTERFACE" |
Definition at line 77 of file teleport_heartbeat.osl.
| string database_interface |
Definition at line 322 of file teleport_heartbeat.osl.
| float DEFAULT_LOCATION_OFFSET = 2.0 |
The default offset from the landing teleport position when using a display panel;.
This value can be altered in the "teleporter.config" notecard.
NOTE: This value MUST be in the range of 0.5 to 10 metres. If it is outside of this range it will be clamped to the closest valid value.
Definition at line 38 of file teleport_heartbeat.osl.
| list destination_data |
A list of the Teleport Destinations from the COnfiguration File.
Definition at line 307 of file teleport_heartbeat.osl.
| list destination_preamble |
Definition at line 361 of file teleport_heartbeat.osl.
Referenced by rdSaveNewTeleportNotecard().
| string EXTENDED_LOCAL = "EXTENDED_LOCAL" |
The Extended Local indentifier.
Definition at line 136 of file teleport_heartbeat.osl.
| integer EXTENDED_LOCAL_FLAG = 32 |
Definition at line 217 of file teleport_heartbeat.osl.
| string FRONT_OFFSET_ANGLE = "FRONT_OFFSET_ANGLE" |
The Configuration File Identifier for the Look At Angle.
Definition at line 101 of file teleport_heartbeat.osl.
| float front_offset_angle = 0.0 |
The LookAt angle after teleportation.
This value defaults to 0 if an angle isn't supplied in the configuration notecard.
Definition at line 316 of file teleport_heartbeat.osl.
Referenced by rdSendHeartbeatMessage().
| integer GROUP_FLAG = 1 |
Numeric identifier of a Group Location.
Definition at line 169 of file teleport_heartbeat.osl.
Referenced by rdSetLocationType().
| string GROUP_LOCATION = "GROUP" |
The Configuration File Identifier for all Goup Locations.
Show all instantances of a Group location, even it is isn't associated with the Group location identification of this Teleporter.
Definition at line 116 of file teleport_heartbeat.osl.
Referenced by rdSetLocationType().
| key heartbeat_key |
The Heatbeat HTTP Requrest Key.
Definition at line 301 of file teleport_heartbeat.osl.
Referenced by rdSendHeartbeatMessage().
| string HEARTBEAT_PERIOD = "HEARTBEAT_PERIOD" |
The Configuration File Identifier for the Heartbeat Period.
Definition at line 95 of file teleport_heartbeat.osl.
| float heartbeat_period |
Interval in seconds between Heartbeat messages.
Definition at line 329 of file teleport_heartbeat.osl.
| string LANDING_OFFSET = "LANDING_OFFSET" |
The Configuration File Identifier for the Landing Offset Distance.
Definition at line 89 of file teleport_heartbeat.osl.
| float landing_offset = DEFAULT_LOCATION_OFFSET |
The distance offset between the landing and the Teleporter.
Definition at line 295 of file teleport_heartbeat.osl.
Referenced by rdSendHeartbeatMessage().
| string LOCALITY_GROUP = "LOCALITY_GROUP" |
Configuration File Identifier for the Regional Location.
Definition at line 232 of file teleport_heartbeat.osl.
| string locality_group = "null" |
Definition at line 282 of file teleport_heartbeat.osl.
Referenced by rdSendHeartbeatMessage().
| integer location_info = 0 |
Information on the Teleporter Location.
Definition at line 343 of file teleport_heartbeat.osl.
Referenced by rdSendHeartbeatMessage().
| integer LOCATION_MASK = ~(GROUP_FLAG + REGION_FLAG + WORLD_FLAG + METAVERSE_FLAG) |
A mask to remove locaiton information.
If the location_info is ANDed with this mask, all of the location types are removed.
Definition at line 225 of file teleport_heartbeat.osl.
Referenced by rdSetLocationType().
| string LOCATION_NAME = "LOCATION_NAME" |
Definition at line 83 of file teleport_heartbeat.osl.
| string location_name |
Definition at line 280 of file teleport_heartbeat.osl.
| string location_region |
Definition at line 289 of file teleport_heartbeat.osl.
| string LOCATION_TYPE = "LOCATION_TYPE" |
The Configuration File Identifier for the Location Type.
Definition at line 107 of file teleport_heartbeat.osl.
| string location_world |
Definition at line 271 of file teleport_heartbeat.osl.
| float MAXIMUM_OFFSET = 10.0 |
Maximum allowable offset.
Definition at line 258 of file teleport_heartbeat.osl.
| integer METAVERSE_FLAG = 8 |
Definition at line 187 of file teleport_heartbeat.osl.
| string METAVERSE_LOCATION = "METAVERSE" |
The Configuration File Identifier for the Metaverse Location.
A Metaverse location is a location that is listed in the deestination list if it is not in the same world as the teleporter.
Definition at line 163 of file teleport_heartbeat.osl.
Referenced by rdSetLocationType().
| float MINIMUM_HEARTBEAT_INTERVAL = 600 |
Definition at line 246 of file teleport_heartbeat.osl.
| float MINIMUM_HEARTBEAT_PERIOD = 0.1 |
The fastest allowable heartbeat.
This is the minimum interval allowed between heartbeats. This is set to prevent the script from flooding the databse webserver with heartbeat messages, in what would essentially be a denial of service attack.
Definition at line 27 of file teleport_heartbeat.osl.
| float MINIMUM_OFFSET = 0.5 |
Minimum allowable offset.
Definition at line 252 of file teleport_heartbeat.osl.
| integer REGION_FLAG = 2 |
Definition at line 175 of file teleport_heartbeat.osl.
| string REGION_LOCATION = "REGION" |
The Configuration File Identifier for the Regional Location.
A region location is a location that is only included in the destination list if it is in the same region as the teleporter.
Definition at line 145 of file teleport_heartbeat.osl.
Referenced by rdSetLocationType().
| string REMOTE_UPDATE = "REMOTE_UPDATE" |
Flag to Enable Auto Updating.
The Configuration File Identifier for REmote Updates.
This flag indicates whether auto updating is authorised. If this bit is set to zero, auto updating is disable, otherwise, it is will enable auto updating.
Definition at line 129 of file teleport_heartbeat.osl.
| integer REMOTE_UPDATE_FLAG = 64 |
Definition at line 209 of file teleport_heartbeat.osl.
| list teleport_list |
The list of Teleport Destinations.
Definition at line 336 of file teleport_heartbeat.osl.
Referenced by rdSaveNewTeleportNotecard(), and rdSendHeartbeatMessage().
| float TIMER_OFF = 0.0 |
Definition at line 238 of file teleport_heartbeat.osl.
| integer version_number |
Version number as integer.
This integer takes the version string like "1.2.3" into a single integer. The integer is calculated using:
(1 * 10000) + (2 * 100) + 3 => 10023
Definition at line 354 of file teleport_heartbeat.osl.
Referenced by rdSendHeartbeatMessage().
| string VERSION_STRING = "2.0.0" |
Definition at line 17 of file teleport_heartbeat.osl.
| integer WORLD_FLAG = 4 |
Definition at line 181 of file teleport_heartbeat.osl.
| string WORLD_LOCATION = "WORLD" |
The Configuration File Identifier for the World Location.
A world location is a location that is only included if the destination is in the same world as the teleporter.
Definition at line 154 of file teleport_heartbeat.osl.
Referenced by rdSetLocationType().