RCOXML Animations: Difference between revisions

From PS3 Developer wiki
Jump to navigation Jump to search
Line 38: Line 38:


{| class="wikitable"
{| class="wikitable"
|+specific attributes for Page
|-
! colspan="5" | Attribute !! rowspan="2" | How it works  
! colspan="5" | Attribute !! rowspan="2" | How it works  
|-
|-
Line 57: Line 57:


==Recolour==
==Recolour==
{{Boxinfo3|content='''Console support''': {{icon content psp|50px}} {{icon content ps3|50px}}<br />'''Standard attributes''': Yes<br />'''Specific attributes''': Yes}}
{| class="wikitable"
|-
! colspan="5" | Attribute !! rowspan="2" | How it works
|-
! Name !! Type !! {{icon content psp|50px}} !! {{icon content ps3|50px}} !! Examples
|-
| red || float || {{yes}} || {{yes}} ||  || updates the value of attribute '''ColorScaleR''' from the animated [[RCOXML Objects|object]]
|-
| green || float || {{yes}} || {{yes}} ||  || updates the value of attribute '''ColorScaleG''' from the animated [[RCOXML Objects|object]]
|-
| blue || float || {{yes}} || {{yes}} ||  || updates the value of attribute '''ColorScaleB''' from the animated [[RCOXML Objects|object]]
|-
| alpha || float || {{yes}} || {{yes}} ||  || updates the value of attribute '''ColorScaleA''' from the animated [[RCOXML Objects|object]]
|}
==Rotate==
==Rotate==
{{Boxinfo3|content='''Console support''': {{icon content psp|50px}} {{icon content ps3|50px}}<br />'''Standard attributes''': Yes<br />'''Specific attributes''': Yes}}
{| class="wikitable"
|-
! colspan="5" | Attribute !! rowspan="2" | How it works
|-
! Name !! Type !! {{icon content psp|50px}} !! {{icon content ps3|50px}} !! Examples
|-
| x || float || {{yes}} || {{yes}} ||  ||
|-
| y || float || {{yes}} || {{yes}} ||  ||
|-
| z || float || {{yes}} || {{yes}} ||  ||
|}
==Resize==
==Resize==
{{Boxinfo3|content='''Console support''': {{icon content psp|50px}} {{icon content ps3|50px}}<br />'''Standard attributes''': Yes<br />'''Specific attributes''': Yes}}
{| class="wikitable"
|-
! colspan="5" | Attribute !! rowspan="2" | How it works
|-
! Name !! Type !! {{icon content psp|50px}} !! {{icon content ps3|50px}} !! Examples
|-
| width || float || {{yes}} || {{yes}} ||  || updates the value of attribute '''SizeX''' from the animated [[RCOXML Objects|object]]
|-
| height  || float || {{yes}} || {{yes}} ||  || updates the value of attribute '''SizeY''' from the animated [[RCOXML Objects|object]]
|-
| depth || float || {{yes}} || {{yes}} ||  || updates the value of attribute '''SizeZ''' from the animated [[RCOXML Objects|object]]
|}
==Fade==
==Fade==
{{Boxinfo3|content='''Console support''': {{icon content psp|50px}} {{icon content ps3|50px}}<br />'''Standard attributes''': Yes<br />'''Specific attributes''': Yes}}
{| class="wikitable"
|-
! colspan="5" | Attribute !! rowspan="2" | How it works
|-
! Name !! Type !! {{icon content psp|50px}} !! {{icon content ps3|50px}} !! Examples
|-
| transparency || float || {{yes}} || {{yes}} ||  || updates the value of attribute '''ColorScaleA''' from the animated [[RCOXML Objects|object]]
|}
==Delay==
==Delay==
{{Boxinfo3|content='''Console support''': {{icon content psp|50px}} {{icon content ps3|50px}}<br />'''Standard attributes''': No<br />'''Specific attributes''': Yes}}
{| class="wikitable"
|-
! colspan="5" | Attribute !! rowspan="2" | How it works
|-
! Name !! Type !! {{icon content psp|50px}} !! {{icon content ps3|50px}} !! Examples
|-
| time || float || {{yes}} || {{yes}} ||  ||
|}
==FireEvent==
==FireEvent==
{{Boxinfo3|content='''Console support''': {{icon content psp|50px}} {{icon content ps3|50px}}<br />'''Standard attributes''': No<br />'''Specific attributes''': Yes}}
Triggers (or "fires") an event, there are different types of events (see [[RCOXML Structure]]). The most used inside animations are "native events" and "animation events" itself
Triggers (or "fires") an event, there are different types of events (see [[RCOXML Structure]]). The most used inside animations are "native events" and "animation events" itself


By triggering an animation event from inside an animation... both animations are played consecutivelly. Also is posible to reload the animation by triggering itself to create an infinite animation loop
By triggering an animation event from inside an animation... both animations are played consecutivelly. Also is posible to reload the animation by triggering itself to create an infinite animation loop
{| class="wikitable"
|-
! colspan="5" | Attribute !! rowspan="2" | How it works
|-
! Name !! Type !! {{icon content psp|50px}} !! {{icon content ps3|50px}} !! Examples
|-
| event || ref || {{yes}} || {{yes}} ||  ||
|}


==Lock==
==Lock==
{{Boxinfo3|content='''Console support''': {{icon content psp|50px}} {{icon content ps3|50px}}<br />'''Standard attributes''': No<br />'''Specific attributes''': Yes}}
Disables [[XMB]]. Note in [[Talk:Custom_render_plugin]] how '''anim_coldboot''', '''anim_coldboot2''', '''anim_gameboot''', and '''anim_otherboot''' animations starts by locking the XMB to dont interfere
Disables [[XMB]]. Note in [[Talk:Custom_render_plugin]] how '''anim_coldboot''', '''anim_coldboot2''', '''anim_gameboot''', and '''anim_otherboot''' animations starts by locking the XMB to dont interfere


*In latest firmwares (where is used coldboot.raf animation) if XMB is not locked + having a dynamic theme applyed the PS3 crashes. Is because inside dynamic themes the background is a .raf animation. Is not posible to play 2 .raf animations together overlapped (from coldboot.raf and from inside a dynamic theme)
*In latest firmwares (where is used coldboot.raf animation) if XMB is not locked + having a dynamic theme applyed the PS3 crashes. Is because inside dynamic themes the background is a .raf animation. Is not posible to play 2 .raf animations together overlapped (from coldboot.raf and from inside a dynamic theme)
{| class="wikitable"
|-
! colspan="5" | Attribute !! rowspan="2" | How it works
|-
! Name !! Type !! {{icon content psp|50px}} !! {{icon content ps3|50px}} !! Examples
|-
| unknownInt0 || int || {{yes}} || {{yes}} ||  ||
|}


==Unlock==
==Unlock==
{{Boxinfo3|content='''Console support''': {{icon content psp|50px}} {{icon content ps3|50px}}<br />'''Standard attributes''': No<br />'''Specific attributes''': Yes}}
Enables [[XMB]]. Note in [[Talk:Custom_render_plugin]] how '''anim_gameboot''', and '''anim_otherboot''' animations doesnt unlocks XMB at the ending because when the animation is completed a game/app boots (doesnt returns to XMB)
Enables [[XMB]]. Note in [[Talk:Custom_render_plugin]] how '''anim_gameboot''', and '''anim_otherboot''' animations doesnt unlocks XMB at the ending because when the animation is completed a game/app boots (doesnt returns to XMB)
{| class="wikitable"
|-
! colspan="5" | Attribute !! rowspan="2" | How it works
|-
! Name !! Type !! {{icon content psp|50px}} !! {{icon content ps3|50px}} !! Examples
|-
| unknownInt0 || int || {{yes}} || {{yes}} ||  ||
|}
==SlideOut==
==SlideOut==
{{Boxinfo3|content='''Console support''': {{icon content psp|50px}} {{icon content ps3|50px}}<br />'''Standard attributes''': Yes<br />'''Specific attributes''': Yes}}
{| class="wikitable"
|-
! colspan="5" | Attribute !! rowspan="2" | How it works
|-
! Name !! Type !! {{icon content psp|50px}} !! {{icon content ps3|50px}} !! Examples
|-
| xspeed || float || {{yes}} || {{yes}} ||  ||
|-
| yspeed || float || {{yes}} || {{yes}} ||  ||
|-
| xcompress || float || {{yes}} || {{yes}} ||  ||
|-
| ycompress || float || {{yes}} || {{yes}} ||  ||
|}
[http://ctfs.wiki.fc2.com/wiki/SlideOut%E3%81%AE%E4%BD%BF%E7%94%A8%E4%BE%8B example]
[http://ctfs.wiki.fc2.com/wiki/SlideOut%E3%81%AE%E4%BD%BF%E7%94%A8%E4%BE%8B example]



Revision as of 06:20, 30 August 2016

Description

RCOXML animations are defined in the XML code embedded inside .rco files. See Resource Container (RCO) and RCOXML Structure

General concepts

Measure units and conversions

Measure units used in RCOXML code
  • XYZ Position, in pixels
  • RGBA Color Scale in percentage in a scale from 0 up to 1, where 1 represents the max value posible of 255 (decimal value divided by 255 to get into this scale)
  • XYZ Size, in pixels, negative numbers mirrors the image
  • XYZ Size Scale, in percentage in a scale from 0 up to 1, negative numbers mirrors the image
  • Time, in miliseconds, where 1000 is one second
  • XYZ Angle, in radians with right-handed rule coordinates, where radians=(π*degrees)/180, and degrees=(180*radians)/π, as example for one turn of 360º degrees: radians=(3.141*360)/180=6.283 ...so... 360º degrees = 6.283 radians

Event types

Template:Event types used in RCOXML code

Standard attributes

  • For a better understanding is posible to difference two groups of attributes based in how are used by the animations
    • Standard attributes are used by all the animations except the Delay, FireEvent, Lock, and Unlock
    • Specific attributes are only used by a specific animation
standard attributes for RCOXML animations
Attribute How it works
Name Type PSP icon PS3 icon Examples
object ref Yes Yes PS3 icon object:ps3logo links the animation to an object
duration float Yes Yes 0
accelMode int Yes Yes 0x0

Animations

MoveTo

Info
Console support: PSP icon PS3 icon
Standard attributes: Yes
Specific attributes: Yes
Attribute How it works
Name Type PSP icon PS3 icon Examples
x float Yes Yes updates the value of attribute PositionX from the animated object
y float Yes Yes updates the value of attribute PositionY from the animated object
z float Yes Yes updates the value of attribute PositionZ from the animated object
unknownInt5 int No Yes either updates SizeX, or is an override ?
unknownInt6 int No Yes either updates SizeY, or is an override ?
unknown7 unk No Yes either updates SizeZ, or is an override ?

Recolour

Info
Console support: PSP icon PS3 icon
Standard attributes: Yes
Specific attributes: Yes
Attribute How it works
Name Type PSP icon PS3 icon Examples
red float Yes Yes updates the value of attribute ColorScaleR from the animated object
green float Yes Yes updates the value of attribute ColorScaleG from the animated object
blue float Yes Yes updates the value of attribute ColorScaleB from the animated object
alpha float Yes Yes updates the value of attribute ColorScaleA from the animated object

Rotate

Info
Console support: PSP icon PS3 icon
Standard attributes: Yes
Specific attributes: Yes
Attribute How it works
Name Type PSP icon PS3 icon Examples
x float Yes Yes
y float Yes Yes
z float Yes Yes

Resize

Info
Console support: PSP icon PS3 icon
Standard attributes: Yes
Specific attributes: Yes
Attribute How it works
Name Type PSP icon PS3 icon Examples
width float Yes Yes updates the value of attribute SizeX from the animated object
height float Yes Yes updates the value of attribute SizeY from the animated object
depth float Yes Yes updates the value of attribute SizeZ from the animated object

Fade

Info
Console support: PSP icon PS3 icon
Standard attributes: Yes
Specific attributes: Yes
Attribute How it works
Name Type PSP icon PS3 icon Examples
transparency float Yes Yes updates the value of attribute ColorScaleA from the animated object

Delay

Info
Console support: PSP icon PS3 icon
Standard attributes: No
Specific attributes: Yes
Attribute How it works
Name Type PSP icon PS3 icon Examples
time float Yes Yes

FireEvent

Info
Console support: PSP icon PS3 icon
Standard attributes: No
Specific attributes: Yes

Triggers (or "fires") an event, there are different types of events (see RCOXML Structure). The most used inside animations are "native events" and "animation events" itself

By triggering an animation event from inside an animation... both animations are played consecutivelly. Also is posible to reload the animation by triggering itself to create an infinite animation loop

Attribute How it works
Name Type PSP icon PS3 icon Examples
event ref Yes Yes

Lock

Info
Console support: PSP icon PS3 icon
Standard attributes: No
Specific attributes: Yes

Disables XMB. Note in Talk:Custom_render_plugin how anim_coldboot, anim_coldboot2, anim_gameboot, and anim_otherboot animations starts by locking the XMB to dont interfere

  • In latest firmwares (where is used coldboot.raf animation) if XMB is not locked + having a dynamic theme applyed the PS3 crashes. Is because inside dynamic themes the background is a .raf animation. Is not posible to play 2 .raf animations together overlapped (from coldboot.raf and from inside a dynamic theme)
Attribute How it works
Name Type PSP icon PS3 icon Examples
unknownInt0 int Yes Yes

Unlock

Info
Console support: PSP icon PS3 icon
Standard attributes: No
Specific attributes: Yes

Enables XMB. Note in Talk:Custom_render_plugin how anim_gameboot, and anim_otherboot animations doesnt unlocks XMB at the ending because when the animation is completed a game/app boots (doesnt returns to XMB)

Attribute How it works
Name Type PSP icon PS3 icon Examples
unknownInt0 int Yes Yes

SlideOut

Info
Console support: PSP icon PS3 icon
Standard attributes: Yes
Specific attributes: Yes
Attribute How it works
Name Type PSP icon PS3 icon Examples
xspeed float Yes Yes
yspeed float Yes Yes
xcompress float Yes Yes
ycompress float Yes Yes

example

Animation examples

Gameboot Animation

In gamelib_plugin.rco

Code Sample

In custom_render_plugin.rco

Code Sample