Api session items unitdatas: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
46,429 edits
No edit summary
No edit summary
 
(34 intermediate revisions by the same user not shown)
Line 1: Line 1:
api session items [[Unit Data]]s Endpoints.
API Endpoint: /api/session/items/unitdatas/


Manipulate items with event: [[Api session event editor unitdataoverride|editorunitdataoverride]].
Edit items with events described at [[Api session event editor unitdataoverride]].


==Limit Queries==version=100:  
Default Query:
<pre>https://engine.tygron.com/api/session/items/unitdatas/?version=100&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/unitdatas/?f=JSON&token=API_TOKEN</syntaxhighlight>
==Limit Queries==max version:  
Example Response:
<pre>https://engine.tygron.com/api/session/items/unitdatas/version/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>[ {
size:  
  "active" : false,
<pre>https://engine.tygron.com/api/session/items/unitdatas/size/?token=API_TOKEN</pre>
  "colors" : [ {
==Limit Queries==HTML:  
    "argb" : -2694430
<pre>https://engine.tygron.com/api/session/items/unitdatas/?f=HTML&token=API_TOKEN</pre>
  }, {
    "argb" : -5323066
  }, {
    "argb" : -16169168
  }, {
    "argb" : -14920883
  }, {
    "argb" : -13550753
  }, {
    "argb" : -14207929
  }, {
    "argb" : -11710124
  }, {
    "argb" : -10262421
  }, {
    "argb" : -13619665
  }, {
    "argb" : -14862524
  }, {
    "argb" : -7529953
  }, {
    "argb" : -10542299
  } ],
  "fileName" : "motorcycle",
  "id" : 0,
  "isAlpha" : false,
  "name" : "Scooter",
  "particleEmitters" : [ ],
  "proximityWarningM" : -1.0,
  "regions" : [ ],
  "type" : "CAR",
  "version" : 1
}, {
  "active" : true,
  "colors" : [ {
    "argb" : -2694430
  }, {
    "argb" : -5323066
  } ],
  "fileName" : "plezierboot",
  "id" : 1,
  "isAlpha" : false,
  "name" : "Pleasure Boat",
  "particleEmitters" : [ ],
  "proximityWarningM" : -1.0,
  "regions" : [ ],
  "type" : "SHIP",
  "version" : 3
} ]</syntaxhighlight>
==Limit Queries==
version=100:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/unitdatas/?version=100&token=API_TOKEN</syntaxhighlight>
==Get Queries==
attributes:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/unitdatas/attributes/?token=API_TOKEN</syntaxhighlight>
max version:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/unitdatas/version/?token=API_TOKEN</syntaxhighlight>
count:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/unitdatas/count/?token=API_TOKEN</syntaxhighlight>
==Formats==
HTML:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/unitdatas/?f=HTML&token=API_TOKEN</syntaxhighlight>
JSON:  
JSON:  
<pre>https://engine.tygron.com/api/session/items/unitdatas/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/unitdatas/?f=JSON&token=API_TOKEN</syntaxhighlight>
CSV:  
CSV:  
<pre>https://engine.tygron.com/api/session/items/unitdatas/?f=CSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/unitdatas/?f=CSV&token=API_TOKEN</syntaxhighlight>
SSV:  
SSV:  
<pre>https://engine.tygron.com/api/session/items/unitdatas/?f=SSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/unitdatas/?f=SSV&token=API_TOKEN</syntaxhighlight>
SMILE:  
SMILE:  
<pre>https://engine.tygron.com/api/session/items/unitdatas/?f=SMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/unitdatas/?f=SMILE&token=API_TOKEN</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<pre>https://engine.tygron.com/api/session/items/unitdatas/?f=ZIPJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/unitdatas/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<pre>https://engine.tygron.com/api/session/items/unitdatas/?f=ZIPSMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/unitdatas/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
{{article end|seealso=*[[Api Content Items]]}}
==Api Model ParticleEmitterCoordinatePair==
API Model description of ParticleEmitterCoordinatePair
 
{|class=wikitable
!Name
!Type
!Description
|-
| id
| int
|
|-
| offsetCoordinate
| double[]
|
|-
| particleEmitterID
| int
| [[Particle Emitter]] ID
|}
 
==Api Model Region==
API Enumeration description of Region
 
{|class=wikitable
!Name
!Description
|-
| NORTH_AMERICA
|
|-
| NORTHWESTERN_EUROPE
|
|-
| ASIA
|
|-
| AFRICA
|
|-
| OTHER
|
|}
 
==Api Model TColor==
API Model description of TColor
 
{|class=wikitable
!Name
!Type
!Description
|}
 
==Api Model TrafficType==
API Enumeration description of TrafficType
 
{|class=wikitable
!Name
!Description
|-
| CAR
|
|-
| VAN
|
|-
| TRUCK
|
|-
| BUS
|
|-
| BICYCLE
|
|-
| PEDESTRIAN
|
|-
| SHIP
|
|-
| TRAM
|
|-
| TRAIN
|
|-
| AIR
|
|}
 
