ScriptInstance.cpp 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851
  1. //
  2. // Copyright (c) 2008-2014 the Urho3D project.
  3. //
  4. // Permission is hereby granted, free of charge, to any person obtaining a copy
  5. // of this software and associated documentation files (the "Software"), to deal
  6. // in the Software without restriction, including without limitation the rights
  7. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  8. // copies of the Software, and to permit persons to whom the Software is
  9. // furnished to do so, subject to the following conditions:
  10. //
  11. // The above copyright notice and this permission notice shall be included in
  12. // all copies or substantial portions of the Software.
  13. //
  14. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20. // THE SOFTWARE.
  21. //
  22. #include "Precompiled.h"
  23. #include "Context.h"
  24. #include "Log.h"
  25. #include "MemoryBuffer.h"
  26. #include "PhysicsEvents.h"
  27. #include "PhysicsWorld.h"
  28. #include "Profiler.h"
  29. #include "ResourceCache.h"
  30. #include "ResourceEvents.h"
  31. #include "Scene.h"
  32. #include "SceneEvents.h"
  33. #include "Script.h"
  34. #include "ScriptFile.h"
  35. #include "ScriptInstance.h"
  36. #include <angelscript.h>
  37. #include "DebugNew.h"
  38. namespace Urho3D
  39. {
  40. static const char* methodDeclarations[] = {
  41. "void Start()",
  42. "void Stop()",
  43. "void DelayedStart()",
  44. "void Update(float)",
  45. "void PostUpdate(float)",
  46. "void FixedUpdate(float)",
  47. "void FixedPostUpdate(float)",
  48. "void Load(Deserializer&)",
  49. "void Save(Serializer&)",
  50. "void ReadNetworkUpdate(Deserializer&)",
  51. "void WriteNetworkUpdate(Serializer&)",
  52. "void ApplyAttributes()",
  53. "void TransformChanged()"
  54. };
  55. ScriptInstance::ScriptInstance(Context* context) :
  56. Component(context),
  57. script_(GetSubsystem<Script>()),
  58. scriptObject_(0),
  59. subscribed_(false),
  60. subscribedPostFixed_(false)
  61. {
  62. ClearScriptMethods();
  63. ClearScriptAttributes();
  64. }
  65. ScriptInstance::~ScriptInstance()
  66. {
  67. ReleaseObject();
  68. }
  69. void ScriptInstance::RegisterObject(Context* context)
  70. {
  71. context->RegisterFactory<ScriptInstance>(LOGIC_CATEGORY);
  72. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_BOOL, "Is Enabled", IsEnabled, SetEnabled, bool, true, AM_DEFAULT);
  73. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_BUFFER, "Delayed Method Calls", GetDelayedCallsAttr, SetDelayedCallsAttr, PODVector<unsigned char>, Variant::emptyBuffer, AM_FILE | AM_NOEDIT);
  74. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_RESOURCEREF, "Script File", GetScriptFileAttr, SetScriptFileAttr, ResourceRef, ResourceRef(ScriptFile::GetTypeStatic()), AM_DEFAULT);
  75. REF_ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_STRING, "Class Name", GetClassName, SetClassName, String, String::EMPTY, AM_DEFAULT);
  76. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_BUFFER, "Script Data", GetScriptDataAttr, SetScriptDataAttr, PODVector<unsigned char>, Variant::emptyBuffer, AM_FILE | AM_NOEDIT);
  77. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_BUFFER, "Script Network Data", GetScriptNetworkDataAttr, SetScriptNetworkDataAttr, PODVector<unsigned char>, Variant::emptyBuffer, AM_NET | AM_NOEDIT);
  78. }
  79. void ScriptInstance::OnSetAttribute(const AttributeInfo& attr, const Variant& src)
  80. {
  81. if (attr.mode_ & (AM_NODEID | AM_COMPONENTID))
  82. {
  83. // The component / node to which the ID refers to may not be in the scene yet, and furthermore the ID must go through the
  84. // SceneResolver first. Delay searching for the object to ApplyAttributes
  85. AttributeInfo* attrPtr = const_cast<AttributeInfo*>(&attr);
  86. idAttributes_[attrPtr] = src.GetUInt();
  87. }
  88. else if (attr.type_ == VAR_RESOURCEREF && attr.ptr_)
  89. {
  90. Resource*& resourcePtr = *(reinterpret_cast<Resource**>(attr.ptr_));
  91. // Decrease reference count of the old object if any, then increment the new
  92. if (resourcePtr)
  93. resourcePtr->ReleaseRef();
  94. const ResourceRef& ref = src.GetResourceRef();
  95. resourcePtr = GetSubsystem<ResourceCache>()->GetResource(ref.type_, ref.name_);
  96. if (resourcePtr)
  97. resourcePtr->AddRef();
  98. }
  99. else
  100. Serializable::OnSetAttribute(attr, src);
  101. }
  102. void ScriptInstance::OnGetAttribute(const AttributeInfo& attr, Variant& dest) const
  103. {
  104. AttributeInfo* attrPtr = const_cast<AttributeInfo*>(&attr);
  105. // Get ID's for node / component handle attributes
  106. if (attr.mode_ & (AM_NODEID | AM_COMPONENTID))
  107. {
  108. // If a cached ID value has been stored, return it instead of querying from the actual object
  109. // (the object handle is likely null at that point)
  110. HashMap<AttributeInfo*, unsigned>::ConstIterator i = idAttributes_.Find(attrPtr);
  111. if (i != idAttributes_.End())
  112. dest = i->second_;
  113. else if (attr.mode_ & AM_NODEID)
  114. {
  115. Node* node = *(reinterpret_cast<Node**>(attr.ptr_));
  116. unsigned nodeID = node ? node->GetID() : 0;
  117. dest = nodeID;
  118. }
  119. else
  120. {
  121. Component* component = *(reinterpret_cast<Component**>(attr.ptr_));
  122. unsigned componentID = component ? component->GetID() : 0;
  123. dest = componentID;
  124. }
  125. }
  126. else if (attr.type_ == VAR_RESOURCEREF && attr.ptr_)
  127. {
  128. Resource* resource = *(reinterpret_cast<Resource**>(attr.ptr_));
  129. // If resource is non-null get its type and name hash. Otherwise get type from the default value
  130. dest = GetResourceRef(resource, attr.defaultValue_.GetResourceRef().type_);
  131. }
  132. else
  133. Serializable::OnGetAttribute(attr, dest);
  134. }
  135. void ScriptInstance::ApplyAttributes()
  136. {
  137. // Apply node / component ID attributes now (find objects from the scene and assign to the object handles)
  138. for (HashMap<AttributeInfo*, unsigned>::Iterator i = idAttributes_.Begin(); i != idAttributes_.End(); ++i)
  139. {
  140. AttributeInfo& attr = *i->first_;
  141. if (attr.mode_ & AM_NODEID)
  142. {
  143. Node*& nodePtr = *(reinterpret_cast<Node**>(attr.ptr_));
  144. // Decrease reference count of the old object if any, then increment the new
  145. if (nodePtr)
  146. nodePtr->ReleaseRef();
  147. nodePtr = GetScene()->GetNode(i->second_);
  148. if (nodePtr)
  149. nodePtr->AddRef();
  150. }
  151. else if (attr.mode_ & AM_COMPONENTID)
  152. {
  153. Component*& componentPtr = *(reinterpret_cast<Component**>(attr.ptr_));
  154. if (componentPtr)
  155. componentPtr->ReleaseRef();
  156. componentPtr = GetScene()->GetComponent(i->second_);
  157. if (componentPtr)
  158. componentPtr->AddRef();
  159. }
  160. }
  161. idAttributes_.Clear();
  162. if (scriptObject_ && methods_[METHOD_APPLYATTRIBUTES])
  163. scriptFile_->Execute(scriptObject_, methods_[METHOD_APPLYATTRIBUTES]);
  164. }
  165. void ScriptInstance::OnSetEnabled()
  166. {
  167. UpdateEventSubscription();
  168. }
  169. bool ScriptInstance::CreateObject(ScriptFile* scriptFile, const String& className)
  170. {
  171. className_ = String::EMPTY; // Do not create object during SetScriptFile()
  172. SetScriptFile(scriptFile);
  173. SetClassName(className);
  174. return scriptObject_ != 0;
  175. }
  176. void ScriptInstance::SetScriptFile(ScriptFile* scriptFile)
  177. {
  178. if (scriptFile == scriptFile_ && scriptObject_)
  179. return;
  180. ReleaseObject();
  181. // Unsubscribe from the reload event of previous script file (if any), then subscribe to the new
  182. if (scriptFile_)
  183. {
  184. UnsubscribeFromEvent(scriptFile_, E_RELOADSTARTED);
  185. UnsubscribeFromEvent(scriptFile_, E_RELOADFINISHED);
  186. }
  187. if (scriptFile)
  188. {
  189. SubscribeToEvent(scriptFile, E_RELOADSTARTED, HANDLER(ScriptInstance, HandleScriptFileReload));
  190. SubscribeToEvent(scriptFile, E_RELOADFINISHED, HANDLER(ScriptInstance, HandleScriptFileReloadFinished));
  191. }
  192. scriptFile_ = scriptFile;
  193. CreateObject();
  194. MarkNetworkUpdate();
  195. }
  196. void ScriptInstance::SetClassName(const String& className)
  197. {
  198. if (className == className_ && scriptObject_)
  199. return;
  200. ReleaseObject();
  201. className_ = className;
  202. CreateObject();
  203. MarkNetworkUpdate();
  204. }
  205. bool ScriptInstance::Execute(const String& declaration, const VariantVector& parameters)
  206. {
  207. if (!scriptObject_)
  208. return false;
  209. asIScriptFunction* method = scriptFile_->GetMethod(scriptObject_, declaration);
  210. return scriptFile_->Execute(scriptObject_, method, parameters);
  211. }
  212. bool ScriptInstance::Execute(asIScriptFunction* method, const VariantVector& parameters)
  213. {
  214. if (!method || !scriptObject_)
  215. return false;
  216. return scriptFile_->Execute(scriptObject_, method, parameters);
  217. }
  218. void ScriptInstance::DelayedExecute(float delay, bool repeat, const String& declaration, const VariantVector& parameters)
  219. {
  220. if (!scriptObject_)
  221. return;
  222. DelayedCall call;
  223. call.period_ = call.delay_ = Max(delay, 0.0f);
  224. call.repeat_ = repeat;
  225. call.declaration_ = declaration;
  226. call.parameters_ = parameters;
  227. delayedCalls_.Push(call);
  228. // Make sure we are registered to the scene update event, because delayed calls are executed there
  229. if (!subscribed_)
  230. UpdateEventSubscription();
  231. }
  232. void ScriptInstance::ClearDelayedExecute(const String& declaration)
  233. {
  234. if (declaration.Empty())
  235. delayedCalls_.Clear();
  236. else
  237. {
  238. for (Vector<DelayedCall>::Iterator i = delayedCalls_.Begin(); i != delayedCalls_.End();)
  239. {
  240. if (declaration == i->declaration_)
  241. i = delayedCalls_.Erase(i);
  242. else
  243. ++i;
  244. }
  245. }
  246. }
  247. void ScriptInstance::AddEventHandler(StringHash eventType, const String& handlerName)
  248. {
  249. if (!scriptObject_)
  250. return;
  251. String declaration = "void " + handlerName + "(StringHash, VariantMap&)";
  252. asIScriptFunction* method = scriptFile_->GetMethod(scriptObject_, declaration);
  253. if (!method)
  254. {
  255. declaration = "void " + handlerName + "()";
  256. method = scriptFile_->GetMethod(scriptObject_, declaration);
  257. if (!method)
  258. {
  259. LOGERROR("Event handler method " + handlerName + " not found in " + scriptFile_->GetName());
  260. return;
  261. }
  262. }
  263. SubscribeToEvent(eventType, HANDLER_USERDATA(ScriptInstance, HandleScriptEvent, (void*)method));
  264. }
  265. void ScriptInstance::AddEventHandler(Object* sender, StringHash eventType, const String& handlerName)
  266. {
  267. if (!scriptObject_)
  268. return;
  269. if (!sender)
  270. {
  271. LOGERROR("Null event sender for event " + String(eventType) + ", handler " + handlerName);
  272. return;
  273. }
  274. String declaration = "void " + handlerName + "(StringHash, VariantMap&)";
  275. asIScriptFunction* method = scriptFile_->GetMethod(scriptObject_, declaration);
  276. if (!method)
  277. {
  278. declaration = "void " + handlerName + "()";
  279. method = scriptFile_->GetMethod(scriptObject_, declaration);
  280. if (!method)
  281. {
  282. LOGERROR("Event handler method " + handlerName + " not found in " + scriptFile_->GetName());
  283. return;
  284. }
  285. }
  286. SubscribeToEvent(sender, eventType, HANDLER_USERDATA(ScriptInstance, HandleScriptEvent, (void*)method));
  287. }
  288. void ScriptInstance::RemoveEventHandler(StringHash eventType)
  289. {
  290. UnsubscribeFromEvent(eventType);
  291. }
  292. void ScriptInstance::RemoveEventHandler(Object* sender, StringHash eventType)
  293. {
  294. UnsubscribeFromEvent(sender, eventType);
  295. }
  296. void ScriptInstance::RemoveEventHandlers(Object* sender)
  297. {
  298. UnsubscribeFromEvents(sender);
  299. }
  300. void ScriptInstance::RemoveEventHandlers()
  301. {
  302. UnsubscribeFromAllEventsExcept(PODVector<StringHash>(), true);
  303. }
  304. void ScriptInstance::RemoveEventHandlersExcept(const PODVector<StringHash>& exceptions)
  305. {
  306. UnsubscribeFromAllEventsExcept(exceptions, true);
  307. }
  308. void ScriptInstance::SetScriptFileAttr(ResourceRef value)
  309. {
  310. ResourceCache* cache = GetSubsystem<ResourceCache>();
  311. SetScriptFile(cache->GetResource<ScriptFile>(value.name_));
  312. }
  313. void ScriptInstance::SetDelayedCallsAttr(PODVector<unsigned char> value)
  314. {
  315. MemoryBuffer buf(value);
  316. delayedCalls_.Resize(buf.ReadVLE());
  317. for (Vector<DelayedCall>::Iterator i = delayedCalls_.Begin(); i != delayedCalls_.End(); ++i)
  318. {
  319. i->period_ = buf.ReadFloat();
  320. i->delay_ = buf.ReadFloat();
  321. i->repeat_ = buf.ReadBool();
  322. i->declaration_ = buf.ReadString();
  323. i->parameters_ = buf.ReadVariantVector();
  324. }
  325. if (scriptObject_ && delayedCalls_.Size() && !subscribed_)
  326. UpdateEventSubscription();
  327. }
  328. void ScriptInstance::SetScriptDataAttr(PODVector<unsigned char> data)
  329. {
  330. if (scriptObject_ && methods_[METHOD_LOAD])
  331. {
  332. MemoryBuffer buf(data);
  333. VariantVector parameters;
  334. parameters.Push(Variant((void*)static_cast<Deserializer*>(&buf)));
  335. scriptFile_->Execute(scriptObject_, methods_[METHOD_LOAD], parameters);
  336. }
  337. }
  338. void ScriptInstance::SetScriptNetworkDataAttr(PODVector<unsigned char> data)
  339. {
  340. if (scriptObject_ && methods_[METHOD_READNETWORKUPDATE])
  341. {
  342. MemoryBuffer buf(data);
  343. VariantVector parameters;
  344. parameters.Push(Variant((void*)static_cast<Deserializer*>(&buf)));
  345. scriptFile_->Execute(scriptObject_, methods_[METHOD_READNETWORKUPDATE], parameters);
  346. }
  347. }
  348. ResourceRef ScriptInstance::GetScriptFileAttr() const
  349. {
  350. return GetResourceRef(scriptFile_, ScriptFile::GetTypeStatic());
  351. }
  352. PODVector<unsigned char> ScriptInstance::GetDelayedCallsAttr() const
  353. {
  354. VectorBuffer buf;
  355. buf.WriteVLE(delayedCalls_.Size());
  356. for (Vector<DelayedCall>::ConstIterator i = delayedCalls_.Begin(); i != delayedCalls_.End(); ++i)
  357. {
  358. buf.WriteFloat(i->period_);
  359. buf.WriteFloat(i->delay_);
  360. buf.WriteBool(i->repeat_);
  361. buf.WriteString(i->declaration_);
  362. buf.WriteVariantVector(i->parameters_);
  363. }
  364. return buf.GetBuffer();
  365. }
  366. PODVector<unsigned char> ScriptInstance::GetScriptDataAttr() const
  367. {
  368. if (!scriptObject_ || !methods_[METHOD_SAVE])
  369. return PODVector<unsigned char>();
  370. else
  371. {
  372. VectorBuffer buf;
  373. VariantVector parameters;
  374. parameters.Push(Variant((void*)static_cast<Serializer*>(&buf)));
  375. scriptFile_->Execute(scriptObject_, methods_[METHOD_SAVE], parameters);
  376. return buf.GetBuffer();
  377. }
  378. }
  379. PODVector<unsigned char> ScriptInstance::GetScriptNetworkDataAttr() const
  380. {
  381. if (!scriptObject_ || !methods_[METHOD_WRITENETWORKUPDATE])
  382. return PODVector<unsigned char>();
  383. else
  384. {
  385. VectorBuffer buf;
  386. VariantVector parameters;
  387. parameters.Push(Variant((void*)static_cast<Serializer*>(&buf)));
  388. scriptFile_->Execute(scriptObject_, methods_[METHOD_WRITENETWORKUPDATE], parameters);
  389. return buf.GetBuffer();
  390. }
  391. }
  392. void ScriptInstance::OnMarkedDirty(Node* node)
  393. {
  394. // Script functions are not safe from worker threads
  395. Scene* scene = GetScene();
  396. if (scene && scene->IsThreadedUpdate())
  397. {
  398. scene->DelayedMarkedDirty(this);
  399. return;
  400. }
  401. if (scriptObject_ && methods_[METHOD_TRANSFORMCHANGED])
  402. scriptFile_->Execute(scriptObject_, methods_[METHOD_TRANSFORMCHANGED]);
  403. }
  404. void ScriptInstance::CreateObject()
  405. {
  406. if (!scriptFile_ || className_.Empty())
  407. return;
  408. PROFILE(CreateScriptObject);
  409. scriptObject_ = scriptFile_->CreateObject(className_);
  410. if (scriptObject_)
  411. {
  412. // Map script object to script instance with userdata
  413. scriptObject_->SetUserData(this);
  414. GetScriptMethods();
  415. GetScriptAttributes();
  416. UpdateEventSubscription();
  417. if (methods_[METHOD_START])
  418. scriptFile_->Execute(scriptObject_, methods_[METHOD_START]);
  419. }
  420. else
  421. LOGERROR("Failed to create object of class " + className_ + " from " + scriptFile_->GetName());
  422. }
  423. void ScriptInstance::ReleaseObject()
  424. {
  425. if (scriptObject_)
  426. {
  427. if (methods_[METHOD_STOP])
  428. scriptFile_->Execute(scriptObject_, methods_[METHOD_STOP]);
  429. PODVector<StringHash> exceptions;
  430. exceptions.Push(E_RELOADSTARTED);
  431. exceptions.Push(E_RELOADFINISHED);
  432. UnsubscribeFromAllEventsExcept(exceptions, false);
  433. if (node_)
  434. node_->RemoveListener(this);
  435. subscribed_ = false;
  436. subscribedPostFixed_ = false;
  437. ClearScriptMethods();
  438. ClearScriptAttributes();
  439. scriptObject_->SetUserData(0);
  440. scriptObject_->Release();
  441. scriptObject_ = 0;
  442. }
  443. }
  444. void ScriptInstance::ClearScriptMethods()
  445. {
  446. for (unsigned i = 0; i < MAX_SCRIPT_METHODS; ++i)
  447. methods_[i] = 0;
  448. delayedCalls_.Clear();
  449. }
  450. void ScriptInstance::ClearScriptAttributes()
  451. {
  452. attributeInfos_ = *context_->GetAttributes(GetTypeStatic());
  453. idAttributes_.Clear();
  454. }
  455. void ScriptInstance::GetScriptMethods()
  456. {
  457. for (unsigned i = 0; i < MAX_SCRIPT_METHODS; ++i)
  458. methods_[i] = scriptFile_->GetMethod(scriptObject_, methodDeclarations[i]);
  459. }
  460. void ScriptInstance::GetScriptAttributes()
  461. {
  462. asIScriptEngine* engine = GetSubsystem<Script>()->GetScriptEngine();
  463. attributeInfos_ = *context_->GetAttributes(GetTypeStatic());
  464. unsigned numProperties = scriptObject_->GetPropertyCount();
  465. for (unsigned i = 0; i < numProperties; ++i)
  466. {
  467. const char* name;
  468. int typeId;
  469. bool isPrivate, isHandle;
  470. scriptObject_->GetObjectType()->GetProperty(i, &name, &typeId, &isPrivate);
  471. // Hide private variables or ones that begin with an underscore
  472. if (isPrivate || name[0] == '_')
  473. continue;
  474. String typeName = engine->GetTypeDeclaration(typeId);
  475. isHandle = typeName.EndsWith("@");
  476. if (isHandle)
  477. typeName = typeName.Substring(0, typeName.Length() - 1);
  478. AttributeInfo info;
  479. info.mode_ = AM_FILE;
  480. info.name_ = name;
  481. info.ptr_ = scriptObject_->GetAddressOfProperty(i);
  482. if (!isHandle)
  483. {
  484. switch (typeId)
  485. {
  486. case asTYPEID_BOOL:
  487. info.type_ = VAR_BOOL;
  488. break;
  489. case asTYPEID_INT32:
  490. case asTYPEID_UINT32:
  491. info.type_ = VAR_INT;
  492. break;
  493. case asTYPEID_FLOAT:
  494. info.type_ = VAR_FLOAT;
  495. break;
  496. default:
  497. info.type_ = Variant::GetTypeFromName(typeName);
  498. break;
  499. }
  500. }
  501. else
  502. {
  503. // For a handle type, check if it's an Object subclass with a registered factory
  504. StringHash typeHash(typeName);
  505. const HashMap<StringHash, SharedPtr<ObjectFactory> >& factories = context_->GetObjectFactories();
  506. HashMap<StringHash, SharedPtr<ObjectFactory> >::ConstIterator j = factories.Find(typeHash);
  507. if (j != factories.End())
  508. {
  509. // Check base class type. Node & Component are supported as ID attributes, Resource as a resource reference
  510. StringHash baseType = j->second_->GetBaseType();
  511. if (baseType == Node::GetTypeStatic())
  512. {
  513. info.mode_ |= AM_NODEID;
  514. info.type_ = VAR_INT;
  515. }
  516. else if (baseType == Component::GetTypeStatic())
  517. {
  518. info.mode_ |= AM_COMPONENTID;
  519. info.type_ = VAR_INT;
  520. }
  521. else if (baseType == Resource::GetTypeStatic())
  522. {
  523. info.type_ = VAR_RESOURCEREF;
  524. info.defaultValue_ = ResourceRef(typeHash);
  525. }
  526. }
  527. }
  528. if (info.type_ != VAR_NONE)
  529. attributeInfos_.Push(info);
  530. }
  531. }
  532. void ScriptInstance::UpdateEventSubscription()
  533. {
  534. Scene* scene = GetScene();
  535. if (!scene)
  536. {
  537. LOGWARNING("Node is detached from scene, can not subscribe script object to update events");
  538. return;
  539. }
  540. bool enabled = scriptObject_ && IsEnabledEffective();
  541. if (enabled)
  542. {
  543. if (!subscribed_ && (methods_[METHOD_UPDATE] || methods_[METHOD_DELAYEDSTART] || delayedCalls_.Size()))
  544. {
  545. SubscribeToEvent(scene, E_SCENEUPDATE, HANDLER(ScriptInstance, HandleSceneUpdate));
  546. subscribed_ = true;
  547. }
  548. if (!subscribedPostFixed_)
  549. {
  550. if (methods_[METHOD_POSTUPDATE])
  551. SubscribeToEvent(scene, E_SCENEPOSTUPDATE, HANDLER(ScriptInstance, HandleScenePostUpdate));
  552. if (methods_[METHOD_FIXEDUPDATE] || methods_[METHOD_FIXEDPOSTUPDATE])
  553. {
  554. PhysicsWorld* world = scene->GetOrCreateComponent<PhysicsWorld>();
  555. if (world)
  556. {
  557. if (methods_[METHOD_FIXEDUPDATE])
  558. SubscribeToEvent(world, E_PHYSICSPRESTEP, HANDLER(ScriptInstance, HandlePhysicsPreStep));
  559. if (methods_[METHOD_FIXEDPOSTUPDATE])
  560. SubscribeToEvent(world, E_PHYSICSPOSTSTEP, HANDLER(ScriptInstance, HandlePhysicsPostStep));
  561. }
  562. else
  563. LOGERROR("No physics world, can not subscribe script object to fixed update events");
  564. }
  565. subscribedPostFixed_ = true;
  566. }
  567. if (methods_[METHOD_TRANSFORMCHANGED])
  568. node_->AddListener(this);
  569. }
  570. else
  571. {
  572. if (subscribed_)
  573. {
  574. UnsubscribeFromEvent(scene, E_SCENEUPDATE);
  575. subscribed_ = false;
  576. }
  577. if (subscribedPostFixed_)
  578. {
  579. UnsubscribeFromEvent(scene, E_SCENEPOSTUPDATE);
  580. PhysicsWorld* world = scene->GetComponent<PhysicsWorld>();
  581. if (world)
  582. {
  583. UnsubscribeFromEvent(world, E_PHYSICSPRESTEP);
  584. UnsubscribeFromEvent(world, E_PHYSICSPOSTSTEP);
  585. }
  586. subscribedPostFixed_ = false;
  587. }
  588. if (methods_[METHOD_TRANSFORMCHANGED])
  589. node_->RemoveListener(this);
  590. }
  591. }
  592. void ScriptInstance::HandleSceneUpdate(StringHash eventType, VariantMap& eventData)
  593. {
  594. if (!scriptObject_)
  595. return;
  596. using namespace SceneUpdate;
  597. float timeStep = eventData[P_TIMESTEP].GetFloat();
  598. // Execute delayed calls
  599. for (unsigned i = 0; i < delayedCalls_.Size();)
  600. {
  601. DelayedCall& call = delayedCalls_[i];
  602. bool remove = false;
  603. call.delay_ -= timeStep;
  604. if (call.delay_ <= 0.0f)
  605. {
  606. if (!call.repeat_)
  607. remove = true;
  608. else
  609. call.delay_ += call.period_;
  610. Execute(call.declaration_, call.parameters_);
  611. }
  612. if (remove)
  613. delayedCalls_.Erase(i);
  614. else
  615. ++i;
  616. }
  617. // Execute delayed start before first update
  618. if (methods_[METHOD_DELAYEDSTART])
  619. {
  620. scriptFile_->Execute(scriptObject_, methods_[METHOD_DELAYEDSTART]);
  621. methods_[METHOD_DELAYEDSTART] = 0; // Only execute once
  622. }
  623. if (methods_[METHOD_UPDATE])
  624. {
  625. VariantVector parameters;
  626. parameters.Push(timeStep);
  627. scriptFile_->Execute(scriptObject_, methods_[METHOD_UPDATE], parameters);
  628. }
  629. }
  630. void ScriptInstance::HandleScenePostUpdate(StringHash eventType, VariantMap& eventData)
  631. {
  632. if (!scriptObject_)
  633. return;
  634. using namespace ScenePostUpdate;
  635. VariantVector parameters;
  636. parameters.Push(eventData[P_TIMESTEP]);
  637. scriptFile_->Execute(scriptObject_, methods_[METHOD_POSTUPDATE], parameters);
  638. }
  639. void ScriptInstance::HandlePhysicsPreStep(StringHash eventType, VariantMap& eventData)
  640. {
  641. if (!scriptObject_)
  642. return;
  643. using namespace PhysicsPreStep;
  644. VariantVector parameters;
  645. parameters.Push(eventData[P_TIMESTEP]);
  646. scriptFile_->Execute(scriptObject_, methods_[METHOD_FIXEDUPDATE], parameters);
  647. }
  648. void ScriptInstance::HandlePhysicsPostStep(StringHash eventType, VariantMap& eventData)
  649. {
  650. if (!scriptObject_)
  651. return;
  652. using namespace PhysicsPostStep;
  653. VariantVector parameters;
  654. parameters.Push(eventData[P_TIMESTEP]);
  655. scriptFile_->Execute(scriptObject_, methods_[METHOD_FIXEDPOSTUPDATE], parameters);
  656. }
  657. void ScriptInstance::HandleScriptEvent(StringHash eventType, VariantMap& eventData)
  658. {
  659. if (!IsEnabledEffective() || !scriptFile_ || !scriptObject_)
  660. return;
  661. asIScriptFunction* method = static_cast<asIScriptFunction*>(GetEventHandler()->GetUserData());
  662. VariantVector parameters;
  663. if (method->GetParamCount() > 0)
  664. {
  665. parameters.Push(Variant((void*)&eventType));
  666. parameters.Push(Variant((void*)&eventData));
  667. }
  668. scriptFile_->Execute(scriptObject_, method, parameters);
  669. }
  670. void ScriptInstance::HandleScriptFileReload(StringHash eventType, VariantMap& eventData)
  671. {
  672. ReleaseObject();
  673. }
  674. void ScriptInstance::HandleScriptFileReloadFinished(StringHash eventType, VariantMap& eventData)
  675. {
  676. if (!className_.Empty())
  677. CreateObject();
  678. }
  679. Context* GetScriptContext()
  680. {
  681. return static_cast<Script*>(asGetActiveContext()->GetEngine()->GetUserData())->GetContext();
  682. }
  683. ScriptInstance* GetScriptContextInstance()
  684. {
  685. asIScriptContext* context = asGetActiveContext();
  686. asIScriptObject* object = context ? static_cast<asIScriptObject*>(context->GetThisPointer()) : 0;
  687. if (object)
  688. return static_cast<ScriptInstance*>(object->GetUserData());
  689. else
  690. return 0;
  691. }
  692. Node* GetScriptContextNode()
  693. {
  694. ScriptInstance* instance = GetScriptContextInstance();
  695. return instance ? instance->GetNode() : 0;
  696. }
  697. Scene* GetScriptContextScene()
  698. {
  699. Scene* scene = 0;
  700. Node* node = GetScriptContextNode();
  701. if (node)
  702. scene = node->GetScene();
  703. // If null, try to get the default scene
  704. if (!scene)
  705. scene = GetScriptContext()->GetSubsystem<Script>()->GetDefaultScene();
  706. return scene;
  707. }
  708. ScriptEventListener* GetScriptContextEventListener()
  709. {
  710. // If the context has an object and that object has user data set, try and get the ScriptInstance, otherwise try and get a ScriptFile.
  711. asIScriptContext* context = asGetActiveContext();
  712. if (context)
  713. {
  714. asIScriptObject* object = static_cast<asIScriptObject*>(context->GetThisPointer());
  715. if (object && object->GetUserData())
  716. return GetScriptContextInstance();
  717. else
  718. return GetScriptContextFile();
  719. }
  720. else
  721. return 0;
  722. }
  723. Object* GetScriptContextEventListenerObject()
  724. {
  725. return dynamic_cast<Object*>(GetScriptContextEventListener());
  726. }
  727. }