Difference between revisions of "PersonaAvatarExtended"
From Virtual World Web Wiki
(Documentation for the PersonaAvatarExtended class) |
(Documentation for the PersonaAvatarExtended class) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | *'''Inherits class: [[ | + | Represents an avatar based for a persona. It will wear the same clothes as the persona and reflect other changes to their avatar |
| + | |||
| + | *'''Inherits class: [[CreatureAvatarExtended]]''' | ||
* This is a JavaScript visible object | * This is a JavaScript visible object | ||
===Remarks <nowiki>[</nowiki>[{{fullurl:PersonaAvatarExtended Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ===Remarks <nowiki>[</nowiki>[{{fullurl:PersonaAvatarExtended Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ||
{{#ifexist:PersonaAvatarExtended Remarks|{{:PersonaAvatarExtended Remarks}}|}} | {{#ifexist:PersonaAvatarExtended Remarks|{{:PersonaAvatarExtended Remarks}}|}} | ||
| + | |||
| + | ===Properties=== | ||
| + | :{{CSharp|PersonaLayerExtended Appearance {get;} }} | ||
| + | :: | ||
| + | ::The storage persisted appearance layer shared by all avatars of the same persona as this avatar (layer identifier ''layer.persona.appearance'') | ||
| + | |||
| + | :{{CSharp|PersonaLayerExtended Overlay {get;} }} | ||
| + | :: | ||
| + | ::The overlay modification layer shared by all avatars of the same persona as this avatar (layer identifier ''layer.persona.overlay'') | ||
| + | |||
| + | :{{CSharp|PersonaLayerExtended Underlay {get;} }} | ||
| + | :: | ||
| + | ::The underlay modification layer shared by all avatars of the same persona as this avatar (layer identifier ''layer.persona.underlay'') | ||
| + | |||
| + | ===Methods=== | ||
| + | :{{CSharp|RuntimeLayerExtended CreatePreviewLayer()}} | ||
| + | :: | ||
| + | ::Creates a preview layer as a clone of avatar.Appearance, and hides avatar.Appearance | ||
| + | |||
| + | :{{CSharp|void MergePreviewLayer(RuntimeLayerExtended layer)}} | ||
| + | :: | ||
| + | ::Saves the preview layer as this persona's current appearance, removes it, and finally, shows the avatar.Appearance layer again | ||
| + | |||
| + | :{{CSharp|void RemovePreviewLayer(RuntimeLayerExtended layer)}} | ||
| + | :: | ||
| + | ::Destroys a preview layer, and shows the avatar.Appearance again as an atomic operation | ||
| + | |||
| + | :{{CSharp|void SaveAppearance(AvatarLayerExtended layer {{=}} NULL)}} | ||
| + | :: | ||
| + | ::Saves this persona's appearance from the specified layer (or writes their current appearance if you don't specify a layer, same as avatar.SaveAppearance(avatar.Appearance) ) | ||
__NOTOC____NOEDITSECTION__ | __NOTOC____NOEDITSECTION__ | ||
Latest revision as of 15:35, 20 September 2019
Represents an avatar based for a persona. It will wear the same clothes as the persona and reflect other changes to their avatar
- Inherits class: CreatureAvatarExtended
- This is a JavaScript visible object
Remarks [edit]
Properties
- PersonaLayerExtended Appearance {get;}
- The storage persisted appearance layer shared by all avatars of the same persona as this avatar (layer identifier layer.persona.appearance)
- PersonaLayerExtended Overlay {get;}
- The overlay modification layer shared by all avatars of the same persona as this avatar (layer identifier layer.persona.overlay)
- PersonaLayerExtended Underlay {get;}
- The underlay modification layer shared by all avatars of the same persona as this avatar (layer identifier layer.persona.underlay)
Methods
- RuntimeLayerExtended CreatePreviewLayer()
- Creates a preview layer as a clone of avatar.Appearance, and hides avatar.Appearance
- void MergePreviewLayer(RuntimeLayerExtended layer)
- Saves the preview layer as this persona's current appearance, removes it, and finally, shows the avatar.Appearance layer again
- void RemovePreviewLayer(RuntimeLayerExtended layer)
- Destroys a preview layer, and shows the avatar.Appearance again as an atomic operation
- void SaveAppearance(AvatarLayerExtended layer = NULL)
- Saves this persona's appearance from the specified layer (or writes their current appearance if you don't specify a layer, same as avatar.SaveAppearance(avatar.Appearance) )
