Command Service Parameters

Required Sim Info

class CommonRequiredSimInfoConsoleCommandParameter(*args, **kwargs)

Bases: sims4communitylib.services.commands.common_console_command_parameters.CommonConsoleCommandParameter

A param that requires a Sim ID, a Sims First Name, or a Sims First and Last Name of a Sim to be specified.

classmethod get_value(output: sims4communitylib.services.commands.common_console_command_output.CommonConsoleCommandOutput, *args) → <sphinx.ext.autodoc.importer._MockObject object at 0x7f09fdc68f50>

Retrieve the number of arguments taken and the value returned.

Optional Sim Info

class CommonOptionalSimInfoConsoleCommandParameter(*args, **kwargs)

Bases: sims4communitylib.services.commands.common_console_command_parameters.CommonRequiredSimInfoConsoleCommandParameter

A param that optionally requires a Sim ID, a Sims First Name, or a Sims First and Last Name of a Sim to be specified. If not provided, the active SimInfo will be supplied instead.

classmethod get_value(output: sims4communitylib.services.commands.common_console_command_output.CommonConsoleCommandOutput, *args) → <sphinx.ext.autodoc.importer._MockObject object at 0x7f09fdc68f50>

Retrieve the number of arguments taken and the value returned.

Required Game Object

class CommonRequiredGameObjectConsoleCommandParameter(*args, **kwargs)

Bases: sims4communitylib.services.commands.common_console_command_parameters.CommonConsoleCommandParameter

A param that requires the ID of a Game Object to specified.

classmethod get_value(output: sims4communitylib.services.commands.common_console_command_output.CommonConsoleCommandOutput, *args) → <sphinx.ext.autodoc.importer._MockObject object at 0x7f09fdc68610>

Retrieve the number of arguments taken and the value returned.