Skip to main content

ScoredAction

This item only works when running on the client. Client

An action that has a score, and may recieve priority from ScoredActionServiceClient

Properties​

PreferredChanged​

</>
ScoredAction.PreferredChanged: Signal<boolean>

Removing​

</>
ScoredAction.Removing: Signal<()>

Functions​

new​

</>
ScoredAction.new() → ScoredAction

Constructs a new ScoredAction. Should not be called directly. See ScoredActionServiceClient.GetScoredAction.

IsPreferred​

</>
ScoredAction:IsPreferred() → boolean

Returns whether the action is currently preferred

ObservePreferred​

</>
ScoredAction:ObservePreferred() → Observable<boolean>

SetScore​

</>
ScoredAction:SetScore(score: number) → ()

Sets the score

info

Big number is more important. At -math.huge we won't ever set preferred

GetScore​

</>
ScoredAction:GetScore() → number

Retrieves the score

PushPreferred​

</>
ScoredAction:PushPreferred() → MaidTask

Pushes that we're preferred

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new ScoredAction. Should not be called directly. See [ScoredActionServiceClient.GetScoredAction].",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ScoredAction"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 23,
                "path": "src/scoredactionservice/src/Client/ScoredAction.lua"
            }
        },
        {
            "name": "IsPreferred",
            "desc": "Returns whether the action is currently preferred",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 53,
                "path": "src/scoredactionservice/src/Client/ScoredAction.lua"
            }
        },
        {
            "name": "ObservePreferred",
            "desc": "",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 60,
                "path": "src/scoredactionservice/src/Client/ScoredAction.lua"
            }
        },
        {
            "name": "SetScore",
            "desc": "Sets the score\n\n:::info\nBig number is more important. At `-math.huge` we won't ever set preferred\n:::",
            "params": [
                {
                    "name": "score",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 73,
                "path": "src/scoredactionservice/src/Client/ScoredAction.lua"
            }
        },
        {
            "name": "GetScore",
            "desc": "Retrieves the score",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 83,
                "path": "src/scoredactionservice/src/Client/ScoredAction.lua"
            }
        },
        {
            "name": "PushPreferred",
            "desc": "Pushes that we're preferred",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "MaidTask"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 91,
                "path": "src/scoredactionservice/src/Client/ScoredAction.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "PreferredChanged",
            "desc": "",
            "lua_type": "Signal<boolean>",
            "source": {
                "line": 34,
                "path": "src/scoredactionservice/src/Client/ScoredAction.lua"
            }
        },
        {
            "name": "Removing",
            "desc": "",
            "lua_type": "Signal<()>",
            "source": {
                "line": 40,
                "path": "src/scoredactionservice/src/Client/ScoredAction.lua"
            }
        }
    ],
    "types": [],
    "name": "ScoredAction",
    "desc": "An action that has a score, and may recieve priority from [ScoredActionServiceClient]",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 7,
        "path": "src/scoredactionservice/src/Client/ScoredAction.lua"
    }
}