UnknownStatistic class

From m204wiki
Jump to navigation Jump to search

The UnknownStatistic exception class describes an exception associated with finding a string identifier that is not a valid or not an appropriate Model 204 statistic name.

To produce an UnknownStatistic exception for yourself, you typically use a SOUL Throw statement with the New UnknownStatistic constructor. For example, the following statement throws an UnknownStatistic exception for the value ABCD:

throw %(unknownStatistic):new(Name='abcd')

In addition to the New constructor that creates an object instance, the class includes a Name property that returns the invalid statistic name.

The UnknownStatistic class is available as of Sirius Mods version 7.3.

The UnknownStatistic methods

The following are the available UnknownStatistic class methods.

NameName of statistic not recognized by the method
NewCreate a new UnknownStatistic object

The methods in the class are described in the subsections that follow. In addition:

Name property

Name of statistic not recognized by the method (UnknownStatistic class)

This ReadOnly property returns a string that contains the name of the statistic that is not recognized by the calling method.


%string = unknownStatistic:Name

Syntax terms

%string This string variable is to contain the name of the unrecognized statistic.
unknownStatistic An UnknownStatistic object variable.

New constructor

Create a new UnknownStatistic object (UnknownStatistic class)

This Constructor generates an instance of an UnknownStatistic exception. As shown below, the required argument of the New method is a specific string value that is not the name of a valid or appropriate Model 204 user statistic for the method that is being called.


%unknownStatistic = [%(UnknownStatistic):]New( Name= string)

Syntax terms

%unknownStatistic An UnknownStatistic object variable.
[%(UnknownStatistic):] The class name in parentheses denotes a Constructor. See "Usage notes", below, for more information about invoking an UnknownStatistic Constructor.
Name This name required parameter specifies the string value (string) that is the name of the statistic for which you are providing the exception.

Usage notes

  • As described in Using New or other Constructors, New can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is Null:

    %unknown = new(Name='MYSTAT') %unknown = %(UnknownStatistic):new(Name='MYSTAT') %unknown = %unknown:new(Name='MYSTAT')