AdvancedSpriteComponent
اعلان
public class Strawberry.Components.AdvancedSpriteComponent
پیادهسازی پیشرفتهی جزء (Component) چهره (Sprite) که از انیمیشنهای کلیدفریمی پشتیبانی میکند.
ارثبری از: Strawberry.Core.BaseComponent
ویژگیها
Layer
لایهای را که چهره روی آن رسم میشود دریافت یا تنظیم میکند.
SpriteLayer Layer { get set }
Transform
جزء تبدیل مالک را دریافت میکند.
TransformComponent Transform { get }
Origin
مبدأ چهره را دریافت میکند. این مقدار با مبدأ جزء تبدیل مالک برابر است.
Vector2 Origin { get }
Visible
نمایش چهره را دریافت یا تنظیم میکند. مقدار پیشفرض true است.
bool Visible { get set }
Color
رنگی که چهره با آن رسم میشود را دریافت یا تنظیم میکند. مقدار پیشفرض سفید است.
Color Color { get set }
CustomPosition
Vector2? CustomPosition { get set }
DisabledViewports
فهرستی از نماها را دریافت میکند که چهره روی آنها قابل مشاهده نخواهد بود. اگر خالی باشد، روی همهی نماها دیده میشود.
List<string> DisabledViewports { get }
CurrentAnimation
انیمیشن فعلی چهره را دریافت یا تنظیم میکند.
string CurrentAnimation { get set }
ImageIndex
فریم فعلی انیمیشن در حال پخش را دریافت یا تنظیم میکند.
int ImageIndex { get set }
CurrentSprite
چهره (Sprite) فعلی انیمیشن را دریافت میکند. این مقدار با تغییر انیمیشن عوض میشود.
Sprite CurrentSprite { get }
متدها
OnBegin override
void OnBegin()
OnUpdate override
void OnUpdate()
OnRender override
void OnRender()
AddSprite
یک کلید انیمیشن به این جزء اضافه میکند.
void AddSprite(string animationKey, Sprite sprite)
پارامترها:
| نام | نوع | توضیحات |
|---|---|---|
animationKey |
System.String |
کلید انیمیشن. |
sprite |
Strawberry.Graphics.Sprite |
چهرهای که برای انیمیشن استفاده میشود. |
استثناها:
System.ArgumentException—System.ArgumentNullException—
PlayAnimation
یک انیمیشن را با کلید آن پخش میکند.
void PlayAnimation(string animationKey, bool loop = true)
پارامترها:
| نام | نوع | توضیحات |
|---|---|---|
animationKey |
System.String |
کلید انیمیشن برای پخش |
loop |
System.Boolean = true |
نشان میدهد آیا انیمیشن باید تکرار شود. مقدار پیشفرض true است. |
استثناها:
System.Collections.Generic.KeyNotFoundException— اگر انیمیشن یافت نشود
PlayAnimation
یک انیمیشن را با کلید و سرعت دادهشده پخش میکند (1 = یک چرخه کامل انیمیشن در ثانیه).
void PlayAnimation(string animationKey, float speed, bool loop = true)
پارامترها:
| نام | نوع | توضیحات |
|---|---|---|
animationKey |
System.String |
کلید انیمیشن برای پخش |
speed |
System.Single |
سرعت انیمیشن (1 = یک چرخه کامل انیمیشن در ثانیه) |
loop |
System.Boolean = true |
نشان میدهد آیا انیمیشن باید تکرار شود. مقدار پیشفرض true است. |
استثناها:
System.Collections.Generic.KeyNotFoundException— اگر انیمیشن یافت نشود
PlayAnimation
یک انیمیشن را با کلید، سرعت و اندیس تصویر شروع دادهشده پخش میکند (1 = یک چرخه کامل انیمیشن در ثانیه).
void PlayAnimation(string animationKey, float speed, int imageIndex, bool loop = true)
پارامترها:
| نام | نوع | توضیحات |
|---|---|---|
animationKey |
System.String |
کلید انیمیشن برای پخش |
speed |
System.Single |
سرعت انیمیشن (1 = یک چرخه کامل انیمیشن در ثانیه) |
imageIndex |
System.Int32 |
اندیس تصویر شروع انیمیشن |
loop |
System.Boolean = true |
نشان میدهد آیا انیمیشن باید تکرار شود. مقدار پیشفرض true است. |
استثناها:
System.Collections.Generic.KeyNotFoundException— اگر انیمیشن یافت نشود
ImageIndexOf
اندیس تصویر یک انیمیشن را با کلید آن برمیگرداند.
int ImageIndexOf(string animationKey)
پارامترها:
| نام | نوع | توضیحات |
|---|---|---|
animationKey |
System.String |
کلید انیمیشن |
خروجی: فریم فعلی انیمیشن
ImageCountOf
تعداد کل فریمهای یک انیمیشن را با کلید آن برمیگرداند.
int ImageCountOf(string animationKey)
پارامترها:
| نام | نوع | توضیحات |
|---|---|---|
animationKey |
System.String |
کلید انیمیشن |
خروجی: تعداد کل فریمهای انیمیشن
SetAnimationSpeed
سرعت پخش انیمیشن در حال پخش را تنظیم میکند (1 = یک چرخه کامل انیمیشن در ثانیه).
void SetAnimationSpeed(float speed)
پارامترها:
| نام | نوع | توضیحات |
|---|---|---|
speed |
System.Single |
سرعت پخش جدید (1 = یک چرخه کامل انیمیشن در ثانیه) |
SetLoop
تنظیم میکند که آیا انیمیشن در حال پخش باید تکرار شود یا نه.
void SetLoop(bool loop)
پارامترها:
| نام | نوع | توضیحات |
|---|---|---|
loop |
System.Boolean |