| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| 4rpl:commands:getunitsettings [2023/08/20 20:20] – [Description] Tweaked wording to match observed behavior. qople | 4rpl:commands:getunitsettings [2025/02/14 14:57] (current) – external edit 127.0.0.1 |
|---|
| ===== Description ===== | ===== Description ===== |
| Returns a table containing the settings for the specified unit. For certain built-in units, like an emitter, the settings are described in the table below. For these units, the settings are case sensitive. For custom units, the values returned are all defined variables for all attached scripts. If there are multiple scripts, the variables are merged and duplicates will overwrite each other. | Returns a table containing the settings for the specified unit. For certain built-in units, like an emitter, the settings are described in the table below. For these units, the settings are case sensitive. For custom units, the values returned are all defined variables for all attached scripts. If there are multiple scripts, the variables are merged and duplicates will overwrite each other. |
| | |
| | :!: In code versions before 4RPL V4 (Game version2.5.0 and higher), Calling GetUnitSettings (Or SetUnitSettings) on a custom unit that does not have a script attached throws an exception and causes the script to terminate at that line. If the unit has a script, it works normally, even if it's completely blank. As such, it would be a safe practice to attach a null script to every decorative unit on a map. |
| | |
| | |
| |
| =====Built-in Unit Names and Settings===== | =====Built-in Unit Names and Settings===== |
| | :!: Unit names are case sensitive. The full list of unit names are in [[Unit Types]] |
| <tabbox Emitter> | <tabbox Emitter> |
| |
| ? <color orange> Interval (int) </color> | ? <color orange> Interval (int) </color> |
| : The emission interval, in frames. | : The emission interval, in frames. |
| ? <color orange> Payload (int) </color> | ? <color orange> Payload (float) </color> |
| : How much to emit at each emission. | : How much to emit at each emission. |
| <tabbox SporeLauncher> | <tabbox SporeLauncher> |
| * **"Start"** (int): The start delay, in frames. \\ | * **"Start"** (int): The start delay, in frames. \\ |
| * **"Interval"** (int): The fire interval, in frames. \\ | * **"Interval"** (int): The fire interval, in frames. \\ |
| * **"Payload"** (int): How much creeper is contained in each entity. \\ | * **"Payload"** (float): How much creeper is contained in each entity. \\ |
| * **"Count"** (int): How many entities to create. \\ | * **"Count"** (int): How many entities to create. \\ |
| * **"Target"** (int): The target mode (0,1,2) for the created entities. 0 = Random, 1 = structures, 2 = location. \\ | * **"Target"** (int): The target mode (0,1,2) for the created entities. 0 = Random, 1 = structures, 2 = location. \\ |
| * **"Start"** (int): The start delay, in frames. \\ | * **"Start"** (int): The start delay, in frames. \\ |
| * **"Interval"** (int): The fire interval, in frames. \\ | * **"Interval"** (int): The fire interval, in frames. \\ |
| * **"Payload"** (int): How much creeper is contained in each entity. \\ | * **"Payload"** (float): How much creeper is contained in each entity. \\ |
| * **"Count"** (int): How many entities to create. \\ | * **"Count"** (int): How many entities to create. \\ |
| * **"Target"** (int): The target mode (0,1,2) for the created entities. 0 = Random, 1 = structures, 2 = location. \\ | * **"Target"** (int): The target mode (0,1,2) for the created entities. 0 = Random, 1 = structures, 2 = location. \\ |
| * **"Start"** (int): The start delay, in frames. \\ | * **"Start"** (int): The start delay, in frames. \\ |
| * **"Interval"** (int): The fire interval, in frames. \\ | * **"Interval"** (int): The fire interval, in frames. \\ |
| * **"Payload"** (int): How much creeper is contained in each entity. \\ | * **"Payload"** (float): How much creeper is contained in each entity. \\ |
| * **"Count"** (int): How many entities to create. \\ | * **"Count"** (int): How many entities to create. \\ |
| * **"Target"** (int): The target mode (0,1,2) for the created entities. 0 = Random, 1 = structures, 2 = location. \\ | * **"Target"** (int): The target mode (0,1,2) for the created entities. 0 = Random, 1 = structures, 2 = location. \\ |
| * **"ForbStart"** (int): The start delay, in frames, for emitting forbs. \\ | * **"ForbStart"** (int): The start delay, in frames, for emitting forbs. \\ |
| * **"ForbInterval"** (int): The interval, in frames, for emitting forbs. \\ | * **"ForbInterval"** (int): The interval, in frames, for emitting forbs. \\ |
| * **"ForbPayload"** (int): The amount of creeper each forb carries and puts in each orb that it throws. \\ | * **"ForbPayload"** (float): The amount of creeper each forb carries and puts in each orb that it throws. \\ |
| * **"ForbCount"** (int): The max active count of forbs for this skimmer factory. \\ | * **"ForbCount"** (int): The max active count of forbs for this skimmer factory. \\ |
| |
| * **"Start"** (int): The start delay, in frames. \\ | * **"Start"** (int): The start delay, in frames. \\ |
| * **"Interval"** (int): The fire interval, in frames. \\ | * **"Interval"** (int): The fire interval, in frames. \\ |
| * **"Payload"** (int): How much creeper is contained in each entity. \\ | * **"Payload"** (float): How much creeper is contained in each entity. \\ |
| * **"Count"** (int): How many entities to create. \\ | * **"Count"** (int): How many entities to create. \\ |
| * **"Target"** (int): The target mode (0,1,2) for the created entities. 0 = Random, 1 = structures, 2 = location. \\ | * **"Target"** (int): The target mode (0,1,2) for the created entities. 0 = Random, 1 = structures, 2 = location. \\ |
| * **"Target"** (int): The target mode (0,1,2) for the created entity. 0 = Random, 1 = structures, 2 = location. Note that for spores, this value only applies on unit creation. \\ | * **"Target"** (int): The target mode (0,1,2) for the created entity. 0 = Random, 1 = structures, 2 = location. Note that for spores, this value only applies on unit creation. \\ |
| * **"TargetLocation"** (V2): The target location for the entity. Only used when Target is set to 2. Note that for spores, this value only applies on unit creation. \\ | * **"TargetLocation"** (V2): The target location for the entity. Only used when Target is set to 2. Note that for spores, this value only applies on unit creation. \\ |
| * **"Payload"** (int): How much creeper is contained in this entity. \\ | * **"Payload"** (float): How much creeper is contained in this entity. \\ |
| |
| <tabbox Blob> | <tabbox Blob> |
| * **"Target"** (int): The target mode (0,1,2) for the created entity. 0 = Random, 1 = structures, 2 = location. \\ | * **"Target"** (int): The target mode (0,1,2) for the created entity. 0 = Random, 1 = structures, 2 = location. \\ |
| * **"TargetLocation"** (V2): The target location for the entity. Only used when Target is set to 2. \\ | * **"TargetLocation"** (V2): The target location for the entity. Only used when Target is set to 2. \\ |
| * **"Payload"** (int): How much creeper is contained in this entity. \\ | * **"Payload"** (float): How much creeper is contained in this entity. \\ |
| * **"LifeTime"** (int): How long, in frames, the entity should live. \\ | * **"LifeTime"** (int): How long, in frames, the entity should live. \\ |
| * **"CarryEgg"** (bool): Whether this blob can carry eggs. \\ | * **"CarryEgg"** (bool): Whether this blob can carry eggs. \\ |
| * **"Target"** (int): The target mode (0,1,2) for the created entity. 0 = Random, 1 = structures, 2 = location. \\ | * **"Target"** (int): The target mode (0,1,2) for the created entity. 0 = Random, 1 = structures, 2 = location. \\ |
| * **"TargetLocation"** (V2): The target location for the entity. Only used when Target is set to 2. \\ | * **"TargetLocation"** (V2): The target location for the entity. Only used when Target is set to 2. \\ |
| * **"Payload"** (int): How much creeper is contained in this entity. \\ | * **"Payload"** (float): How much creeper is contained in this entity. \\ |
| * **"LifeTime"** (int): How long, in frames, the entity should live. \\ | * **"LifeTime"** (int): How long, in frames, the entity should live. \\ |
| |
| * **"Target"** (int): The target mode (0,1,2) for the created entity. 0 = Random, 1 = structures, 2 = location. \\ | * **"Target"** (int): The target mode (0,1,2) for the created entity. 0 = Random, 1 = structures, 2 = location. \\ |
| * **"TargetLocation"** (V2): The target location for the entity. Only used when Target is set to 2. \\ | * **"TargetLocation"** (V2): The target location for the entity. Only used when Target is set to 2. \\ |
| * **"Payload"** (int): How much creeper is contained in this entity. \\ | * **"Payload"** (float): How much creeper is contained in this entity. \\ |
| |
| <tabbox DarkTower> | <tabbox DarkTower> |
| :!: Available in version 1.4 and later. | :!: Available in version 1.4 and later. |
| * **"Strength"** (int): The health of the wall/crazonium. Initial strength of a wall is 900000. | * **"Strength"** (int): The health of the wall/crazonium. Initial strength of a wall is 900000. |
| | |
| | <tabbox Totem> |
| | * **"WareType"** (int): A number (0 - 3) that represents the contained resource. 0 = energy, 1 = AC, 2 = ARG, 3 = Liftic |
| | * **"WareNum"** (int): The number of resources required to activate the totem. |
| | |
| </tabbox> | </tabbox> |
| |
