FutureProg functions
exposecharactertoliquid
Overload 1
exposecharactertoliquid overload 1
Boolean exposecharactertoliquid(Character character, Number liquidId, Number volume, Text bodypart)
Available in
- computer function
- computer program
- standard futureprog
Exposes a named external bodypart on a character to liquid. An optional dried percentage splits the supplied volume between normal exposure and residue placed on the outermost covering garment, or on the body when uncovered. Returns false for invalid inputs or a dry request whose liquid has no configured residue.
| Parameter | Type | Description |
|---|---|---|
character |
Character |
The character whose bodypart should be exposed to the liquid. |
liquidId |
Number |
The ID of the liquid to apply. |
volume |
Number |
The volume of liquid to apply in base fluid units. |
bodypart |
Text |
The keyword or name of the external bodypart to expose. |
Overload 2
exposecharactertoliquid overload 2
Boolean exposecharactertoliquid(Character character, Number liquidId, Number volume, Text bodypart, Number driedPercentage)
Available in
- computer function
- computer program
- standard futureprog
Exposes a named external bodypart on a character to liquid. An optional dried percentage splits the supplied volume between normal exposure and residue placed on the outermost covering garment, or on the body when uncovered. Returns false for invalid inputs or a dry request whose liquid has no configured residue.
| Parameter | Type | Description |
|---|---|---|
character |
Character |
The character whose bodypart should be exposed to the liquid. |
liquidId |
Number |
The ID of the liquid to apply. |
volume |
Number |
The volume of liquid to apply in base fluid units. |
bodypart |
Text |
The keyword or name of the external bodypart to expose. |
driedPercentage |
Number |
The percentage of the supplied volume to add as dried residue, from 0 to 100. |
Overload 3
exposecharactertoliquid overload 3
Boolean exposecharactertoliquid(Character character, Number liquidId, Text volume, Text bodypart)
Available in
- computer function
- computer program
- standard futureprog
Exposes a named external bodypart on a character to liquid. An optional dried percentage splits the supplied volume between normal exposure and residue placed on the outermost covering garment, or on the body when uncovered. Returns false for invalid inputs or a dry request whose liquid has no configured residue.
| Parameter | Type | Description |
|---|---|---|
character |
Character |
The character whose bodypart should be exposed to the liquid. |
liquidId |
Number |
The ID of the liquid to apply. |
volume |
Text |
The volume of liquid to apply, including its fluid-volume unit. |
bodypart |
Text |
The keyword or name of the external bodypart to expose. |
Overload 4
exposecharactertoliquid overload 4
Boolean exposecharactertoliquid(Character character, Number liquidId, Text volume, Text bodypart, Number driedPercentage)
Available in
- computer function
- computer program
- standard futureprog
Exposes a named external bodypart on a character to liquid. An optional dried percentage splits the supplied volume between normal exposure and residue placed on the outermost covering garment, or on the body when uncovered. Returns false for invalid inputs or a dry request whose liquid has no configured residue.
| Parameter | Type | Description |
|---|---|---|
character |
Character |
The character whose bodypart should be exposed to the liquid. |
liquidId |
Number |
The ID of the liquid to apply. |
volume |
Text |
The volume of liquid to apply, including its fluid-volume unit. |
bodypart |
Text |
The keyword or name of the external bodypart to expose. |
driedPercentage |
Number |
The percentage of the supplied volume to add as dried residue, from 0 to 100. |