FutureProg functions
overridesdesc
Overload 1
overridesdesc overload 1
Boolean overridesdesc(Perceivable Perceivable, Text Tag, Text Description)
Available in
- computer function
- computer program
- standard futureprog
This function adds an override to the target's short description, which applies to all perceivers. Lasts until the ClearSDesc function is used on this perceivable.
| Parameter | Type | Description |
|---|---|---|
Perceivable |
Perceivable |
The perceivable who's description is being altered |
Tag |
Text |
A short bit of text identifying this specific effect and allowing you to remove it later |
Description |
Text |
The overriden description for this perceivable. Can include description markups |
Overload 2
overridesdesc overload 2
Boolean overridesdesc(Perceivable Perceivable, Text Tag, Text Description, TimeSpan Time)
Available in
- computer function
- computer program
- standard futureprog
This function adds an override to the target's short description, which applies to all perceivers. Lasts until the specified duration, or until ClearSDesc called if null.
| Parameter | Type | Description |
|---|---|---|
Perceivable |
Perceivable |
The perceivable who's description is being altered |
Tag |
Text |
A short bit of text identifying this specific effect and allowing you to remove it later |
Description |
Text |
The overriden description for this perceivable. Can include description markups |
Time |
TimeSpan |
The time that this effect will apply for. If null, applies forever |
Overload 3
overridesdesc overload 3
Boolean overridesdesc(Perceivable Perceivable, Text Tag, Text Description, TimeSpan Time, Perceiver Perceiver)
Available in
- computer function
- computer program
- standard futureprog
This function adds an override to the target's short description, which applies to the specified perceiver only (or all perceivers if null). Lasts until the specified duration, or until ClearSDesc called if null.
| Parameter | Type | Description |
|---|---|---|
Perceivable |
Perceivable |
The perceivable who's description is being altered |
Tag |
Text |
A short bit of text identifying this specific effect and allowing you to remove it later |
Description |
Text |
The overriden description for this perceivable. Can include description markups |
Time |
TimeSpan |
The time that this effect will apply for. If null, applies forever |
Perceiver |
Perceiver |
If specified, the description is only overriden for this perceiver. If null, applies to everyone |
Overload 4
overridesdesc overload 4
Boolean overridesdesc(Perceivable Perceivable, Text Tag, Text Description, TimeSpan Time, Perceiver Perceiver, Number Prog)
Available in
- computer function
- computer program
- standard futureprog
This function adds an override to the target's short description, which applies to the specified perceiver only (or all perceivers if null) and only when the filter prog applies. Lasts until the specified duration, or until ClearSDesc called if null.
| Parameter | Type | Description |
|---|---|---|
Perceivable |
Perceivable |
The perceivable who's description is being altered |
Tag |
Text |
A short bit of text identifying this specific effect and allowing you to remove it later |
Description |
Text |
The overriden description for this perceivable. Can include description markups |
Time |
TimeSpan |
The time that this effect will apply for. If null, applies forever |
Perceiver |
Perceiver |
If specified, the description is only overriden for this perceiver. If null, applies to everyone |
Prog |
Number |
A prog taking a perceivable and perceiver input (or just a single perceivable) and returning boolean that controls whether this applies |
Overload 5
overridesdesc overload 5
Boolean overridesdesc(Perceivable Perceivable, Text Tag, Text Description, TimeSpan Time, Perceiver Perceiver, Text Prog)
Available in
- computer function
- computer program
- standard futureprog
This function adds an override to the target's short description, which applies to the specified perceiver only (or all perceivers if null) and only when the filter prog applies. Lasts until the specified duration, or until ClearSDesc called if null.
| Parameter | Type | Description |
|---|---|---|
Perceivable |
Perceivable |
The perceivable who's description is being altered |
Tag |
Text |
A short bit of text identifying this specific effect and allowing you to remove it later |
Description |
Text |
The overriden description for this perceivable. Can include description markups |
Time |
TimeSpan |
The time that this effect will apply for. If null, applies forever |
Perceiver |
Perceiver |
If specified, the description is only overriden for this perceiver. If null, applies to everyone |
Prog |
Text |
A prog taking a perceivable and perceiver input (or just a single perceivable) and returning boolean that controls whether this applies |