ScriptInstance.cpp 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047
  1. // Copyright (c) 2008-2022 the Urho3D project
  2. // License: MIT
  3. #include "../Precompiled.h"
  4. #include "../AngelScript/Script.h"
  5. #include "../AngelScript/ScriptFile.h"
  6. #include "../AngelScript/ScriptInstance.h"
  7. #include "../AngelScript/Addons.h"
  8. #include "../AngelScript/APITemplates.h"
  9. #include "../Core/Context.h"
  10. #include "../Core/Profiler.h"
  11. #include "../IO/Log.h"
  12. #include "../IO/MemoryBuffer.h"
  13. #if defined(URHO3D_PHYSICS) || defined(URHO3D_PHYSICS2D)
  14. #include "../Physics/PhysicsEvents.h"
  15. #endif
  16. #include "../Resource/ResourceCache.h"
  17. #include "../Resource/ResourceEvents.h"
  18. #include "../Scene/Scene.h"
  19. #include "../Scene/SceneEvents.h"
  20. #include <AngelScript/angelscript.h>
  21. #include "../DebugNew.h"
  22. namespace Urho3D
  23. {
  24. static const char* methodDeclarations[] = {
  25. "void Start()",
  26. "void Stop()",
  27. "void DelayedStart()",
  28. "void Update(float)",
  29. "void PostUpdate(float)",
  30. "void FixedUpdate(float)",
  31. "void FixedPostUpdate(float)",
  32. "void Load(Deserializer&)",
  33. "void Save(Serializer&)",
  34. "void ReadNetworkUpdate(Deserializer&)",
  35. "void WriteNetworkUpdate(Serializer&)",
  36. "void ApplyAttributes()",
  37. "void TransformChanged()"
  38. };
  39. void CleanupTypeInfoScriptInstance(asITypeInfo *type)
  40. {
  41. delete static_cast<Vector<AttributeInfo>*>(type->GetUserData(eAttrMapUserIdx));
  42. }
  43. template<typename Op>
  44. inline void ScriptInstance::executeScript(asIScriptFunction* method, Op func) const {
  45. Script* scriptSystem = GetSubsystem<Script>();
  46. asIScriptContext* context = scriptSystem->GetScriptFileContext();
  47. if (context->Prepare(method) < 0)
  48. return;
  49. context->SetObject(scriptObject_);
  50. func(context);
  51. scriptSystem->IncScriptNestingLevel();
  52. context->Execute();
  53. context->Unprepare();
  54. scriptSystem->DecScriptNestingLevel();
  55. }
  56. ScriptInstance::ScriptInstance(Context* context) :
  57. Component(context)
  58. {
  59. ClearScriptAttributes();
  60. }
  61. ScriptInstance::~ScriptInstance()
  62. {
  63. ReleaseObject();
  64. }
  65. void ScriptInstance::RegisterObject(Context* context)
  66. {
  67. context->RegisterFactory<ScriptInstance>(LOGIC_CATEGORY);
  68. URHO3D_ACCESSOR_ATTRIBUTE("Is Enabled", IsEnabled, SetEnabled, bool, true, AM_DEFAULT);
  69. URHO3D_MIXED_ACCESSOR_ATTRIBUTE("Delayed Method Calls", GetDelayedCallsAttr, SetDelayedCallsAttr, PODVector<unsigned char>,
  70. Variant::emptyBuffer, AM_FILE | AM_NOEDIT);
  71. URHO3D_MIXED_ACCESSOR_ATTRIBUTE("Script File", GetScriptFileAttr, SetScriptFileAttr, ResourceRef,
  72. ResourceRef(ScriptFile::GetTypeStatic()), AM_DEFAULT);
  73. URHO3D_ACCESSOR_ATTRIBUTE("Class Name", GetClassName, SetClassName, String, String::EMPTY, AM_DEFAULT);
  74. URHO3D_MIXED_ACCESSOR_ATTRIBUTE("Script Data", GetScriptDataAttr, SetScriptDataAttr, PODVector<unsigned char>, Variant::emptyBuffer,
  75. AM_FILE | AM_NOEDIT);
  76. URHO3D_MIXED_ACCESSOR_ATTRIBUTE("Script Network Data", GetScriptNetworkDataAttr, SetScriptNetworkDataAttr, PODVector<unsigned char>,
  77. Variant::emptyBuffer, AM_NET | AM_NOEDIT);
  78. }
  79. void ScriptInstance::OnSetAttribute(const AttributeInfo& attr, const Variant& src)
  80. {
  81. // Update stored script attributes if being manipulated while the actual object doesn't exist
  82. if (!scriptObject_ && storedAttributes_.Size())
  83. {
  84. HashMap<String, Variant>::Iterator i = storedAttributes_.Find(attr.name_);
  85. if (i != storedAttributes_.End())
  86. i->second_ = src;
  87. }
  88. if (attr.mode_ & (AM_NODEID | AM_COMPONENTID))
  89. {
  90. // The component / node to which the ID refers to may not be in the scene yet, and furthermore the ID must go through the
  91. // SceneResolver first. Delay searching for the object to ApplyAttributes
  92. auto* attrPtr = const_cast<AttributeInfo*>(&attr);
  93. idAttributes_[attrPtr] = src.GetUInt();
  94. }
  95. else if (attr.type_ == VAR_RESOURCEREF && attr.ptr_)
  96. {
  97. Resource*& resourcePtr = *(reinterpret_cast<Resource**>(attr.ptr_));
  98. // Decrease reference count of the old object if any, then increment the new
  99. if (resourcePtr)
  100. resourcePtr->ReleaseRef();
  101. const ResourceRef& ref = src.GetResourceRef();
  102. resourcePtr = GetSubsystem<ResourceCache>()->GetResource(ref.type_, ref.name_);
  103. if (resourcePtr)
  104. resourcePtr->AddRef();
  105. }
  106. else if (attr.type_ == VAR_VARIANTVECTOR && attr.ptr_)
  107. {
  108. auto* arr = reinterpret_cast<CScriptArray*>(attr.ptr_);
  109. if (arr)
  110. {
  111. const Vector<Variant>& vector = src.GetVariantVector();
  112. unsigned size = vector.Size();
  113. arr->Resize(size);
  114. for (unsigned i = 0; i < size; i++)
  115. *(static_cast<Variant*>(arr->At(i))) = vector[i];
  116. }
  117. }
  118. else if (attr.type_ == VAR_STRINGVECTOR && attr.ptr_)
  119. {
  120. auto* arr = reinterpret_cast<CScriptArray*>(attr.ptr_);
  121. if (arr)
  122. {
  123. const Vector<String>& vector = src.GetStringVector();
  124. unsigned size = vector.Size();
  125. arr->Resize(size);
  126. for (unsigned i = 0; i < size; i++)
  127. *(static_cast<String*>(arr->At(i))) = vector[i];
  128. }
  129. }
  130. else
  131. Serializable::OnSetAttribute(attr, src);
  132. }
  133. void ScriptInstance::OnGetAttribute(const AttributeInfo& attr, Variant& dest) const
  134. {
  135. auto* attrPtr = const_cast<AttributeInfo*>(&attr);
  136. // Get ID's for node / component handle attributes
  137. if (attr.mode_ & (AM_NODEID | AM_COMPONENTID))
  138. {
  139. // If a cached ID value has been stored, return it instead of querying from the actual object
  140. // (the object handle is likely null at that point)
  141. HashMap<AttributeInfo*, unsigned>::ConstIterator i = idAttributes_.Find(attrPtr);
  142. if (i != idAttributes_.End())
  143. dest = i->second_;
  144. else if (attr.mode_ & AM_NODEID)
  145. {
  146. Node* node = *(reinterpret_cast<Node**>(attr.ptr_));
  147. unsigned nodeID = node ? node->GetID() : 0;
  148. dest = nodeID;
  149. }
  150. else
  151. {
  152. Component* component = *(reinterpret_cast<Component**>(attr.ptr_));
  153. unsigned componentID = component ? component->GetID() : 0;
  154. dest = componentID;
  155. }
  156. }
  157. else if (attr.type_ == VAR_RESOURCEREF && attr.ptr_)
  158. {
  159. Resource* resource = *(reinterpret_cast<Resource**>(attr.ptr_));
  160. // If resource is non-null get its type and name hash. Otherwise get type from the default value
  161. dest = GetResourceRef(resource, attr.defaultValue_.GetResourceRef().type_);
  162. }
  163. else if (attr.type_ == VAR_VARIANTVECTOR && attr.ptr_)
  164. {
  165. auto* arr = reinterpret_cast<CScriptArray*>(attr.ptr_);
  166. if (arr)
  167. dest = ArrayToVector<Variant>(arr);
  168. }
  169. else if (attr.type_ == VAR_STRINGVECTOR && attr.ptr_)
  170. {
  171. auto* arr = reinterpret_cast<CScriptArray*>(attr.ptr_);
  172. if (arr)
  173. dest = ArrayToVector<String>(arr);
  174. } else
  175. Serializable::OnGetAttribute(attr, dest);
  176. }
  177. void ScriptInstance::ApplyAttributes()
  178. {
  179. // Apply node / component ID attributes now (find objects from the scene and assign to the object handles)
  180. for (HashMap<AttributeInfo*, unsigned>::Iterator i = idAttributes_.Begin(); i != idAttributes_.End(); ++i)
  181. {
  182. AttributeInfo& attr = *i->first_;
  183. if (attr.mode_ & AM_NODEID)
  184. {
  185. Node*& nodePtr = *(reinterpret_cast<Node**>(attr.ptr_));
  186. // Decrease reference count of the old object if any, then increment the new
  187. if (nodePtr)
  188. nodePtr->ReleaseRef();
  189. nodePtr = GetScene()->GetNode(i->second_);
  190. if (nodePtr)
  191. nodePtr->AddRef();
  192. }
  193. else if (attr.mode_ & AM_COMPONENTID)
  194. {
  195. Component*& componentPtr = *(reinterpret_cast<Component**>(attr.ptr_));
  196. if (componentPtr)
  197. componentPtr->ReleaseRef();
  198. componentPtr = GetScene()->GetComponent(i->second_);
  199. if (componentPtr)
  200. componentPtr->AddRef();
  201. }
  202. }
  203. idAttributes_.Clear();
  204. if (scriptObject_ && methods_[METHOD_APPLYATTRIBUTES])
  205. executeScript(methods_[METHOD_APPLYATTRIBUTES], [](asIScriptContext*) {});
  206. }
  207. void ScriptInstance::OnSetEnabled()
  208. {
  209. UpdateEventSubscription();
  210. }
  211. bool ScriptInstance::CreateObject(ScriptFile* scriptFile, const String& className)
  212. {
  213. className_ = String::EMPTY; // Do not create object during SetScriptFile()
  214. SetScriptFile(scriptFile);
  215. SetClassName(className);
  216. return scriptObject_ != nullptr;
  217. }
  218. void ScriptInstance::SetScriptFile(ScriptFile* scriptFile)
  219. {
  220. if (scriptFile == scriptFile_ && scriptObject_)
  221. return;
  222. ReleaseObject();
  223. // Unsubscribe from the reload event of previous script file (if any), then subscribe to the new
  224. if (scriptFile_)
  225. {
  226. UnsubscribeFromEvent(scriptFile_, E_RELOADSTARTED);
  227. UnsubscribeFromEvent(scriptFile_, E_RELOADFINISHED);
  228. }
  229. if (scriptFile)
  230. {
  231. SubscribeToEvent(scriptFile, E_RELOADSTARTED, URHO3D_HANDLER(ScriptInstance, HandleScriptFileReload));
  232. SubscribeToEvent(scriptFile, E_RELOADFINISHED, URHO3D_HANDLER(ScriptInstance, HandleScriptFileReloadFinished));
  233. }
  234. scriptFile_ = scriptFile;
  235. CreateObject();
  236. MarkNetworkUpdate();
  237. }
  238. void ScriptInstance::SetClassName(const String& className)
  239. {
  240. if (className == className_ && scriptObject_)
  241. return;
  242. ReleaseObject();
  243. className_ = className;
  244. CreateObject();
  245. MarkNetworkUpdate();
  246. }
  247. bool ScriptInstance::Execute(const String& declaration, const VariantVector& parameters)
  248. {
  249. if (!scriptObject_)
  250. return false;
  251. asIScriptFunction* method = scriptFile_->GetMethod(scriptObject_, declaration);
  252. if (!method)
  253. {
  254. URHO3D_LOGERROR("Method " + declaration + " not found in class " + className_);
  255. return false;
  256. }
  257. return scriptFile_->Execute(scriptObject_, method, parameters);
  258. }
  259. bool ScriptInstance::Execute(asIScriptFunction* method, const VariantVector& parameters)
  260. {
  261. if (!method || !scriptObject_)
  262. return false;
  263. return scriptFile_->Execute(scriptObject_, method, parameters);
  264. }
  265. void ScriptInstance::DelayedExecute(float delay, bool repeat, const String& declaration, const VariantVector& parameters)
  266. {
  267. if (!scriptObject_)
  268. return;
  269. DelayedCall call;
  270. call.period_ = call.delay_ = Max(delay, 0.0f);
  271. call.repeat_ = repeat;
  272. call.declaration_ = declaration;
  273. call.parameters_ = parameters;
  274. delayedCalls_.Push(call);
  275. // Make sure we are registered to the scene update event, because delayed calls are executed there
  276. if (!subscribed_)
  277. UpdateEventSubscription();
  278. }
  279. void ScriptInstance::ClearDelayedExecute(const String& declaration)
  280. {
  281. if (declaration.Empty())
  282. delayedCalls_.Clear();
  283. else
  284. {
  285. for (Vector<DelayedCall>::Iterator i = delayedCalls_.Begin(); i != delayedCalls_.End();)
  286. {
  287. if (declaration == i->declaration_)
  288. i = delayedCalls_.Erase(i);
  289. else
  290. ++i;
  291. }
  292. }
  293. }
  294. void ScriptInstance::AddEventHandler(StringHash eventType, const String& handlerName)
  295. {
  296. if (!scriptObject_)
  297. return;
  298. String declaration = "void " + handlerName + "(StringHash, VariantMap&)";
  299. asIScriptFunction* method = scriptFile_->GetMethod(scriptObject_, declaration);
  300. if (!method)
  301. {
  302. // Retry with parameterless signature
  303. method = scriptFile_->GetMethod(scriptObject_, handlerName);
  304. if (!method)
  305. {
  306. URHO3D_LOGERROR("Event handler method " + handlerName + " not found in " + scriptFile_->GetName());
  307. return;
  308. }
  309. }
  310. SubscribeToEvent(eventType, URHO3D_HANDLER_USERDATA(ScriptInstance, HandleScriptEvent, (void*)method));
  311. }
  312. void ScriptInstance::AddEventHandler(Object* sender, StringHash eventType, const String& handlerName)
  313. {
  314. if (!scriptObject_)
  315. return;
  316. if (!sender)
  317. {
  318. URHO3D_LOGERROR("Null event sender for event " + String(eventType) + ", handler " + handlerName);
  319. return;
  320. }
  321. String declaration = "void " + handlerName + "(StringHash, VariantMap&)";
  322. asIScriptFunction* method = scriptFile_->GetMethod(scriptObject_, declaration);
  323. if (!method)
  324. {
  325. // Retry with parameterless signature
  326. method = scriptFile_->GetMethod(scriptObject_, handlerName);
  327. if (!method)
  328. {
  329. URHO3D_LOGERROR("Event handler method " + handlerName + " not found in " + scriptFile_->GetName());
  330. return;
  331. }
  332. }
  333. SubscribeToEvent(sender, eventType, URHO3D_HANDLER_USERDATA(ScriptInstance, HandleScriptEvent, (void*)method));
  334. }
  335. void ScriptInstance::RemoveEventHandler(StringHash eventType)
  336. {
  337. UnsubscribeFromEvent(eventType);
  338. }
  339. void ScriptInstance::RemoveEventHandler(Object* sender, StringHash eventType)
  340. {
  341. UnsubscribeFromEvent(sender, eventType);
  342. }
  343. void ScriptInstance::RemoveEventHandlers(Object* sender)
  344. {
  345. UnsubscribeFromEvents(sender);
  346. }
  347. void ScriptInstance::RemoveEventHandlers()
  348. {
  349. UnsubscribeFromAllEventsExcept(PODVector<StringHash>(), true);
  350. }
  351. void ScriptInstance::RemoveEventHandlersExcept(const PODVector<StringHash>& exceptions)
  352. {
  353. UnsubscribeFromAllEventsExcept(exceptions, true);
  354. }
  355. bool ScriptInstance::HasEventHandler(StringHash eventType) const
  356. {
  357. return HasSubscribedToEvent(eventType);
  358. }
  359. bool ScriptInstance::HasEventHandler(Object* sender, StringHash eventType) const
  360. {
  361. return HasSubscribedToEvent(sender, eventType);
  362. }
  363. bool ScriptInstance::IsA(const String& className) const
  364. {
  365. // Early out for the easiest case where that's what we are
  366. if (className_ == className)
  367. return true;
  368. if (scriptObject_)
  369. {
  370. asITypeInfo* myType = scriptObject_->GetObjectType();
  371. asITypeInfo* searchType = myType->GetModule()->GetTypeInfoByName(className.CString());
  372. return searchType && (searchType->GetTypeId() & asTYPEID_MASK_OBJECT) != 0 &&
  373. (myType->DerivesFrom(searchType) || myType->Implements(searchType));
  374. }
  375. return false;
  376. }
  377. bool ScriptInstance::HasMethod(const String& declaration) const
  378. {
  379. if (!scriptFile_ || !scriptObject_)
  380. return false;
  381. else
  382. return scriptFile_->GetMethod(scriptObject_, declaration) != nullptr;
  383. }
  384. void ScriptInstance::SetScriptFileAttr(const ResourceRef& value)
  385. {
  386. auto* cache = GetSubsystem<ResourceCache>();
  387. SetScriptFile(cache->GetResource<ScriptFile>(value.name_));
  388. }
  389. void ScriptInstance::SetDelayedCallsAttr(const PODVector<unsigned char>& value)
  390. {
  391. MemoryBuffer buf(value);
  392. delayedCalls_.Resize(buf.ReadVLE());
  393. for (Vector<DelayedCall>::Iterator i = delayedCalls_.Begin(); i != delayedCalls_.End(); ++i)
  394. {
  395. i->period_ = buf.ReadFloat();
  396. i->delay_ = buf.ReadFloat();
  397. i->repeat_ = buf.ReadBool();
  398. i->declaration_ = buf.ReadString();
  399. i->parameters_ = buf.ReadVariantVector();
  400. }
  401. if (scriptObject_ && delayedCalls_.Size() && !subscribed_)
  402. UpdateEventSubscription();
  403. }
  404. void ScriptInstance::SetScriptDataAttr(const PODVector<unsigned char>& data)
  405. {
  406. if (scriptObject_ && methods_[METHOD_LOAD])
  407. {
  408. MemoryBuffer buf(data);
  409. executeScript(methods_[METHOD_LOAD], [&](asIScriptContext* context) {
  410. context->SetArgObject(0, &buf);
  411. });
  412. }
  413. }
  414. void ScriptInstance::SetScriptNetworkDataAttr(const PODVector<unsigned char>& data)
  415. {
  416. if (scriptObject_ && methods_[METHOD_READNETWORKUPDATE])
  417. {
  418. MemoryBuffer buf(data);
  419. executeScript(methods_[METHOD_READNETWORKUPDATE], [&](asIScriptContext* context) {
  420. context->SetArgObject(0, &buf);
  421. });
  422. }
  423. }
  424. ResourceRef ScriptInstance::GetScriptFileAttr() const
  425. {
  426. return GetResourceRef(scriptFile_, ScriptFile::GetTypeStatic());
  427. }
  428. PODVector<unsigned char> ScriptInstance::GetDelayedCallsAttr() const
  429. {
  430. VectorBuffer buf;
  431. buf.WriteVLE(delayedCalls_.Size());
  432. for (Vector<DelayedCall>::ConstIterator i = delayedCalls_.Begin(); i != delayedCalls_.End(); ++i)
  433. {
  434. buf.WriteFloat(i->period_);
  435. buf.WriteFloat(i->delay_);
  436. buf.WriteBool(i->repeat_);
  437. buf.WriteString(i->declaration_);
  438. buf.WriteVariantVector(i->parameters_);
  439. }
  440. return buf.GetBuffer();
  441. }
  442. PODVector<unsigned char> ScriptInstance::GetScriptDataAttr() const
  443. {
  444. if (!scriptObject_ || !methods_[METHOD_SAVE])
  445. return PODVector<unsigned char>();
  446. else
  447. {
  448. VectorBuffer buf;
  449. executeScript(methods_[METHOD_SAVE], [&](asIScriptContext* context) {
  450. context->SetArgObject(0, &buf);
  451. });
  452. return buf.GetBuffer();
  453. }
  454. }
  455. PODVector<unsigned char> ScriptInstance::GetScriptNetworkDataAttr() const
  456. {
  457. if (!scriptObject_ || !methods_[METHOD_WRITENETWORKUPDATE])
  458. return PODVector<unsigned char>();
  459. else
  460. {
  461. VectorBuffer buf;
  462. executeScript(methods_[METHOD_WRITENETWORKUPDATE], [&](asIScriptContext* context) {
  463. context->SetArgObject(0, &buf);
  464. });
  465. return buf.GetBuffer();
  466. }
  467. }
  468. void ScriptInstance::OnSceneSet(Scene* scene)
  469. {
  470. if (scene)
  471. UpdateEventSubscription();
  472. else
  473. {
  474. UnsubscribeFromEvent(E_SCENEUPDATE);
  475. UnsubscribeFromEvent(E_SCENEPOSTUPDATE);
  476. #if defined(URHO3D_PHYSICS) || defined(URHO3D_URHO2D)
  477. UnsubscribeFromEvent(E_PHYSICSPRESTEP);
  478. UnsubscribeFromEvent(E_PHYSICSPOSTSTEP);
  479. #endif
  480. subscribed_ = false;
  481. subscribedPostFixed_ = false;
  482. }
  483. }
  484. void ScriptInstance::OnMarkedDirty(Node* node)
  485. {
  486. // Script functions are not safe from worker threads
  487. Scene* scene = GetScene();
  488. if (scene && scene->IsThreadedUpdate())
  489. {
  490. scene->DelayedMarkedDirty(this);
  491. return;
  492. }
  493. if (scriptObject_ && methods_[METHOD_TRANSFORMCHANGED])
  494. executeScript(methods_[METHOD_TRANSFORMCHANGED], [](asIScriptContext*) {});
  495. }
  496. void ScriptInstance::CreateObject()
  497. {
  498. if (!scriptFile_ || className_.Empty())
  499. return;
  500. URHO3D_PROFILE(CreateScriptObject);
  501. scriptObject_ = scriptFile_->CreateObject(className_);
  502. if (scriptObject_)
  503. {
  504. // Map script object to script instance with userdata
  505. scriptObject_->SetUserData(this);
  506. GetScriptMethods();
  507. GetScriptAttributes();
  508. UpdateEventSubscription();
  509. if (methods_[METHOD_START])
  510. executeScript(methods_[METHOD_START], [](asIScriptContext*) {});
  511. }
  512. else
  513. URHO3D_LOGERROR("Failed to create object of class " + className_ + " from " + scriptFile_->GetName());
  514. }
  515. void ScriptInstance::ReleaseObject()
  516. {
  517. if (scriptObject_)
  518. {
  519. if (methods_[METHOD_STOP])
  520. executeScript(methods_[METHOD_STOP], [](asIScriptContext*) {});
  521. PODVector<StringHash> exceptions;
  522. exceptions.Push(E_RELOADSTARTED);
  523. exceptions.Push(E_RELOADFINISHED);
  524. UnsubscribeFromAllEventsExcept(exceptions, false);
  525. if (node_)
  526. node_->RemoveListener(this);
  527. subscribed_ = false;
  528. subscribedPostFixed_ = false;
  529. ClearScriptMethods();
  530. ClearScriptAttributes();
  531. scriptObject_->SetUserData(nullptr);
  532. scriptObject_->Release();
  533. scriptObject_ = nullptr;
  534. }
  535. }
  536. void ScriptInstance::ClearScriptMethods()
  537. {
  538. for (auto& method : methods_)
  539. method = nullptr;
  540. delayedCalls_.Clear();
  541. }
  542. void ScriptInstance::ClearScriptAttributes()
  543. {
  544. attributeInfos_ = *context_->GetAttributes(GetTypeStatic());
  545. idAttributes_.Clear();
  546. }
  547. void ScriptInstance::GetScriptMethods()
  548. {
  549. for (unsigned i = 0; i < MAX_SCRIPT_METHODS; ++i)
  550. methods_[i] = scriptFile_->GetMethod(scriptObject_, methodDeclarations[i]);
  551. }
  552. void ScriptInstance::GetScriptAttributes()
  553. {
  554. attributeInfos_ = *context_->GetAttributes(GetTypeStatic());
  555. asITypeInfo* pTypeInfo = scriptObject_->GetObjectType();
  556. Vector<AttributeInfo>* attrTemplate = reinterpret_cast<Vector<AttributeInfo>*>(pTypeInfo->GetUserData(eAttrMapUserIdx));
  557. if (!attrTemplate)
  558. {
  559. attrTemplate = new Vector<AttributeInfo>;
  560. pTypeInfo->SetUserData(attrTemplate, eAttrMapUserIdx);
  561. asIScriptEngine* engine = pTypeInfo->GetEngine();
  562. unsigned numProperties = pTypeInfo->GetPropertyCount();
  563. for (unsigned i = 0; i < numProperties; ++i)
  564. {
  565. const char* name = nullptr;
  566. int typeId = 0, offset; // AngelScript void typeid
  567. bool isPrivate = false, isProtected = false, isHandle = false, isEnum = false;
  568. pTypeInfo->GetProperty(i, &name, &typeId, &isPrivate, &isProtected, &offset);
  569. // Hide private variables or ones that begin with an underscore
  570. if (isPrivate || isProtected || name[0] == '_')
  571. continue;
  572. isHandle = typeId & asTYPEID_OBJHANDLE;
  573. String typeName = engine->GetTypeDeclaration(typeId & ~asTYPEID_OBJHANDLE);
  574. isEnum = (typeId & asTYPEID_MASK_OBJECT) == 0 && typeId > asTYPEID_DOUBLE;
  575. AttributeInfo info;
  576. if (isEnum)
  577. {
  578. info.type_ = VAR_INT;
  579. info.enumNames_ = GetSubsystem<Script>()->GetEnumValues(typeId);
  580. }
  581. else if (!isHandle)
  582. {
  583. switch (typeId)
  584. {
  585. case asTYPEID_BOOL:
  586. info.type_ = VAR_BOOL;
  587. break;
  588. case asTYPEID_INT32:
  589. case asTYPEID_UINT32:
  590. info.type_ = VAR_INT;
  591. break;
  592. case asTYPEID_FLOAT:
  593. info.type_ = VAR_FLOAT;
  594. break;
  595. case asTYPEID_DOUBLE:
  596. info.type_ = VAR_DOUBLE;
  597. break;
  598. case asTYPEID_INT64:
  599. case asTYPEID_UINT64:
  600. info.type_ = VAR_INT64;
  601. break;
  602. default:
  603. if (typeName == "Variant[]")
  604. info.type_ = VAR_VARIANTVECTOR;
  605. else if (typeName == "String[]")
  606. info.type_ = VAR_STRINGVECTOR;
  607. else
  608. info.type_ = Variant::GetTypeFromName(typeName);
  609. break;
  610. }
  611. }
  612. else
  613. {
  614. // For a handle type, check if it's an Object subclass with a registered factory
  615. StringHash typeHash(typeName);
  616. const HashMap<StringHash, SharedPtr<ObjectFactory>>& factories = context_->GetObjectFactories();
  617. HashMap<StringHash, SharedPtr<ObjectFactory>>::ConstIterator j = factories.Find(typeHash);
  618. if (j != factories.End())
  619. {
  620. // Check base class type. Node & Component are supported as ID attributes, Resource as a resource reference
  621. const TypeInfo* typeInfo = j->second_->GetTypeInfo();
  622. if (typeInfo->IsTypeOf<Node>())
  623. {
  624. info.mode_ = AM_NODEID;
  625. info.type_ = VAR_INT;
  626. }
  627. else if (typeInfo->IsTypeOf<Component>())
  628. {
  629. info.mode_ = AM_COMPONENTID;
  630. info.type_ = VAR_INT;
  631. }
  632. else if (typeInfo->IsTypeOf<Resource>())
  633. {
  634. info.type_ = VAR_RESOURCEREF;
  635. info.defaultValue_ = ResourceRef(typeHash);
  636. }
  637. }
  638. }
  639. if (info.type_ != VAR_NONE)
  640. {
  641. info.mode_ |= AM_FILE;
  642. info.name_ = name;
  643. info.ptr_ = (void*)i;
  644. attrTemplate->Push(info);
  645. }
  646. }
  647. }
  648. attributeInfos_.Reserve(attributeInfos_.Size() + attrTemplate->Size());
  649. for (unsigned i = 0; i < attrTemplate->Size(); ++i)
  650. {
  651. attributeInfos_.Push(attrTemplate->At(i));
  652. AttributeInfo& back = attributeInfos_.Back();
  653. back.ptr_ = scriptObject_->GetAddressOfProperty((size_t)back.ptr_);
  654. int t = 1;
  655. }
  656. }
  657. void ScriptInstance::StoreScriptAttributes()
  658. {
  659. if (!scriptObject_)
  660. return;
  661. storedAttributes_.Clear();
  662. for (unsigned i = 0; i < attributeInfos_.Size(); ++i)
  663. {
  664. const AttributeInfo& attr = attributeInfos_[i];
  665. if (attr.ptr_)
  666. storedAttributes_[attr.name_] = GetAttribute(i);
  667. }
  668. }
  669. void ScriptInstance::RestoreScriptAttributes()
  670. {
  671. if (!scriptObject_)
  672. return;
  673. for (unsigned i = 0; i < attributeInfos_.Size(); ++i)
  674. {
  675. const AttributeInfo& attr = attributeInfos_[i];
  676. if (attr.ptr_)
  677. {
  678. HashMap<String, Variant>::ConstIterator j = storedAttributes_.Find(attr.name_);
  679. if (j != storedAttributes_.End())
  680. SetAttribute(i, j->second_);
  681. }
  682. }
  683. // Clear after restoring once. If the attributes are no longer in use (script code has changed) they are forgotten now
  684. storedAttributes_.Clear();
  685. }
  686. void ScriptInstance::UpdateEventSubscription()
  687. {
  688. Scene* scene = GetScene();
  689. if (!scene)
  690. {
  691. URHO3D_LOGWARNING("Node is detached from scene, can not subscribe script object to update events");
  692. return;
  693. }
  694. bool enabled = scriptObject_ && IsEnabledEffective();
  695. if (enabled)
  696. {
  697. if (!subscribed_ && (methods_[METHOD_UPDATE] || methods_[METHOD_DELAYEDSTART] || delayedCalls_.Size()))
  698. {
  699. SubscribeToEvent(scene, E_SCENEUPDATE, URHO3D_HANDLER(ScriptInstance, HandleSceneUpdate));
  700. subscribed_ = true;
  701. }
  702. if (!subscribedPostFixed_)
  703. {
  704. if (methods_[METHOD_POSTUPDATE])
  705. SubscribeToEvent(scene, E_SCENEPOSTUPDATE, URHO3D_HANDLER(ScriptInstance, HandleScenePostUpdate));
  706. #if defined(URHO3D_PHYSICS) || defined(URHO3D_URHO2D)
  707. if (methods_[METHOD_FIXEDUPDATE] || methods_[METHOD_FIXEDPOSTUPDATE])
  708. {
  709. Component* world = GetFixedUpdateSource();
  710. if (world)
  711. {
  712. if (methods_[METHOD_FIXEDUPDATE])
  713. SubscribeToEvent(world, E_PHYSICSPRESTEP, URHO3D_HANDLER(ScriptInstance, HandlePhysicsPreStep));
  714. if (methods_[METHOD_FIXEDPOSTUPDATE])
  715. SubscribeToEvent(world, E_PHYSICSPOSTSTEP, URHO3D_HANDLER(ScriptInstance, HandlePhysicsPostStep));
  716. }
  717. else
  718. URHO3D_LOGERROR("No physics world, can not subscribe script object to fixed update events");
  719. }
  720. #endif
  721. subscribedPostFixed_ = true;
  722. }
  723. if (methods_[METHOD_TRANSFORMCHANGED])
  724. node_->AddListener(this);
  725. }
  726. else
  727. {
  728. if (subscribed_)
  729. {
  730. UnsubscribeFromEvent(scene, E_SCENEUPDATE);
  731. subscribed_ = false;
  732. }
  733. if (subscribedPostFixed_)
  734. {
  735. UnsubscribeFromEvent(scene, E_SCENEPOSTUPDATE);
  736. #if defined(URHO3D_PHYSICS) || defined(URHO3D_URHO2D)
  737. Component* world = GetFixedUpdateSource();
  738. if (world)
  739. {
  740. UnsubscribeFromEvent(world, E_PHYSICSPRESTEP);
  741. UnsubscribeFromEvent(world, E_PHYSICSPOSTSTEP);
  742. }
  743. #endif
  744. subscribedPostFixed_ = false;
  745. }
  746. if (methods_[METHOD_TRANSFORMCHANGED])
  747. node_->RemoveListener(this);
  748. }
  749. }
  750. void ScriptInstance::HandleSceneUpdate(StringHash eventType, VariantMap& eventData)
  751. {
  752. if (!scriptObject_)
  753. return;
  754. using namespace SceneUpdate;
  755. float timeStep = eventData[P_TIMESTEP].GetFloat();
  756. // Execute delayed calls
  757. for (unsigned i = 0; i < delayedCalls_.Size();)
  758. {
  759. DelayedCall& call = delayedCalls_[i];
  760. bool remove = false;
  761. call.delay_ -= timeStep;
  762. if (call.delay_ <= 0.0f)
  763. {
  764. if (!call.repeat_)
  765. remove = true;
  766. else
  767. call.delay_ += call.period_;
  768. Execute(call.declaration_, call.parameters_);
  769. }
  770. if (remove)
  771. delayedCalls_.Erase(i);
  772. else
  773. ++i;
  774. }
  775. // Execute delayed start before first update
  776. if (methods_[METHOD_DELAYEDSTART])
  777. {
  778. executeScript(methods_[METHOD_DELAYEDSTART], [](asIScriptContext*) {});
  779. methods_[METHOD_DELAYEDSTART] = nullptr; // Only execute once
  780. }
  781. if (methods_[METHOD_UPDATE])
  782. executeScript(methods_[METHOD_UPDATE], [&](asIScriptContext* context) {
  783. context->SetArgFloat(0, timeStep);
  784. });
  785. }
  786. void ScriptInstance::HandleScenePostUpdate(StringHash eventType, VariantMap& eventData)
  787. {
  788. if (!scriptObject_ || !methods_[METHOD_POSTUPDATE])
  789. return;
  790. using namespace ScenePostUpdate;
  791. executeScript(methods_[METHOD_POSTUPDATE], [&](asIScriptContext* context) {
  792. context->SetArgFloat(0, eventData[P_TIMESTEP].GetFloat());
  793. });
  794. }
  795. #if defined(URHO3D_PHYSICS) || defined(URHO3D_URHO2D)
  796. void ScriptInstance::HandlePhysicsPreStep(StringHash eventType, VariantMap& eventData)
  797. {
  798. if (!scriptObject_)
  799. return;
  800. // Execute delayed start before first fixed update if not called yet
  801. if (methods_[METHOD_DELAYEDSTART])
  802. {
  803. executeScript(methods_[METHOD_DELAYEDSTART], [](asIScriptContext*) {});
  804. methods_[METHOD_DELAYEDSTART] = nullptr; // Only execute once
  805. }
  806. if (methods_[METHOD_FIXEDUPDATE]) {
  807. using namespace PhysicsPreStep;
  808. executeScript(methods_[METHOD_FIXEDUPDATE], [&](asIScriptContext* context) {
  809. context->SetArgFloat(0, eventData[P_TIMESTEP].GetFloat());
  810. });
  811. }
  812. }
  813. void ScriptInstance::HandlePhysicsPostStep(StringHash eventType, VariantMap& eventData)
  814. {
  815. if (!scriptObject_ || !methods_[METHOD_FIXEDPOSTUPDATE])
  816. return;
  817. using namespace PhysicsPostStep;
  818. executeScript(methods_[METHOD_FIXEDPOSTUPDATE], [&](asIScriptContext* context) {
  819. context->SetArgFloat(0, eventData[P_TIMESTEP].GetFloat());
  820. });
  821. }
  822. #endif
  823. void ScriptInstance::HandleScriptEvent(StringHash eventType, VariantMap& eventData)
  824. {
  825. if (!IsEnabledEffective() || !scriptFile_ || !scriptObject_)
  826. return;
  827. asIScriptFunction* method = static_cast<asIScriptFunction*>(GetEventHandler()->GetUserData());
  828. if (method->GetParamCount()) {
  829. executeScript(method, [&](asIScriptContext* context) {
  830. context->SetArgObject(0, &eventType);
  831. context->SetArgObject(1, &eventData);
  832. });
  833. } else {
  834. executeScript(method, [](asIScriptContext* context) {});
  835. }
  836. }
  837. void ScriptInstance::HandleScriptFileReload(StringHash eventType, VariantMap& eventData)
  838. {
  839. StoreScriptAttributes();
  840. ReleaseObject();
  841. }
  842. void ScriptInstance::HandleScriptFileReloadFinished(StringHash eventType, VariantMap& eventData)
  843. {
  844. if (!className_.Empty())
  845. {
  846. CreateObject();
  847. RestoreScriptAttributes();
  848. }
  849. }
  850. asIScriptContext* GetActiveASContext()
  851. {
  852. return asGetActiveContext();
  853. }
  854. Context* GetScriptContext()
  855. {
  856. asIScriptContext* context = asGetActiveContext();
  857. if (context)
  858. return static_cast<Script*>(context->GetEngine()->GetUserData())->GetContext();
  859. else
  860. return nullptr;
  861. }
  862. ScriptInstance* GetScriptContextInstance()
  863. {
  864. asIScriptContext* context = asGetActiveContext();
  865. asIScriptObject* object = context ? static_cast<asIScriptObject*>(context->GetThisPointer()) : nullptr;
  866. if (object)
  867. return static_cast<ScriptInstance*>(object->GetUserData());
  868. else
  869. return nullptr;
  870. }
  871. Node* GetScriptContextNode()
  872. {
  873. ScriptInstance* instance = GetScriptContextInstance();
  874. return instance ? instance->GetNode() : nullptr;
  875. }
  876. Scene* GetScriptContextScene()
  877. {
  878. Scene* scene = nullptr;
  879. Node* node = GetScriptContextNode();
  880. if (node)
  881. scene = node->GetScene();
  882. // If null, try to get the default scene
  883. if (!scene)
  884. scene = GetScriptContext()->GetSubsystem<Script>()->GetDefaultScene();
  885. return scene;
  886. }
  887. ScriptEventListener* GetScriptContextEventListener()
  888. {
  889. // If the context has an object and that object has user data set, try and get the ScriptInstance, otherwise try and get a ScriptFile.
  890. asIScriptContext* context = asGetActiveContext();
  891. if (context)
  892. {
  893. auto* object = static_cast<asIScriptObject*>(context->GetThisPointer());
  894. if (object && object->GetUserData())
  895. return GetScriptContextInstance();
  896. else
  897. return GetScriptContextFile();
  898. }
  899. else
  900. return nullptr;
  901. }
  902. Object* GetScriptContextEventListenerObject()
  903. {
  904. return dynamic_cast<Object*>(GetScriptContextEventListener());
  905. }
  906. }