Click or drag to resize

ScribuntoConsole Class

This is preliminary documentation and is subject to change.

Represents a Scribunto Lua console. (action=scribunto-console)
Inheritance Hierarchy
SystemObject
  WikiClientLibrary.ScribuntoScribuntoConsole

Namespace: WikiClientLibrary.Scribunto
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.9.0-int.2+447d1d590e6726b7881f750a0a0e42908f3e417e
Syntax
Copy
public class ScribuntoConsole

The ScribuntoConsole type exposes the following members.

Constructors
 NameDescription
Public methodScribuntoConsole Creates a new Scribunto Lua evaluation console.
Top
Properties
 NameDescription
Public propertyModuleTitle Gets the currently used full module title, including the Module: namespace prefix. The title does not necessarily exist on the MediaWiki site.
Public propertySessionId Gets the current evaluation session ID.
Public propertySessionMaxSize Gets the maximum allowed server memory consumption of the current evaluation session.
Public propertySessionSize Gets the server memory consumption of the current evaluation session.
Public propertySite 
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodEvaluateAsync(String) Evaluates the specified Lua expression in the console.
Public methodEvaluateAsync(String, CancellationToken) Evaluates the specified Lua expression in the console.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodResetAsync Resets the current Lua evaluation session with empty module content and dummy module title.
Public methodResetAsync(String) Resets the current Lua evaluation session with the specified module content and dummy module title.
Public methodResetAsync(String, CancellationToken) Resets the current Lua evaluation session with the specified module content and dummy module title.
Public methodResetAsync(String, String, CancellationToken) Resets the current Lua evaluation session with the specified module content and module title.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Remarks

An instance of this class is equivalent to the "Debug console" shown in the Scribunto Lua module editor page.

The MediaWiki site need to have Scribunto extension installed to support this feature.

You need to call ResetAsync(String, String, CancellationToken) or its overload before starting any evaluation operations.

See Also