-
If you are citizen of an European Union member nation, you may not use this service unless you are at least 16 years old.
-
You already know Dokkio is an AI-powered assistant to organize & manage your digital files & messages. Very soon, Dokkio will support Outlook as well as One Drive. Check it out today!
|
Object Properties
Page history
last edited
by nschlein@... 2 years, 2 months ago
There are two types of properties: global properties, and properties on named objects. The names of the properties are case-insensitive, but it is recommended that one use the casing shown.
Global Properties
Global properties are values that are in the game, but not actually attached to any object. To use these, do not name the object when using if_object_property or similar commands.
Property
|
Type |
Valid Values
|
Description
|
nebulaIsOpaque
|
Integer |
0 or 1
|
Probably the same as "Nebula Hides All" on the server settings for a PVP mission. Always defaults to 0 (no).
|
sensorSetting
|
Integer |
0 = unlimited (100 km)
1 = 33 km (100 / 3)
2 = 16 km (100 / 6)
3 = 11 km (100 / 9)
4 = 8 km (100 / 12)
5 = 6 km (100 / 15) etc.
|
Sensors range, with value initialized as selected in the server settings for the scripted mission. Only values 0-4 can be manually set via that screen, but mission scripts can set higher values which will follow the same progression, providing increasingly small sensor ranges, i.e., 100 / (3*sensorSetting) km.
|
gameTimeLimit
|
Integer |
|
Nominally the number of minutes, but in a scripted mission it has no effect unless the mission script uses this value to enforce it itself. Although it does not appear on the server settings for a scripted mission, the value can be configured on the server settings for a Solo or Co-op mission and will be passed to scripted missions.
|
networkTickSpeed
|
Integer |
20 to 500
|
The Network Update Speed, in milliseconds, configured on the server settings for the scripted mission.
|
nonPlayerSpeed
|
Integer |
40 to 300
|
The Enemy Speed value, in %. Although it does not appear on the server settings for a scripted mission, the value can be configured on the server settings for a Solo or Co-op mission and will be passed to scripted missions.
|
nonPlayerShield
|
Integer |
40 to 300
|
The Enemy Shields value, in %. Although it does not appear on the server settings for a scripted mission, the value can be configured on the server settings for a Solo or Co-op mission and will be passed to scripted missions.
|
nonPlayerWeapon
|
Integer |
40 to 300
|
The Enemy Weapon Power value, in %. Although it does not appear on the server settings for a scripted mission, the value can be configured on the server settings for a Solo or Co-op mission and will be passed to scripted missions.
|
playerWeapon
|
Integer |
40 to 300
|
The Player Weapon Power value, in %. Although it does not appear on the server settings for a scripted mission, the value can be configured on the server settings for a Solo or Co-op mission and will be passed to scripted missions.
|
playerShields
|
Integer |
40 to 300
|
The Player Shield Strength value, in %. Although it does not appear on the server settings for a scripted mission, the value can be configured on the server settings for a Solo or Co-op mission and will be passed to scripted missions.
|
coopAdjustmentValue
|
Integer |
|
|
musicObjectMasterVolume
|
Float |
0.0 - 1.0
|
Added in 2.5.104. The Game Music Volume value, configurable from within the simulation, where it is displayed in %.
|
commsObjectMasterVolume
|
Float |
0.0 - 1.0
|
Added in 2.5.104. The Game Comms Volume value, configurable from within the simulation, where it is displayed in %.
|
soundFXVolume
|
Float |
0.0 - 1.0
|
Added in 2.5.104. The Game Sound Volume value, configurable from within the simulation, where it is displayed in %.
|
Properties on All Named Objects
Property
|
Type |
Valid Values
|
Description
|
positionX
|
|
|
Distance from the right edge of the map to the center of the object.
|
positionY
|
|
|
|
positionZ
|
|
|
Distance from the top edge of the map to the center of the object.
|
deltaX
|
|
|
The rate of change in an object's X value
|
deltaY
|
|
|
The rate of change in an object's Y value
|
deltaZ
|
|
|
The rate of change in an object's Z value
|
angle
|
|
These 3 values will be in radians (from -Pi to Pi), NOT degrees like every other angle in the scripting parser. (2Pi radians = 360 degrees)
|
Radians clockwise from "south". (0 is south, Pi/2 is west, Pi or -Pi is north, -Pi/2 is east)
|
pitch
|
|
|
roll
|
|
|
sideValue
|
|
0 = no side, 1 = enemy (normally), 2+ = player side (normally)
|
|
isTagged |
Integer |
0 (not tagged) or 1 (tagged) |
Indicates whether the object is tagged. All named objects have this property and can be affected by scripts, but only targetable objects (i.e., not black holes, anomalies, or generic meshes) can be tagged by players. This property was added in Artemis 2.6.3. |
tagOwnerSide |
Integer |
no value if not tagged, else side value (1 or more) |
The side value that tagged the object. If tested when this object has no value (not tagged, or if a script set isTagged but did not set tagOwnerSide), the condition will be treated as true regardless of the condition, so this property should only be tested along with an isTagged = 1 condition. This property was added in Artemis 2.6.3. |
Properties on Generic Meshs
Property
|
Type |
Valid Values
|
Description
|
blocksShotFlag
|
|
|
Supposed to block torpedoes and beams if true, but reportedly does not work.
|
pushRadius
|
|
|
|
pitchDelta
|
|
|
|
rollDelta
|
|
|
|
angleDelta
|
|
|
|
artScale
|
|
|
|
Properties on Stations
Property
|
Type |
Valid Values
|
Description
|
shieldState
|
|
|
The current shield strength (e.g., 400 for most undamaged bases). This cannot be set higher than the inherent max shield strength for that station.
|
canBuild
|
Boolean |
0-1
|
If set to 1 (the default), the station can build missiles normally. If set to 0, the station can still work on building a missile and the build timer will continue to count down (even showing up as a large number of minutes when it's actually negative), but the missile will only appear once canBuild is then set back to 1.
|
canShoot |
Boolean |
0 (no) or 1 (yes) |
Added in 2.7.4. |
canLaunchFighters |
Boolean |
0 (no) or 1 (yes) |
Added in 2.7.4. |
missileStoresHoming
|
Integer |
|
|
missileStoresNuke
|
Integer |
|
|
missileStoresMine
|
Integer |
|
|
missileStoresECM
|
Integer |
|
Obsolete. This was renamed to missileStoresEMP in 2.6.3.
|
missileStoresEMP |
Integer |
|
Added in 2.6.3. |
missileStoresPShock
|
Integer |
|
|
missileStoresBeacon |
Integer |
|
Added in 2.6.3. |
missileStoresProbe |
Integer |
|
Added in 2.6.3. |
missileStoresTag |
Integer |
|
Added in 2.6.3. |
There is currently no property for the number of fighters available.
Properties on All Shielded Ships
Property
|
Type |
Valid Values
|
Description
|
throttle
|
Float |
0.0 to 1.0
|
The impulse throttle level (0.0 to 1.0 for full throttle). A player ship traveling at warp speeds also shows as 1.0.
|
steering
|
|
|
|
topSpeed
|
Float |
|
Top speed is based on the units used in the sector, where 1.0 is 100 units per second, or 1/6 of a Light Cruiser's Warp 1. By default, this matches the "topspeed" value in vesselData.xml.
|
turnRate
|
Float |
|
The maximum turn rate, in radians per cycle. (~1/50 second) By default, this matches the "turnrate" value in vesselData.xml.
|
shieldStateFront
|
Integer
|
0 - ??? (value of shieldMaxStateFront)
|
Additions will truncate to shieldMaxStateFront
|
shieldMaxStateFront
|
Integer
|
0 - ??? |
|
shieldStateBack
|
Integer
|
0 - ??? (value of shieldMaxStateBack)
|
Additions will truncate to shieldMaxStateBack
|
shieldMaxStateBack
|
Integer
|
0 - ???
|
|
shieldsOn
|
|
0-1
|
|
triggersMines
|
|
0-1
|
Works as of version 2.8; not functional in 2.7x
|
systemDamageBeam
|
|
|
Ignored for player ships.
|
systemDamageTorpedo
|
|
|
Ignored for player ships.
|
systemDamageTactical
|
|
|
Ignored for player ships.
|
systemDamageTurning
|
|
|
Ignored for player ships.
|
systemDamageImpulse
|
|
|
Ignored for player ships.
|
systemDamageWarp
|
|
|
Ignored for player ships.
|
systemDamageFrontShield
|
|
|
Ignored for player ships.
|
systemDamageBackShield
|
|
|
Ignored for player ships.
|
shieldBandStrength0
|
Float |
0.0 - 1.0
|
Strength of shield frequency A
|
shieldBandStrength1
|
Float |
0.0 - 1.0
|
Strength of shield frequency B
|
shieldBandStrength2
|
Float |
0.0 - 1.0
|
Strength of shield frequency C
|
shieldBandStrength3
|
Float |
0.0 - 1.0
|
Strength of shield frequency D
|
shieldBandStrength4
|
Float |
0.0 - 1.0
|
Strength of shield frequency E
|
Properties on Enemies
Property
|
Type |
Valid Values
|
Description
|
targetPointX
|
|
|
|
targetPointY
|
|
|
|
targetPointZ
|
|
|
|
hasSurrendered
|
|
|
|
eliteAIType
|
Integer |
0-2:
0 = behave just like a normal ship (hunt stations, unless a neutral or player is close)
1 = follow the nearest normal fleet around, attack the player when close
2 = ignore everything except players
|
Deprecated, use add_ai with the commands TARGET_THROTTLE or CHASE_PLAYER instead. This property appears to have been removed prior to v2.1.1.
|
eliteAbilityBits
|
Integer |
Sum of zero or more of the following:
1 = Stealth (invisible to main screen) 2 = LowVis (invisible to LRS/Tactical map) 4 = Cloak 8 = HET 16 = Warp 32 = Teleport 64 = Tractor 128 = Drones 256 = AntiMine 512 = AntiTorp 1024 = ShldDrain 2048 = ShldVamp
4096 = TeleBack (added in 2.7.2)
8192 = ShldReset (added in 2.7.2)
|
Deprecated, use set_special instead to modify. This property was removed in v2.4, and was renamed to specialAbilityBits.
|
specialAbilityBits |
Integer |
Sum of zero of more of special ability bits, that the ship has. This is read-only. Use set_special to modify. |
eliteAbilityState
|
Integer |
Sum of zero of more of special ability bits, that are currently active.
Deprecated. This property was removed in v2.4, and was renamed to specialAbilityState.
|
specialAbilityState |
Integer |
Sum of zero of more of special ability bits, that are currently active. This appears to be read-only. |
surrenderChance
|
|
0-100
|
|
tauntImmunityIndex
|
Integer |
0,1, or 2
|
|
Properties on Monsters
Property
|
Type |
Valid Values
|
Description
|
speed
|
|
Usually 1.0
|
Added in v2.7.2
|
health
|
|
Usually 1-1000
|
Added in v2.7.2
|
maxHealth
|
|
Usually 1-1000
|
Added in v2.7.2
|
turnRate |
|
Usually 0.0001-0.01 |
Added in v2.7.2 |
age |
|
1, 2, or 3 |
Added in v2.7.2 |
size |
|
Usually 0.5-1.5 |
Added in v2.7.2 |
Properties on Neutrals
Property
|
Type |
Valid Values
|
Description
|
exitPointX
|
|
|
|
exitPointY
|
|
|
|
exitPointZ
|
|
|
|
willAcceptCommsOrders |
Boolean |
0 or 1 |
Deprecated, use add_ai with FOLLOW_COMMS_ORDERS instead of setting this to 1. This property appears to have been removed prior to v2.1.1. |
Properties on Players
Property
|
Type |
Valid Values
|
Description
|
countHoming
|
Integer |
|
Current number of homing torpedoes
|
countNuke
|
Integer |
|
Current number of nukes
|
countMine
|
Integer |
|
Current number of mines
|
countECM
|
Integer |
|
Obsolete. This property was renamed to countEMP in 2.6.3.
|
countEMP |
Integer |
|
Current number of EMPs |
countShk |
Integer |
|
Current number of PShocks |
countBea |
Integer |
|
Current number of beacons |
countPro |
Integer |
|
Current number of probes |
countTag |
Integer |
|
Current number of tags |
currentRealSpeed
|
|
(read only)
|
|
energy
|
|
|
|
totalCoolant
|
|
|
|
warpState
|
|
0 to 4
|
Current warp speed. Jump drive ships always show as 0.
|
systemCurCoolantBeam |
|
|
Added in v2.6.3. |
systemCurCoolantTorpedo |
|
|
Added in v2.6.3. |
systemCurCoolantTactical |
|
|
Added in v2.6.3. |
systemCurCoolantTurning |
|
|
Added in v2.6.3. |
systemCurCoolantImpulse |
|
|
Added in v2.6.3. |
systemCurCoolantWarp |
|
|
Added in v2.6.3. |
systemCurCoolantFrontShield |
|
|
Added in v2.6.3. |
systemCurCoolantBackShield |
|
|
Added in v2.6.3. |
systemCurHeatBeam |
|
|
Added in v2.6.3. |
systemCurHeatTorpedo |
|
|
Added in v2.6.3. |
systemCurHeatTactical |
|
|
Added in v2.6.3. |
systemCurHeatTurning |
|
|
Added in v2.6.3. |
systemCurHeatImpulse |
|
|
Added in v2.6.3. |
systemCurHeatWarp |
|
|
Added in v2.6.3. |
systemCurHeatFrontShield |
|
|
Added in v2.6.3. |
systemCurHeatBackShield |
|
|
Added in v2.6.3. |
systemCurEnergyBeam |
Float |
0.0 to 1.0 |
Indicates the level of the "Primary Beam" slider on the Engineering console. Added in v2.6.3. |
systemCurEnergyTorpedo |
Float |
0.0 to 1.0 |
Indicates the level of the "Torpedo" slider on the Engineering console. Added in v2.6.3. |
systemCurEnergyTactical |
Float |
0.0 to 1.0 |
Indicates the level of the "Sensors" slider on the Engineering console. Added in v2.6.3. |
systemCurEnergyTurning |
Float |
0.0 to 1.0 |
Indicates the level of the "Maneuver" slider on the Engineering console. Added in v2.6.3. |
systemCurEnergyImpulse |
Float |
0.0 to 1.0 |
Indicates the level of the "Impulse" slider on the Engineering console. Added in v2.6.3. |
systemCurEnergyWarp |
Float |
0.0 to 1.0 |
Indicates the level of the "Warp"/"Jump Drive" slider on the Engineering console. Added in v2.6.3. |
systemCurEnergyFrontShield |
Float |
0.0 to 1.0 |
Indicates the level of the "Front Shld" slider on the Engineering console. Added in v2.6.3. |
systemCurEnergyBackShield |
Float |
0.0 to 1.0 |
Indicates the level of the "Rear Shld" slider on the Engineering console. Added in v2.6.3. |
pirateRepWithStations |
Integer |
|
If player ship is a pirate, 0 means stations won't listen to the player ship and >0 means they will allow the pirate ship to dock. Ignored if the player ship is not a pirate. Added in v2.7.1. |
This attribute was added in Artemis v2.6.3.
Object Properties
|
Tip: To turn text into a link, highlight the text, then click on a page or file from the list above.
|
|
|
|
|
Comments (0)
You don't have permission to comment on this page.