Api session items specialeffects: Difference between revisions

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


Edit items with event: [[Api session event editor specialeffect|editorspecialeffect]].
Edit items with events described at [[Api session event editor specialeffect]].


Default Query:
Default Query:
Line 30: Line 30:
ZIPSMILE:  
ZIPSMILE:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/specialeffects/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/specialeffects/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
==Api Model ParticleEmitterCoordinatePair==
API Model description of ParticleEmitterCoordinatePair
{|class=wikitable
!Name
!Type
!Description
|-
|id
|int
|
|-
|offsetCoordinate
|double[]
|
|-
|particleEmitterID
|int
|[[Particle Emitter]] ID
|}
==Api Model Point==
API Model description of Point
{|class=wikitable
!Name
!Type
!Description
|-
|type
|String
|[[#Api Model Point|Point]]
|-
|coordinates
|double[]
|x, y, (optional) z
|}
==Api Model SpecialEffect==
API Model description of SpecialEffect
{|class=wikitable
!Name
!Type
!Description
|-
|active
|boolean
|
|-
|id
|int
|
|-
|name
|String
|
|-
|particleEmitters
|ParticleEmitterCoordinatePair<nowiki>[]</nowiki>
|
|-
|point
|Point
|
|-
|version
|int
|
|}
{{article end|seealso=*[[Api Content Items]]
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor specialeffect]]
*[[Api session event editor specialeffect]]
Line 35: Line 106:


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

Latest revision as of 12:14, 29 May 2026

Api session items Special Effects 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

Show Queries

max version:

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

size:

https://engine.tygron.com/api/session/items/specialeffects/size/?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[]
point Point
version int