==Api Model UnitData==
API Model description of UnitData
 
{|class=wikitable
!Name
!Type
!Description
|-
| active
| boolean
|
|-
| colors
| TColor<nowiki>[]</nowiki>
| [[Color]]<nowiki>[]</nowiki>
|-
| fileName
| String
|
|-
| id
| int
|
|-
| isAlpha
| boolean
|
|-
| name
| String
|
|-
| particleEmitters
| ParticleEmitterCoordinatePair<nowiki>[]</nowiki>
| [[Particle Emitter]]CoordinatePair<nowiki>[]</nowiki>
|-
| proximityWarningM
| double
|
|-
| regions
| Region<nowiki>[]</nowiki>
|
|-
| type
| TrafficType
|
|-
| version
| int
|
|}
 
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor unitdataoverride]]
}}


[[Category:API]]
[[Category:API]]
[[Category:Items]]

Latest revision as of 07:06, 14 July 2026

API Endpoint: /api/session/items/unitdatas/

Edit items with events described at Api session event editor unitdataoverride.

Default Query: 

https://engine.tygron.com/api/session/items/unitdatas/?f=JSON&token=API_TOKEN

Example Response: 

[ {
  "active" : false,
  "colors" : [ {
    "argb" : -2694430
  }, {
    "argb" : -5323066
  }, {
    "argb" : -16169168
  }, {
    "argb" : -14920883
  }, {
    "argb" : -13550753
  }, {
    "argb" : -14207929
  }, {
    "argb" : -11710124
  }, {
    "argb" : -10262421
  }, {
    "argb" : -13619665
  }, {
    "argb" : -14862524
  }, {
    "argb" : -7529953
  }, {
    "argb" : -10542299
  } ],
  "fileName" : "motorcycle",
  "id" : 0,
  "isAlpha" : false,
  "name" : "Scooter",
  "particleEmitters" : [ ],
  "proximityWarningM" : -1.0,
  "regions" : [ ],
  "type" : "CAR",
  "version" : 1
}, {
  "active" : true,
  "colors" : [ {
    "argb" : -2694430
  }, {
    "argb" : -5323066
  } ],
  "fileName" : "plezierboot",
  "id" : 1,
  "isAlpha" : false,
  "name" : "Pleasure Boat",
  "particleEmitters" : [ ],
  "proximityWarningM" : -1.0,
  "regions" : [ ],
  "type" : "SHIP",
  "version" : 3
} ]

Limit Queries

version=100: 

https://engine.tygron.com/api/session/items/unitdatas/?version=100&token=API_TOKEN

Get Queries

attributes: 

https://engine.tygron.com/api/session/items/unitdatas/attributes/?token=API_TOKEN

max version: 

https://engine.tygron.com/api/session/items/unitdatas/version/?token=API_TOKEN

count: 

https://engine.tygron.com/api/session/items/unitdatas/count/?token=API_TOKEN

Formats

HTML: 

https://engine.tygron.com/api/session/items/unitdatas/?f=HTML&token=API_TOKEN

JSON: 

https://engine.tygron.com/api/session/items/unitdatas/?f=JSON&token=API_TOKEN

CSV: 

https://engine.tygron.com/api/session/items/unitdatas/?f=CSV&token=API_TOKEN

SSV: 

https://engine.tygron.com/api/session/items/unitdatas/?f=SSV&token=API_TOKEN

SMILE: 

https://engine.tygron.com/api/session/items/unitdatas/?f=SMILE&token=API_TOKEN

ZIPJSON: 

https://engine.tygron.com/api/session/items/unitdatas/?f=ZIPJSON&token=API_TOKEN

ZIPSMILE: 

https://engine.tygron.com/api/session/items/unitdatas/?f=ZIPSMILE&token=API_TOKEN

Api Model ParticleEmitterCoordinatePair

API Model description of ParticleEmitterCoordinatePair

Name Type Description
id int
offsetCoordinate double[]
particleEmitterID int Particle Emitter ID

Api Model Region

API Enumeration description of Region

Name Description
NORTH_AMERICA
NORTHWESTERN_EUROPE
ASIA
AFRICA
OTHER

Api Model TColor

API Model description of TColor

Name Type Description

Api Model TrafficType

API Enumeration description of TrafficType

Name Description
CAR
VAN
TRUCK
BUS
BICYCLE
PEDESTRIAN
SHIP
TRAM
TRAIN
AIR

Api Model UnitData

API Model description of UnitData

Name Type Description
active boolean
colors TColor[] Color[]
fileName String
id int
isAlpha boolean
name String
particleEmitters ParticleEmitterCoordinatePair[] Particle EmitterCoordinatePair[]
proximityWarningM double
regions Region[]
type TrafficType
version int

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_items_unitdatas&oldid=91295"