Api session items specialeffects: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session items [[Special Effect]]s Endpoint: /api/session/items/specialeffects/
API Endpoint: /api/session/items/specialeffects/


Edit items with events described at [[Api session event editor specialeffect]].
Edit items with events described at [[Api session event editor specialeffect]].
Line 10: Line 10:
version=100:  
version=100:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/specialeffects/?version=100&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/specialeffects/?version=100&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Get Queries==
attributes:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/specialeffects/attributes/?token=API_TOKEN</syntaxhighlight>
max version:  
max version:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/specialeffects/version/?token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/specialeffects/version/?token=API_TOKEN</syntaxhighlight>
size:  
count:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/specialeffects/size/?token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/specialeffects/count/?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  
Line 38: Line 40:
!Description
!Description
|-
|-
|id
| id
|int
| int
|
|  
|-
|-
|offsetCoordinate
| offsetCoordinate
|double[]
| double[]
|
|  
|-
|-
|particleEmitterID
| particleEmitterID
|int
| int
|[[Particle Emitter]] ID  
| [[Particle Emitter]] ID  
|}
|}


Line 59: Line 61:
!Description
!Description
|-
|-
|type
| type
|String
| String
|[[#Api Model Point|Point]]
| [[Point]]
|-
|-
|coordinates
| coordinates
|double[]
| double[]
|x, y, (optional) z
| x, y, (optional) z
|}
|}


Line 76: Line 78:
!Description
!Description
|-
|-
|active
| active
|boolean
| boolean
|
|  
|-
|-
|id
| id
|int
| int
|
|  
|-
|-
|name
| name
|String
| String
|
|  
|-
|-
|particleEmitters
| particleEmitters
|ParticleEmitterCoordinatePair<nowiki>[]</nowiki>
| ParticleEmitterCoordinatePair<nowiki>[]</nowiki>
|
| [[Particle Emitter]]CoordinatePair<nowiki>[]</nowiki>
|-
|-
|point
| point
|Point
| Point
|
| [[Point]]
|-
|-
|version
| version
|int
| int
|
|  
|}
|}



Latest revision as of 07:14, 7 July 2026

API Endpoint: /api/session/items/specialeffects/

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

Default Query:

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

Example Response:

[ ]

Limit Queries

version=100:

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

Get Queries

attributes:

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

max version:

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

count:

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

Formats

HTML:

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

JSON:

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

CSV:

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

SSV:

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

SMILE:

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

ZIPJSON:

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

ZIPSMILE:

https://engine.tygron.com/api/session/items/specialeffects/?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 Point

API Model description of Point

Name Type Description
type String Point
coordinates double[] x, y, (optional) z

Api Model SpecialEffect

API Model description of SpecialEffect

Name Type Description
active boolean
id int
name String
particleEmitters ParticleEmitterCoordinatePair[] Particle EmitterCoordinatePair[]
point Point Point
version int