Skip to content

Commit

Permalink
Docs: Consistent use of "return this". (#22799)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Mugen87
Mugen87 authored Nov 8, 2021
1 parent ee45007 commit 7f00e65
Show file tree
Hide file tree
Showing 129 changed files with 661 additions and 672 deletions.
34 changes: 17 additions & 17 deletions docs/api/ar/animation/AnimationAction.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ <h3>[property:Boolean zeroSlopeAtStart]</h3>
<h2>الوظائف (Methods)</h2>


<h3>[method:AnimationAction crossFadeFrom]( [param:AnimationAction fadeOutAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )</h3>
<h3>[method:this crossFadeFrom]( [param:AnimationAction fadeOutAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )</h3>
<p>
يؤدي هذا الإجراء إلى تلاشي [page:.fadeIn fade in] ، مما يؤدي إلى تلاشي إجراء آخر في نفس الوقت ، خلال الفترة الزمنية المنقضية. يمكن تقييد هذه الطريقة.<br /><br />

Expand All @@ -138,20 +138,20 @@ <h3>[method:AnimationAction crossFadeFrom]( [param:AnimationAction fadeOutAction

</p>

<h3>[method:AnimationAction crossFadeTo]( [param:AnimationAction fadeInAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )</h3>
<h3>[method:this crossFadeTo]( [param:AnimationAction fadeInAction], [param:Number durationInSeconds], [param:Boolean warpBoolean] )</h3>
<p>
يؤدي هذا الإجراء إلى تلاشي [page:.fadeOut fade out] ، يتلاشى في إجراء آخر في وقت واحد ، خلال الفترة الزمنية المنقضية. يمكن تقييد هذه الطريقة ضمن سلسلة.<br /><br />
إذا كانت warpBoolean صحيحة ، فسيتم تطبيق [page:.warp warping] إضافيًا (تغييرات تدريجية في المقاييس الزمنية).<br /><br />

ملاحظة: كما هو الحال مع *fadeIn*/*fadeOut* ، يبدأ / ينتهي التلاشي بوزن 1.
</p>

<h3>[method:AnimationAction fadeIn]( [param:Number durationInSeconds] )</h3>
<h3>[method:this fadeIn]( [param:Number durationInSeconds] )</h3>
<p>
يزيد [page:.weight weight] هذا الإجراء تدريجياً من 0 إلى 1 ، خلال الفترة الزمنية المنقضية. يمكن تقييد هذه الطريقة ضمن سلسلة.
</p>

<h3>[method:AnimationAction fadeOut]( [param:Number durationInSeconds] )</h3>
<h3>[method:this fadeOut]( [param:Number durationInSeconds] )</h3>
<p>
يقلل [page:.weight weight] هذا الإجراء تدريجيًا من 1 إلى 0 ، خلال الفترة الزمنية المنقضية. يمكن تقييد هذه الطريقة ضمن سلسلة.
</p>
Expand Down Expand Up @@ -181,7 +181,7 @@ <h3>[method:Object3D getRoot]()</h3>
تُرجع الكائن الجذر الذي تم تنفيذ هذا الإجراء عليه.
</p>

<h3>[method:AnimationAction halt]( [param:Number durationInSeconds] )</h3>
<h3>[method:this halt]( [param:Number durationInSeconds] )</h3>
<p>
تعمل على إبطاء سرعة هذه الرسوم المتحركة إلى 0 من خلال إنقاص [page:.timeScale timeScale] تدريجيًا (بدءًا من قيمتها الحالية) ، خلال الفترة الزمنية المنقضية. يمكن تقييد هذه الطريقة ضمن سلسلة.
</p>
Expand All @@ -205,7 +205,7 @@ <h3>[method:Boolean isScheduled]()</h3>
ملاحظة: هذا لا يعني بالضرورة أن الرسوم المتحركة تعمل بالفعل (قارن الشروط الإضافية لـ [page:.isRunning isRunning]).
</p>

<h3>[method:AnimationAction play]()</h3>
<h3>[method:this play]()</h3>
<p>
يعلم الخالط بضرورة البدء في تنشيط الحدث (action). يمكن تقييد هذه الطريقة ضمن سلسلة. <br /><br />

Expand All @@ -214,7 +214,7 @@ <h3>[method:AnimationAction play]()</h3>
[page:.weight weight]=0, [page:.timeScale timeScale]=0) منع تشغيل الرسوم المتحركة أيضًا.
</p>

<h3>[method:AnimationAction reset]()</h3>
<h3>[method:this reset]()</h3>
<p>
يتم إعادة الحدث إلى وضع البداية. يمكن تقييد هذه الطريقة ضمن سلسلة.<br /><br />

Expand All @@ -224,12 +224,12 @@ <h3>[method:AnimationAction reset]()</h3>
هذا يعني: إذا كنت تريد كلاهما ، reset وstop ، لا تتصل بـ *reset* بل إتصل بـ *stop* بدلا من ذلك.
</p>

<h3>[method:AnimationAction setDuration]( [param:Number durationInSeconds] )</h3>
<h3>[method:this setDuration]( [param:Number durationInSeconds] )</h3>
<p>
يضبط المدة لحلقة واحدة من هذا الإجراء (بضبط [page:.timeScale timeScale] وإيقاف أي إلتفاف مجدول). يمكن تقييد هذه الطريقة ضمن سلسلة.
</p>

<h3>[method:AnimationAction setEffectiveTimeScale]( [param:Number timeScale] )</h3>
<h3>[method:this setEffectiveTimeScale]( [param:Number timeScale] )</h3>
<p>
يضبط [page:.timeScale timeScale] ويوقف أي إلتفاف مجدول. يمكن تقييد هذه الطريقة ضمن سلسلة. <br /><br />

Expand All @@ -239,7 +239,7 @@ <h3>[method:AnimationAction setEffectiveTimeScale]( [param:Number timeScale] )</
ملاحظة: *paused* لن يتم تحويله إلى *true* تلقائيًا ، إذا تم ضبط *timeScale* على 0 بهذه الطريقة.
</p>

<h3>[method:AnimationAction setEffectiveWeight]( [param:Number weight] )</h3>
<h3>[method:this setEffectiveWeight]( [param:Number weight] )</h3>
<p>
تضبط [page:.weight weight] وتوقف أي تضاؤل مجدول. يمكن تقييد هذه الطريقة ضمن سلسلة. <br /><br />

Expand All @@ -249,20 +249,20 @@ <h3>[method:AnimationAction setEffectiveWeight]( [param:Number weight] )</h3>
ملاحظة: لن يتم تحويل *enabled* إلى false تلقائيًا ، إذا تم ضبط *weight* على 0 بهذه الطريقة.
</p>

<h3>[method:AnimationAction setLoop]( [param:Number loopMode], [param:Number repetitions] )</h3>
<h3>[method:this setLoop]( [param:Number loopMode], [param:Number repetitions] )</h3>
<p>
يعين [page:.loop loop mode] وعدد [page:.repetitions repetitions]. يمكن تقييد هذه الطريقة ضمن سلسلة
</p>

<h3>[method:AnimationAction startAt]( [param:Number startTimeInSeconds] )</h3>
<h3>[method:this startAt]( [param:Number startTimeInSeconds] )</h3>
<p>
يحدد وقت البداية المتأخرة (عادةً ما يتم تمريره كـ [page:AnimationMixer.time] + deltaTimeInSeconds). يمكن تقييد هذه الطريقة ضمن سلسلة. <br /><br />

ملاحظة: ستبدأ الرسوم المتحركة فقط في الوقت المحدد ، إذا تم ربط *startAt* بـ [page:.play play] ،
أو إذا تم بالفعل تنشيط الإجراء في الخالط (عن طريق استدعاء سابق لـ. *play* ، دون إيقافه أو إعادة تعيينه في هذه الأثناء).
</p>

<h3>[method:AnimationAction stop]()</h3>
<h3>[method:this stop]()</h3>
<p>
يخبر الخالط بإلغاء تنشيط هذا الإجراء. يمكن تقييد هذه الطريقة ضمن سلسلة. <br /><br />

Expand All @@ -271,17 +271,17 @@ <h3>[method:AnimationAction stop]()</h3>
ملاحظة: يمكنك إيقاف جميع الإجراءات النشطة على نفس الخالط دفعة واحدة عبر [page:AnimationMixer.stopAllAction mixer.stopAllAction].
</p>

<h3>[method:AnimationAction stopFading]()</h3>
<h3>[method:this stopFading]()</h3>
<p>
يوقف أي [page:.fadeIn fading] مجدولًا يتم تطبيقه على هذا الحدث. يمكن تقييد هذه الطريقة ضمن سلسلة.
</p>

<h3>[method:AnimationAction stopWarping]()</h3>
<h3>[method:this stopWarping]()</h3>
<p>
يوقف أي [page:.warp warping] مجدولًا يتم تطبيقه على هذا الحدث. يمكن تقييد هذه الوظيفة ضمن سلسلة.
</p>

<h3>[method:AnimationAction syncWith]( [param:AnimationAction otherAction] )</h3>
<h3>[method:this syncWith]( [param:AnimationAction otherAction] )</h3>
<p>
يزامن هذا الإجراء مع الإجراء الآخر الذي تم تمريره. يمكن تقييد هذه الوظيفة ضمن سلسلة. <br /><br />

Expand All @@ -290,7 +290,7 @@ <h3>[method:AnimationAction syncWith]( [param:AnimationAction otherAction] )</h3
ملاحظة: لن يتم الكشف عن التغييرات المستقبلية في *time* و *timeScale* للإجراء الآخر.
</p>

<h3>[method:AnimationAction warp]( [param:Number startTimeScale], [param:Number endTimeScale], [param:Number durationInSeconds] )</h3>
<h3>[method:this warp]( [param:Number startTimeScale], [param:Number endTimeScale], [param:Number durationInSeconds] )</h3>
<p>
يغير سرعة التشغيل ، خلال الفترة الزمنية المنقضية ، عن طريق تعديل [page:.timeScale timeScale] تدريجيًا من *startTimeScale* إلى *endTimeScale*.يمكن تقييد هذه الوظيفة ضمن سلسلة.
</p>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/ar/animation/AnimationMixer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,19 +63,19 @@ <h3>[method:Object3D getRoot]()</h3>
إرجاع جذركائن الخالط.
</p>

<h3>[method:AnimationMixer stopAllAction]()</h3>
<h3>[method:this stopAllAction]()</h3>
<p>
يقوم بإلغاء تنشيط كافة الإجراءات المجدولة مسبقًا على هذا الخالط.
</p>

<h3>[method:AnimationMixer update]([param:Number deltaTimeInSeconds]) </h3>
<h3>[method:this update]([param:Number deltaTimeInSeconds]) </h3>
<p>
يعمل على تقدم وقت الخالط العالمي وتحديث الرسوم المتحركة.<br /><br />

يتم ذلك عادةً في حلقة العرض ، حيث يتم تمرير [page:Clock.getDelta clock.getDelta] مقياسًا بواسطة جهاز الخلاط [page:.timeScale timeScale]).
</p>

<h3>[method:AnimationMixer setTime]([param:Number timeInSeconds]) </h3>
<h3>[method:this setTime]([param:Number timeInSeconds]) </h3>
<p>
يضبط الخالط العام على وقت محدد ويقوم بتحديث الرسوم المتحركة وفقًا لذلك.<br /><br />

Expand Down
32 changes: 16 additions & 16 deletions docs/api/ar/audio/Audio.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,12 +101,12 @@ <h3>[property:String type]</h3>

<h2>الوظائف (Methods)</h2>

<h3>[method:Audio connect]()</h3>
<h3>[method:this connect]()</h3>
<p>
متصل بـ [page:Audio.source]. يستخدم هذا داخليًا عند التهيئة وعند ضبط / إزالة المرشحات.
</p>

<h3>[method:Audio disconnect]()</h3>
<h3>[method:this disconnect]()</h3>
<p>
قطع الاتصال من [page:Audio.source]. يستخدم هذا داخليًا عند تعيين / إزالة المرشحات.
</p>
Expand Down Expand Up @@ -141,12 +141,12 @@ <h3>[method:Float getVolume]( value )</h3>
إعادة الحجم الحالي.
</p>

<h3>[method:Audio play]( delay )</h3>
<h3>[method:this play]( delay )</h3>
<p>
إذا كانت [page:Audio.hasPlaybackControl hasPlaybackControl] تحمل قيمة *true* ، يبدأ التشغيل.
</p>

<h3>[method:Audio pause]()</h3>
<h3>[method:this pause]()</h3>
<p>
إذا كانت [page:Audio.hasPlaybackControl hasPlaybackControl] تحمل قيمة *true* ، يقوم بإقاف التشغيل.
</p>
Expand All @@ -156,67 +156,67 @@ <h3>[method:undefined onEnded]()</h3>
يتم مناداته تلقائيًا عند انتهاء التشغيل.
</p>

<h3>[method:Audio setBuffer]( audioBuffer )</h3>
<h3>[method:this setBuffer]( audioBuffer )</h3>
<p>
تقوم بإعداد [page:Audio.source source] إلى *audioBuffer* ، وتقوم بتعيين [page:Audio.sourceType sourceType] إلى 'buffer'.<br />
إذا كان [page:Audio.autoplay autoplay] ، يبدأ التشغيل أيضًا.
</p>

<h3>[method:Audio setFilter]( filter )</h3>
<h3>[method:this setFilter]( filter )</h3>
<p>
Applies a single filter node to the audio.
</p>

<h3>[method:Audio setFilters]( [param:Array value] )</h3>
<h3>[method:this setFilters]( [param:Array value] )</h3>
<p>
value - arrays of filters.<br />
Applies an array of filter nodes to the audio.
</p>

<h3>[method:Audio setLoop]( [param:Boolean value] )</h3>
<h3>[method:this setLoop]( [param:Boolean value] )</h3>
<p>
يضبط [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loop source.loop] على *value* (ما إذا كان يجب تكرار التشغيل).
</p>

<h3>[method:Audio setLoopStart]( [param:Float value] )</h3>
<h3>[method:this setLoopStart]( [param:Float value] )</h3>
<p>
يضبط [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopStart source.loopStart] على *value*.
</p>

<h3>[method:Audio setLoopEnd]( [param:Float value] )</h3>
<h3>[method:this setLoopEnd]( [param:Float value] )</h3>
<p>
يضبط [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopEnd source.loopEnd] على *value*.
</p>

<h3>[method:Audio setMediaElementSource]( mediaElement )</h3>
<h3>[method:this setMediaElementSource]( mediaElement )</h3>
<p>
يطبق الكائن المحدد من النوع [link:https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement HTMLMediaElement] كمصدر لهذا الصوت.<br />
يحدد أيضًا [page:Audio.hasPlaybackControl hasPlaybackControl] إلى false.
</p>

<h3>[method:Audio setMediaStreamSource]( mediaStream )</h3>
<h3>[method:this setMediaStreamSource]( mediaStream )</h3>
<p>
يطبق الكائن المحدد من النوع [link:https://developer.mozilla.org/en-US/docs/Web/API/MediaStream MediaStream] كمصدر لهذا الصوت.<br />
يحدد أيضًا [page:Audio.hasPlaybackControl hasPlaybackControl] إلى false.
</p>

<h3>[method:Audio setNodeSource]( audioNode )</h3>
<h3>[method:this setNodeSource]( audioNode )</h3>
<p>
يقوم بإعداد [page:Audio.source source] إلى audioBuffer ، ويقوم بتعيين [page:Audio.sourceType sourceType] على 'audioNode'.<br />
يضبط أيضًا [page:Audio.hasPlaybackControl hasPlaybackControl] إلى false.
</p>

<h3>[method:Audio setPlaybackRate]( [param:Float value] )</h3>
<h3>[method:this setPlaybackRate]( [param:Float value] )</h3>
<p>
إذا تم تمكين [page:Audio.hasPlaybackControl hasPlaybackControl] ، فيتم ضبط [page:Audio.playbackRate playbackRate] على *value*.
</p>

<h3>[method:Audio setVolume]( [param:Float value] )</h3>
<h3>[method:this setVolume]( [param:Float value] )</h3>
<p>
تضبط مستوى الصوت.
</p>

<h3>[method:Audio stop]()</h3>
<h3>[method:this stop]()</h3>
<p>
إذا تم تمكين [page:Audio.hasPlaybackControl hasPlaybackControl] ، فسيتوقف عن التشغيل.
</p>
Expand Down
4 changes: 2 additions & 2 deletions docs/api/ar/audio/AudioListener.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ <h3>[method:AudioNode getFilter]()</h3>
ترجع قيمة الخاصة بـ[page:AudioListener.filter filter].
</p>

<h3>[method:AudioListener setFilter]( [param:AudioNode value] )</h3>
<h3>[method:this setFilter]( [param:AudioNode value] )</h3>
<p>
تقوم بتعيين خاصية [page:AudioListener.filter filter] إلى *value*.
</p>
Expand All @@ -96,7 +96,7 @@ <h3>[method:Float getMasterVolume]()</h3>
إعادة *volume*.
</p>

<h3>[method:AudioListener setMasterVolume]( [param:Number value] )</h3>
<h3>[method:this setMasterVolume]( [param:Number value] )</h3>
<p>
ضبط مستوى الصوت (volume).
</p>
Expand Down
10 changes: 5 additions & 5 deletions docs/api/ar/audio/PositionalAudio.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ <h3>[method:Float getRefDistance]()</h3>
تُرجع القيمة [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/refDistance panner.refDistance].
</p>

<h3>[method:PositionalAudio setRefDistance]( [param:Float value] )</h3>
<h3>[method:this setRefDistance]( [param:Float value] )</h3>
<p>
يضبط قيمة [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/refDistance panner.refDistance].
</p>
Expand All @@ -97,7 +97,7 @@ <h3>[method:Float getRolloffFactor]()</h3>
تُرجع القيمة [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/rolloffFactor panner.rolloffFactor].
</p>

<h3>[method:PositionalAudio setRolloffFactor]( [param:Float value] )</h3>
<h3>[method:this setRolloffFactor]( [param:Float value] )</h3>
<p>
يضبط قيمة [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/rolloffFactor panner.rolloffFactor].
</p>
Expand All @@ -107,7 +107,7 @@ <h3>[method:String getDistanceModel]()</h3>
تُرجع القيمة [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/distanceModel panner.distanceModel].
</p>

<h3>[method:PositionalAudio setDistanceModel]( [param:String value] )</h3>
<h3>[method:this setDistanceModel]( [param:String value] )</h3>
<p>
يضبط قيمة [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/distanceModel panner.distanceModel].
</p>
Expand All @@ -117,12 +117,12 @@ <h3>[method:Float getMaxDistance]()</h3>
تُرجع القيمة [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/maxDistance panner.maxDistance].
</p>

<h3>[method:PositionalAudio setMaxDistance]( [param:Float value] )</h3>
<h3>[method:this setMaxDistance]( [param:Float value] )</h3>
<p>
يضبط قيمة [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/maxDistance panner.maxDistance].
</p>

<h3>[method:PositionalAudio setDirectionalCone]( [param:Float coneInnerAngle], [param:Float coneOuterAngle], [param:Float coneOuterGain] )</h3>
<h3>[method:this setDirectionalCone]( [param:Float coneInnerAngle], [param:Float coneOuterAngle], [param:Float coneOuterGain] )</h3>
<p>
يمكن استخدام هذه الطريقة لتحويل الصوت متعدد الاتجاهات إلى [link:https://developer.mozilla.org/en-US/docs/Web/API/PannerNode directional sound].
</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/ar/cameras/Camera.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ <h3>[method:Camera clone]( )</h3>
ترجع كاميرا جديدة بنفس خصائص هذه الكاميرا.
</p>

<h3>[method:Camera copy]( [param:Camera source], [param:Boolean recursive] )</h3>
<h3>[method:this copy]( [param:Camera source], [param:Boolean recursive] )</h3>
<p>
تنسخ الخصائص من الكاميرا المصدر إلى هذه الكاميرا.
</p>
Expand Down
Loading

0 comments on commit 7f00e65

Please sign in to comment.