OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | List of all members
OpenSim.Region.OptionalModules.Scripting.Minimodule.IScheduler Interface Reference

Public Member Functions

void RunIn (TimeSpan time)
 Schedule an event callback to occur when 'time' is elapsed. More...
 
void RunAndRepeat (TimeSpan time)
 Schedule an event callback to fire every "time". Equivilent to a repeating timer. More...
 

Properties

bool IfOccupied [get, set]
 Fire this scheduler only when the region has a user in it. More...
 
bool IfHealthy [get, set]
 Fire this only when simulator performance is reasonable. (eg sysload <= 1.0) More...
 
bool IfVisible [get, set]
 Fire this event only when the region is visible to a child agent, or there is a full agent in this region. More...
 
bool Schedule [get, set]
 Determines whether this runs in the master scheduler thread, or a new thread is spawned to handle your request. Running in scheduler may mean that your code does not execute perfectly on time, however will result in better region performance. More...
 

Detailed Description

Definition at line 32 of file IScheduler.cs.

Member Function Documentation

void OpenSim.Region.OptionalModules.Scripting.Minimodule.IScheduler.RunAndRepeat ( TimeSpan  time)

Schedule an event callback to fire every "time". Equivilent to a repeating timer.

Parameters
timeThe period to wait between executions
void OpenSim.Region.OptionalModules.Scripting.Minimodule.IScheduler.RunIn ( TimeSpan  time)

Schedule an event callback to occur when 'time' is elapsed.

Parameters
timeThe period to wait before executing

Property Documentation

bool OpenSim.Region.OptionalModules.Scripting.Minimodule.IScheduler.IfHealthy
getset

Fire this only when simulator performance is reasonable. (eg sysload <= 1.0)

Definition at line 59 of file IScheduler.cs.

bool OpenSim.Region.OptionalModules.Scripting.Minimodule.IScheduler.IfOccupied
getset

Fire this scheduler only when the region has a user in it.

Definition at line 53 of file IScheduler.cs.

bool OpenSim.Region.OptionalModules.Scripting.Minimodule.IScheduler.IfVisible
getset

Fire this event only when the region is visible to a child agent, or there is a full agent in this region.

Definition at line 66 of file IScheduler.cs.

bool OpenSim.Region.OptionalModules.Scripting.Minimodule.IScheduler.Schedule
getset

Determines whether this runs in the master scheduler thread, or a new thread is spawned to handle your request. Running in scheduler may mean that your code does not execute perfectly on time, however will result in better region performance.

Default: true

Definition at line 77 of file IScheduler.cs.


The documentation for this interface was generated from the following file: